elements_rest_api

Elements REST API

This module holds the documentation for the entire REST API.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

Back To Top

elements_adjust_advanced_inventory_item_quantity

Adjust the quantity of the first (primary) inventory item for the specified item. This implicitly will create the InventoryItem if it does not exist. The inventory item value

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_adjust_advanced_inventory_item_quantity(_inventory_item_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_body	ElementsAdvancedInventoryItemQuantityAdjustment	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_adjust_simple_inventory_item_quantity

Adjust the quantity of the first (primary) inventory item for the specified item. This implicitly will create the InventoryItem if it does not exist. The inventory item value

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_adjust_simple_inventory_item_quantity(_inventory_item_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_body	ElementsSimpleInventoryItemQuantityAdjustment	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_blacklist_session

Destroys the Session

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_blacklist_session(_session_secret, _callback=undefined)

Argument	Type	Description
_session_secret	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_build_indexes

Builds all indexes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_build_indexes(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsBuildIndexRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_callback

Not called by game clients. The provider redirects the system browser here after the user completes (or denies) authorization.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_callback(_provider, _code=undefined, _state=undefined, _error=undefined, _callback=undefined)

Argument	Type	Description
_provider	String
_code	String
_state	String
_error	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_complete_reset

Validates the reset token and sets the new password. All existing sessions are invalidated. Returns 400 if the token is invalid or expired.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_complete_reset(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCompletePasswordResetRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_complete_verification

Completes email verification by consuming the single-use token from a verification link. Moves the associated UID status to VERIFIED.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_complete_verification(_token=undefined, _callback=undefined)

Argument	Type	Description
_token	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUserUid or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_consume_oculus_iap_purchase

Attempts to consume the Oculus IAP Receipt data. Returns the result of the consume action.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_consume_oculus_iap_purchase(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOculusIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusIapConsumeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_advanced_inventory_item

Create an inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_advanced_inventory_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateAdvancedInventoryItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_application

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_application(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateApplicationRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsApplication or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_custom_auth_scheme

Creates a new Auth Scheme, from the data in the given auth scheme request

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_custom_auth_scheme(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateAuthSchemeRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateAuthSchemeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_distinct_inventory_item

Create an inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_distinct_inventory_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateDistinctInventoryItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDistinctInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_element_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_element_deployment(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateElementDeploymentRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsElementDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_facebook_application_configuration

Creates a new Facebook ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_facebook_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsFacebookApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFacebookApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_facebook_iap_receipt

Attempts to create the Facebook IAP Receipt data.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_facebook_iap_receipt(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsFacebookIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFacebookIapReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_fcm_registration

Supplying FCM registration token, this will create a new token based on the information supplied to the endpoint. The response will contain the token as it was written to the database. Clients may subsequently update the token string with new values as they are issued by Firebase.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_fcm_registration(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsFCMRegistration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFCMRegistration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_firebase_application_configuration

Creates a new Firebase ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_firebase_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsFirebaseApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFirebaseApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_follower

Supplying the follower object, this will store the information supplied in the body of the request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_follower(_profile_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_profile_id	String
_body	ElementsCreateFollowerRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_create_google_play_application_configuration

Creates a new GooglePlay ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_google_play_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsGooglePlayApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsGooglePlayApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_ios_application_configuration

Creates a new iOS ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_ios_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsIosApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsIosApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_item

Supplying an item object, this will create a new item with a newly assigned unique id. The Item representation returned in the response body is a representation of the Item as persisted with a unique identifier signed and with its fields properly normalized. The supplied item object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_large_object

Creates a LargeObject

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_large_object(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateLargeObjectRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_large_object_from_url

Creates a LargeObject from provided URL

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_large_object_from_url(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateLargeObjectFromUrlRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_leaderboard

Gets the metadata for a single leaderboard. This may include more specific details not available in the bulk-get or fetch operation.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_leaderboard(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateLeaderboardRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLeaderboard or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_match

This method accepts an instance of MultiMatch and creates a new DB entry for it. Though it is generally recommended to create a new MultiMatch via matchmaking code in an Element, it can be created via REST for the purposes of testing or custom workflows.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_match(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMultiMatch	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMultiMatch or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_matchmaking_application_configuration

Creates a new iOS ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_matchmaking_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsMatchmakingApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMatchmakingApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_metadata

Creates a new Metadata object with the provided details.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_metadata(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMetadataRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_metadata_spec

Creates a new Metadata Spec definition.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_metadata_spec(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMetadataSpecRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadataSpec or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_mission

Supplying a mission object, this will create a new mission with a newly assigned unique id. The Mission representation returned in the response body is a representation of the Mission as persisted with a unique identifier assigned and with its fields properly normalized. The supplied mission object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_mission(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMissionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMission or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_mock_session

Begins a session by accepting a mock session request. The request must be made with an authenticated super-user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_mock_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMockSessionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMockSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_multipart_large_object

Creates a LargeObject with content

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_multipart_large_object(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMultipartLargeObjectBody	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_new_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_new_deployment(_application_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_id	String
_body	ElementsCreateDeploymentRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oauth2_auth_scheme

Creates a new Auth Scheme, from the data in the given auth scheme request

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oauth2_auth_scheme(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateOrUpdateOAuth2AuthSchemeRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateOrUpdateOAuth2AuthSchemeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oauth2_session

Begins a session by accepting a session request with parameters matching the specified OAuth2 Scheme. Upon successful validation against the scheme provided in the path, this will return a Session which can be used for authentication. If there is no User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link to the existing scheme if the account was not previously linked.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oauth2_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOAuth2SessionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oculus_application_configuration

Creates a new Oculus ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oculus_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsOculusApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oculus_iap_receipt

Attempts to create the Oculus IAP Receipt data.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oculus_iap_receipt(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOculusIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusIapReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oidc_auth_scheme

Creates a new Auth Scheme, from the data in the given auth scheme request

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oidc_auth_scheme(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateOrUpdateOidcAuthSchemeRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateOrUpdateOidcAuthSchemeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oidc_session

Begins a session by accepting a JWT. Upon successful validation against the scheme provided in the path, this will return a Session which can be used for authentication. If there is no User associated with the supplied credentials, this will implicitly create a new account and will include that account information in the response. If there is an account, or this method receives an existing session key, this will link to the existing scheme if the account was not previously linked.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oidc_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOidcSessionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_oidc_session_1

Supplying only 'provider' starts a pending browser-redirect login attempt and returns an id plus the authorize URL to open in the system browser. Additionally supplying 'idToken' instead validates it directly and returns a completed session synchronously, sharing validation code with the callback path.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_oidc_session_1(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOidcLoginAttemptRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_create_product_bundle

Creates a new Product Bundle mapping an application + provider schema + productId to a set of rewards.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_product_bundle(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsProductBundle	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_create_product_sku_schema

Registers a payment-provider schema identifier. Returns an existing record if the schema value already exists.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_product_sku_schema(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsProductSkuSchema	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_create_profile

Supplying the create profile request, this will update the profile with the new information supplied in the body of the request. This will fire an event, dev.getelements.elements.service.profile.created, from the event manifest.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_profile(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateProfileRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_progress

This will create a new progress with a compound id of the profile and mission. The Progress representation returned in the response body is a representation of the Progress as persisted with a unique identifier assigned and with its fields properly normalized.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_progress(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateProgressRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProgress or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_provider_configuration

Requires SUPERUSER access. Resolves the discovery document at the supplied discoveryUrl and auto-provisions the matching OIDC auth scheme by issuer, so a single request fully activates a new provider (e.g. Twitch) with no code changes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_provider_configuration(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateOrUpdateOidcProviderConfigurationRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateOrUpdateOidcProviderConfigurationResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_psn_application_configuration

Creates a new PSN ApplicationConfiguration with the specific ID or application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_psn_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsPSNApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPSNApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_receipt

Creates a new Receipt record.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_receipt(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateReceiptRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_save_document

Gets a single save data document.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_save_document(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSaveDataDocumentRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_schedule

Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The Schedule representation returned in the response body is a representation of the Schedule as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_schedule(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateScheduleRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSchedule or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_schedule_event

Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The ScheduleEvent representation returned in the response body is a representation of the ScheduleEvent as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_schedule_event(_schedule_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_body	ElementsCreateScheduleEventRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsScheduleEvent or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_score

Posts a single score for the currently logged-in profile. Conceptually, this is creationg a new resource, however the server may opt to overwrite the existing identifier if it sees fit.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_score(_leaderboard_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_leaderboard_name_or_id	String	The name or id of the leaderboard.
_body	ElementsScore	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsScore or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_simple_inventory_item

Create an inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_simple_inventory_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSimpleInventoryItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_smart_contract

Patches a Smart Contract entry, associated with the specified deployed script hash.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_smart_contract(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSmartContractRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSmartContract or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_steam_application_configuration

Creates a new Steam ApplicationConfiguration for the specified application.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_steam_application_configuration(_application_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_body	ElementsSteamApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSteamApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_user

Supplying the user object, this will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_user(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUserCreateRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUserCreateResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_username_password_session

Begins a session by accepting both the UserID and the Password. Upon successful completion of this call, the user will be added to the current HTTP session. If the session expires, the user will have to reestablish the session by supplying credentials again. This is most useful for applications delivered in a web page.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_username_password_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUsernamePasswordSessionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_vault

Creates a new Vault, associated with the given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_vault(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateVaultRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsVault or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_create_wallet

Creates a new Wallet, associated with the given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_create_wallet(_vault_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_vault_id	String
_body	ElementsCreateWalletRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsWallet or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_deactivate_profile

Deletes and permanently removes the Profile from the server. The server maykeep some record around to preserve relationships and references, but this profile will not be accessible again until it is recreated.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_deactivate_profile(_profile_id, _callback=undefined)

Argument	Type	Description
_profile_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_deactivate_user

Deletes and permanently removes the user from the server. The server may keep some metadata as necessary to avoid data inconsistency. However, the user has been deleted from the client standpoint and will not be accessible through any of the existing APIs.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_deactivate_user(_name, _callback=undefined)

Argument	Type	Description
_name	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_advanced_inventory_item

Delete the inventory item as identified by the given item name/id

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_advanced_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_all_matches

Deletes and permanently removes all MultiMatches from he server. This effectively will cancel any pending request for a match. If a game is currently being played against the match, the server may reject the request to delete the match until the game concludes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_all_matches(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_application

Deletes a specific application known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_application(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_contract

Deletes a Smart Contract with the specified contractId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_contract(_contract_id, _callback=undefined)

Argument	Type	Description
_contract_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_custom_auth_scheme

Deletes an Auth Scheme with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_custom_auth_scheme(_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_auth_scheme_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_deployment(_application_id, _deployment_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_deployment_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_distinct_inventory_item

Delete the inventory item as identified by the given item name/id

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_distinct_inventory_item(_distinct_inventory_item_id, _callback=undefined)

Argument	Type	Description
_distinct_inventory_item_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_element_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_element_deployment(_deployment_id, _callback=undefined)

Argument	Type	Description
_deployment_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_facebook_application_configuration

Deletes an existing Facebook Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_facebook_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_fcm_registration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_fcm_registration(_fcm_registration_id, _callback=undefined)

Argument	Type	Description
_fcm_registration_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_firebase_application_configuration

Deletes an existing Firebase Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_firebase_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_follower

Deletes a Follower relationship

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_follower(_profile_id, _profile_to_unfollow_id, _callback=undefined)

Argument	Type	Description
_profile_id	String
_profile_to_unfollow_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_friend_registration

Once a friend is deleted, re-creating a friend will set the friendship status to outgoing.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_friend_registration(_friend_id, _callback=undefined)

Argument	Type	Description
_friend_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_google_play_application_configuration

Deletes an existing Google Play Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_google_play_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_ios_application_configuration

Deletes an existing iOS Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_ios_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_item

Delete the item as identified by the given item name/id

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_item(_identifier, _callback=undefined)

Argument	Type	Description
_identifier	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_large_object

Deletes a LargeObject

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_large_object(_large_object_id, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_leaderboard

Deletes a specific leaderboard known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_leaderboard(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_match

Deletes and permanently removes the MultiMatch from he server. This effectively will cancel any pending request for a match. If a game is currently being played against the match, the server may reject the request to delete the match until the game concludes.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_match(_match_id, _callback=undefined)

Argument	Type	Description
_match_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_matchmaking_application_configuration

Deletes an existing iOS Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_matchmaking_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_metadata

Deletes a specific metadata object by name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_metadata(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_metadata_spec

Deletes a MetadataSpec with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_metadata_spec(_metadata_spec_id, _callback=undefined)

Argument	Type	Description
_metadata_spec_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_mission

Deletes a mission by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_mission(_mission_name_or_id, _callback=undefined)

Argument	Type	Description
_mission_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_oauth2_auth_scheme

Deletes an Auth Scheme with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_oauth2_auth_scheme(_oauth2_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oauth2_auth_scheme_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_oculus_application_configuration

Deletes an existing Oculus Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_oculus_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_oidc_auth_scheme

Deletes an Auth Scheme with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_oidc_auth_scheme(_oidc_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oidc_auth_scheme_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_product_bundle

Permanently removes the Product Bundle identified by the given database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_product_bundle(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_product_sku_schema

Permanently removes the schema identifier with the given database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_product_sku_schema(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_progress

Deletes a progress by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_progress(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_provider_configuration

Deletes an OIDC provider configuration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_provider_configuration(_provider_configuration_id, _callback=undefined)

Argument	Type	Description
_provider_configuration_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_psn_application_configuration

Deletes an existing PSN Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_psn_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_receipt

Deletes and permanently removes the Receipt from the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_receipt(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_save_document

Deletes a save data document

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_save_document(_save_data_document_id, _callback=undefined)

Argument	Type	Description
_save_data_document_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_schedule

Deletes a schedule by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_schedule(_schedule_name_or_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_schedule_event

Deletes a schedule by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_schedule_event(_schedule_name_or_id, _schedule_event_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_schedule_event_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_simple_inventory_item

Delete the inventory item as identified by the given item name/id

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_simple_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_steam_application_configuration

Deletes an existing Steam application configuration if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_steam_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_vault

Deletes a Vault with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_vault(_vault_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_delete_wallet

Deletes a Wallet with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_delete_wallet(_vault_id, _wallet_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_wallet_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_generate_code

Generates API code for use on the client. Will generate Elements core if no application is specified in the request body.The generated code will always be returned in JSON format. To get a YAML representation, use the Oas3DocumentationResource directly, such as /api/rest/openapi.yaml

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_generate_code(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCodegenRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_get_advanced_inventory_item

Gets the first (primary) inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_advanced_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_advanced_inventory_items

Searches all inventory items in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_advanced_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_user_id	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_all_builtin_spis

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_all_builtin_spis(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementSpi or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_all_containers

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_all_containers(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementContainerStatus or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_all_features

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_all_features(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementFeature or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_all_runtimes

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_all_runtimes(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementRuntimeStatus or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_all_system_elements

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_all_system_elements(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_application

Gets the metadata for a single application. This may include more specific details not available in the bulk-get or fetch operation.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_application(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsApplication or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_application_profiles

Searches all instances of ApplicationProfiles associated with the application. The search query may be a full text search.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_application_profiles(_application_name_or_id, _offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_applications

Performs a full-text search of all applications known to the server. As with other full-text endpoints this allows for pagination and offset.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_applications(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationApplication or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_current_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_current_deployment(_application_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_current_profile

This is a special endpoing which fetches the current Profile based on current auth credentials. This considers the currently loggged-in Dser as well as the Application or Application Configuration against which the User is operating. This may not be availble, in which case the appopraite error is rasied.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_current_profile(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_current_user

A special endpoint used to get the current user for the request. The current user is typically associated with the session but may be derived any other way. This is essentially an alias for using GET /user/myUserId

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_current_user(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUser or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_custom_auth_scheme

Gets a specific Auth Scheme by the authSchemeId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_custom_auth_scheme(_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_auth_scheme_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsAuthScheme or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_custom_auth_schemes

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_custom_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationAuthScheme or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_deployment(_application_id, _deployment_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_deployment_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_deployments

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_deployments(_application_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_distinct_inventory_item

Gets the first (primary) inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_distinct_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDistinctInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_distinct_inventory_items

Searches all inventory items in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_distinct_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _profile_id=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_user_id	String
_profile_id	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationDistinctInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_editor_schema

Gets a specific Metadata Editor Schema backed by the supplied MetadataSpec by name.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_editor_schema(_metadata_spec_name, _callback=undefined)

Argument	Type	Description
_metadata_spec_name	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsEditorSchema or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_element_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_element_deployment(_deployment_id, _callback=undefined)

Argument	Type	Description
_deployment_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsElementDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_element_deployments

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_element_deployments(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationElementDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_element_path_record_for_artifact

Inspects the artifact with the supplied coordinates.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_element_path_record_for_artifact(_coordinates, _callback=undefined)

Argument	Type	Description
_coordinates	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementPathRecordMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_element_path_record_for_large_object_id

Inspects the artifact with the supplied large object id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_element_path_record_for_large_object_id(_large_object_id, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementPathRecordMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_facebook_application_configuration

Gets a single Facebook application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_facebook_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFacebookApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_facebook_iap_receipt

Fetches the facebook iap receipt with the matching database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_facebook_iap_receipt(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFacebookIapReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_facebook_iap_receipts

Fetches the facebook iap receipt with the matching database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_facebook_iap_receipts(_offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationFacebookIapReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_firebase_application_configuration

Gets a single Firebase application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_firebase_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFirebaseApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_followees

Searches for all profiles that are being followed by the given profile id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_followees(_profile_id, _offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_profile_id	String
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_follower

Gets a specific profile using the ID of the profile and followed id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_follower(_profile_id, _followed_id, _callback=undefined)

Argument	Type	Description
_profile_id	String
_followed_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_followers

Searches all followers in the system and returning the metadata for all matches against the given profile id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_followers(_profile_id, _offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_profile_id	String
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_friend

Gets a specific friend using the ID of the friend.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_friend(_friend_id, _callback=undefined)

Argument	Type	Description
_friend_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFriend or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_friends

Searches all friends in the system and returning the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_friends(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationFriend or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_global_rank_tabular

Gets the current Profile's rank among all players for the particular leaderboard.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_global_rank_tabular(_leaderboard_name_or_id, _leaderboard_epoch=undefined, _callback=undefined)

Argument	Type	Description
_leaderboard_name_or_id	String	Specifies the leaderboard name or ID.
_leaderboard_epoch	Real	Specifies the epoch for the leaderboard. If not provided, the current epoch will be used by default for epochal leaderboards. This value will be ignored for all-time leaderboards. Set this value to 0 to explicitly reference the current epoch (when applicable).
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_get_google_play_application_configuration

Gets a single Google Play application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_google_play_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsGooglePlayApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_ios_application_configuration

Gets a single iOS application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_ios_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsIosApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_item_by_identifier

Looks up an item by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_item_by_identifier(_identifier, _callback=undefined)

Argument	Type	Description
_identifier	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_items

Searches all items and returns all matching items, filtered by the passed in search parameters. If multiple tags are specified, then all items that contain at least one of the passed in tags is returned.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_items(_offset=undefined, _count=undefined, _tags=undefined, _category=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_category	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_json_schema

Gets a specific JSON Schema backed by the supplied MetadataSpec by name.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_json_schema(_metadata_spec_name, _callback=undefined)

Argument	Type	Description
_metadata_spec_name	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsJsonSchema or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_large_object

Get a LargeObject

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_large_object(_large_object_id, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_large_objects

Get a LargeObject

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_large_objects(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_leaderboard

Gets the metadata for a single leaderboard. This may include more specific details not availble in the bulk-get or fetch operation.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_leaderboard(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLeaderboard or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_leaderboards

Performs a full-text search of all leaderboards known to the server. As with other full-text endpoints this allows for pagination and offset.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_leaderboards(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationLeaderboard or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_ledger_entries

Returns paginated ledger entries for a specific inventory item or user, sorted most-recent first. Exactly one of inventoryItemId or userId must be supplied. All other parameters are optional filters.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_ledger_entries(_inventory_item_id=undefined, _user_id=undefined, _event_type=undefined, _from=undefined, _to=undefined, _offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String	Filter entries for a specific inventory item ID.
_user_id	String	Filter entries for a specific user ID (across all their inventory items).
_event_type	String	Optional event type filter. When omitted, all event types are returned.
_from	Real	Optional inclusive lower bound as epoch milliseconds. When omitted, no lower bound is applied.
_to	Real	Optional inclusive upper bound as epoch milliseconds. When omitted, no upper bound is applied.
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationItemLedgerEntry or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_match

Gets a specific match given the match's unique ID. Additionally, it is possible to instruct the API to wait for a period of time before sending the response. The request will intentionally hang until the requested MultiMatch with ID has been updated in the database.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_match(_match_id, _callback=undefined)

Argument	Type	Description
_match_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMultiMatch or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_matched_user_profiles_with_phone_numbers

Both phones from request and from DB are normalized and compared.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_matched_user_profiles_with_phone_numbers(_offset=undefined, _count=undefined, _body=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_body	ElementsInviteViaPhonesRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInviteViaPhonesResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_matches

Lists all matches available. Under most circumstances, this will requires that a profile be made available to the request. The server may choose to return an error if no suitable profile can be determined.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_matches(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMultiMatch or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_matchmaking_application_configuration

Gets a single iOS application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_matchmaking_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMatchmakingApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_metadata_object

Gets a specific metadata object by name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_metadata_object(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_metadata_objects

Searches all metadata in the system and returning all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_metadata_objects(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_metadata_spec

Gets a specific MetadataSpec by name or Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_metadata_spec(_metadata_spec_name_or_id, _callback=undefined)

Argument	Type	Description
_metadata_spec_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadataSpec or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_metadata_specs

Gets a pagination of Metadata Specs for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_metadata_specs(_offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMetadataSpec or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_mission_by_name_or_id

Looks up a mission by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_mission_by_name_or_id(_mission_name_or_id, _callback=undefined)

Argument	Type	Description
_mission_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMission or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_missions

Searches all missions in the system and returning a number of matches against the given search filter, delimited by the offset and count.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_missions(_offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationMission or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oauth2_auth_scheme

Gets a specific Auth Scheme by the oAuth2AuthSchemeId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oauth2_auth_scheme(_oauth2_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oauth2_auth_scheme_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOAuth2AuthScheme or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oauth2_auth_schemes

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oauth2_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationOAuth2AuthScheme or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oculus_application_configuration

Gets a single Oculus application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oculus_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oculus_iap_receipt

Fetches the oculus iap receipt with the matching database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oculus_iap_receipt(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusIapReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oculus_iap_receipts

Fetches the oculus iap receipt with the matching database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oculus_iap_receipts(_offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationOculusIapReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oidc_auth_scheme

Gets a specific Auth Scheme by the oidcAuthSchemeId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oidc_auth_scheme(_oidc_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oidc_auth_scheme_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOidcAuthScheme or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_oidc_auth_schemes

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_oidc_auth_schemes(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationOidcAuthScheme or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_plans

Gets all index plans.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_plans(_offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationIndexPlanObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_product_bundle

Returns the Product Bundle identified by the given database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_product_bundle(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProductBundle or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_product_bundle_by_key

Returns the Product Bundle matching the given application, provider schema and product id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_product_bundle_by_key(_application_name_or_id, _schema, _product_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_schema	String
_product_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProductBundle or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_product_bundles

Returns all Product Bundles, optionally filtered by application and/or schema.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_product_bundles(_application_name_or_id=undefined, _schema=undefined, _product_id=undefined, _tag=undefined, _offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_schema	String
_product_id	String
_tag	Array of String
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProductBundle or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_product_sku_schema

Returns the schema identifier with the given database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_product_sku_schema(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProductSkuSchema or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_product_sku_schemas

Returns all registered payment-provider schema identifiers.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_product_sku_schemas(_offset=undefined, _count=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProductSkuSchema or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_profile

Gets a specific profile by profile ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_profile(_name, _callback=undefined)

Argument	Type	Description
_name	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_profile_save_data_document_by_slot

Gets a single save data document based on Profile ID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an profile id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_profile_save_data_document_by_slot(_profile_id, _slot, _callback=undefined)

Argument	Type	Description
_profile_id	String
_slot	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_profiles

Searches all users in the system and returning the metadata for all matches against the given search filter. Optionally provide before and after params to specify a time range [after, before] for last-logged-in profiles matching in that range (inclusive). If before is not specified (or a negative number is provided) but after is valid, the query will return all records successive to the given after timestamp. Similarly, if after is not specified (or a negative number is provided) but before is valid, the query will return all records preceding the given before timestamp. Note that search and time range parameters currently cannot be combined in the same query.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_profiles(_offset=undefined, _count=undefined, _before=undefined, _after=undefined, _application=undefined, _user=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_before	Real
_after	Real
_application	String
_user	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_progress_by_name_or_id

Looks up a progress by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_progress_by_name_or_id(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProgress or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_progress_tabular

Gets the current Profile's rank among all players for the particular leaderboard.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_progress_tabular(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_get_provider_configuration

Gets a specific OIDC provider configuration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_provider_configuration(_provider_configuration_id, _callback=undefined)

Argument	Type	Description
_provider_configuration_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOidcProviderConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_provider_configurations

Requires SUPERUSER access. Gets a pagination of OIDC provider configurations.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_provider_configurations(_offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationOidcProviderConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_psn_application_configuration

Gets a single PSN application based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_psn_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPSNApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_rank_among_friends

Gets the current Profile's rank among friends for the particular leaderboard.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_rank_among_friends(_leaderboard_name_or_id, _offset=undefined, _count=undefined, _relative=undefined, _leaderboard_epoch=undefined, _callback=undefined)

Argument	Type	Description
_leaderboard_name_or_id	String	Specifies the leaderboard name or ID.
_offset	Real	May be negative to place the requested player in the middle of the page.
_count	Real	The number of results to return in the page.
_relative	Boolean	Indicates whether or not to fetch results in a relative fashion.
_leaderboard_epoch	Real	Specifies the epoch for the leaderboard. If no value is provided, the current epoch will befetched.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationRank or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_rank_among_mutual_followers

Gets the current Profile's rank among mutual followers for the particular leaderboard.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_rank_among_mutual_followers(_leaderboard_name_or_id, _offset=undefined, _count=undefined, _relative=undefined, _leaderboard_epoch=undefined, _callback=undefined)

Argument	Type	Description
_leaderboard_name_or_id	String	Specifies the leaderboard name or ID.
_offset	Real	May be negative to place the requested player in the middle of the page.
_count	Real	The number of results to return in the page.
_relative	Boolean	Indicates whether or not to fetch results in a relative fashion.
_leaderboard_epoch	Real	Specifies the epoch for the leaderboard. If no value is provided, the current epoch will befetched.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationRank or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_receipt

Gets a Receipt using the database id provided in the URL path.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_receipt(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_receipts

Retrieves a pagination of Receipt objects for the given user (SUPERUSER level), or the current user (USER level).Can search by originalTransactionId or scheme.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_receipts(_user_id=undefined, _offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_user_id	String
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationReceipt or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_reward_issuance

Retrieves a single RewardIssuance by id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_reward_issuance(_reward_issuance_id, _callback=undefined)

Argument	Type	Description
_reward_issuance_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_reward_issuances

Retrieves the current user's reward issuances, optionally filtered by the given state.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_reward_issuances(_offset=undefined, _count=undefined, _states=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_states	Array of String
_tags	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_reward_issuances_for_oculus_iap_receipt

Attempts to verify the Oculus IAP Receipt data.Returns a list of RewardIssuances, some or all of which may be already redeemed.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_reward_issuances_for_oculus_iap_receipt(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOculusIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_save_data_document

Gets a single save data document

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_save_data_document(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_save_data_documents

Gets all save data documents available to the user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_save_data_documents(_offset=undefined, _count=undefined, _user_id=undefined, _profile_id=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_user_id	String
_profile_id	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationSaveDataDocument or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_schedule_by_name_or_id

Looks up a schedule by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_schedule_by_name_or_id(_schedule_name_or_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSchedule or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_schedule_event_by_name_or_id

Looks up a schedule by the passed in identifier

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_schedule_event_by_name_or_id(_schedule_name_or_id, _schedule_event_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_schedule_event_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsScheduleEvent or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_schedule_events

Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_schedule_events(_schedule_name_or_id, _offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_offset	Real
_count	Real
_tags	Array of String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationScheduleEvent or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_schedule_progresses

Fetches all current assignments to the currently logged-in profile.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_schedule_progresses(_schedule_name_or_id, _offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProgress or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_schedules

Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_schedules(_offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationSchedule or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_server_health

Performs the health check for the server. What this actually does is deployment and implementation specific. However, any successful response code should indicate that the service is capable of servicing requests. Any unsuccessful error codes should indicate that the instance has internal issues and should be taken offline.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_server_health(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsHealthStatus or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_simple_inventory_item

Gets the first (primary) inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_simple_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_simple_inventory_items

Searches all inventory items in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_simple_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_user_id	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_smart_contract

Gets a specific Smart Contract by contractId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_smart_contract(_contract_id, _callback=undefined)

Argument	Type	Description
_contract_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSmartContract or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_smart_contracts

Gets a pagination of SmartContracts.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_smart_contracts(_offset=undefined, _count=undefined, _api=undefined, _network=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_api	String
_network	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationSmartContract or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_steam_application_configuration

Gets a single Steam application configuration based on unique name or ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_steam_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSteamApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_user

Gets a specific user by name, email, or unique user ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_user(_name, _callback=undefined)

Argument	Type	Description
_name	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUser or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_user_save_data_document_by_slot

Gets a single save data document based on UserID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an user id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_user_save_data_document_by_slot(_user_id, _slot, _callback=undefined)

Argument	Type	Description
_user_id	String
_slot	Real
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_users

Searches all users in the system and returning the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_users(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationUser or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_vault

Gets a specific Vault by Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_vault(_vault_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsVault or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_vaults

Gets a pagination of Wallets. Optionally a user Id can be specified to filter for a given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_vaults(_offset=undefined, _count=undefined, _user_id=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_user_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationVault or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_version

Returns information about the current server version. This should always return theversion metadata. This information is only known in packaged releases.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_version(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsVersion or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_wallet

Gets a specific Wallet by Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_wallet(_wallet_id, _callback=undefined)

Argument	Type	Description
_wallet_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsWallet or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_wallet_for_vault

Gets a specific Wallet by Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_wallet_for_vault(_vault_id, _wallet_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_wallet_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsWallet or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_get_wallets

Gets a pagination of Wallets. Optionally a user Id can be specified to filter for a given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_get_wallets(_vault_id, _offset=undefined, _count=undefined, _user_id=undefined, _api=undefined, _network=undefined, _callback=undefined)

Argument	Type	Description
_vault_id	String
_offset	Real
_count	Real
_user_id	String
_api	String
_network	Array of String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationWallet or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_inspect_uploaded_elm

Inspects an ELM file uploaded via multipart form.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_inspect_uploaded_elm(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsInspectUploadedElmBody	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsElementPathRecordMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_link_email_password

Links email+password credentials to the currently authenticated user. The email must first be verified via POST /user/me/email/verify.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_link_email_password(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsLinkEmailPasswordRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUser or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_link_oauth2

Links an external OAuth2 identity to the currently authenticated user. Requires an active user session. Returns the updated session information.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_link_oauth2(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOAuth2SessionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_link_oidc

Links an external OIDC identity to the currently authenticated user. Requires an active user session. Returns the updated session information.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_link_oidc(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOidcSessionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_link_username_password

Links username+password credentials to the currently authenticated user. If the account has no username yet, the supplied username is claimed. If a username is already set it must match; name changes must be done explicitly.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_link_username_password(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsLinkUsernamePasswordRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUser or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_poll_oidc_session

Returns COMPLETE with the session exactly once, on the poll that first observes completion; a subsequent poll for the same id, or a poll for an unknown/expired id, returns 404.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_poll_oidc_session(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOidcLoginAttemptStatusResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_redeem_facebook_iap_purchase

Attempts to verify the Facebook IAP Receipt data.Returns a list of RewardIssuances, some or all of which may be already redeemed.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_redeem_facebook_iap_purchase(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsFacebookIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_redeem_reward_issuance

Redeems the RewardIssuance.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_redeem_reward_issuance(_reward_issuance_id, _callback=undefined)

Argument	Type	Description
_reward_issuance_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsRewardIssuanceRedemptionResult or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_redeem_reward_issuances

Redeems the given list of RewardIssuances.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_redeem_reward_issuances(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	Array of String	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsRewardIssuanceRedemptionResult or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_request_reset

Sends a password reset link to the given email address if an account exists. Always returns 200 to prevent user enumeration.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_request_reset(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsPasswordResetRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	${struct.ElementsRequest}

Back To Top

elements_request_verification

Sends a verification link to the given email address associated with the current user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_request_verification(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsEmailVerificationRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUserUid or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_sign_up_user

Supplying the user create request object, this will create a new user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_sign_up_user(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUserCreateRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUserCreateResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_sign_up_user_and_create_session

Supplying the UserCreateRequest object, this will create a new user and create a session for it. If any Profiles are supplied, the first one will be selected for the session creation.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_sign_up_user_and_create_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUserCreateRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_advanced_inventory_item

Updates an inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_advanced_inventory_item(_inventory_item_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_body	ElementsUpdateInventoryItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_application

Performs an update to an existing application known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_application(_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_body	ElementsUpdateApplicationRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsApplication or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_custom_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_custom_auth_scheme(_auth_scheme_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_auth_scheme_id	String
_body	ElementsUpdateAuthSchemeRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUpdateAuthSchemeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_deployment(_application_id, _version, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_id	String
_version	String
_body	ElementsUpdateDeploymentRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_distinct_inventory_item

Updates an inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_distinct_inventory_item(_distinct_inventory_item_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_distinct_inventory_item_id	String
_body	ElementsUpdateDistinctInventoryItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsDistinctInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_element_deployment

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_element_deployment(_deployment_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_deployment_id	String
_body	ElementsUpdateElementDeploymentRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsElementDeployment or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_facebook_application_configuration

Updates an existing Facebook Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_facebook_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsFacebookApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFacebookApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_firebase_application_configuration

Updates an existing Firebase Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_firebase_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsFirebaseApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFirebaseApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_google_play_application_configuration

Updates an existing Google Play Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_google_play_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsGooglePlayApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsGooglePlayApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_ios_application_configuration

Updates an existing iOS Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_ios_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsIosApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsIosApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_item

Supplying an item, this will update the Item identified by the identifier in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_item(_identifier, _body=undefined, _callback=undefined)

Argument	Type	Description
_identifier	String
_body	ElementsUpdateItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_large_object

Updates a LargeObject

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_large_object(_large_object_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_body	ElementsUpdateLargeObjectRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_large_object_contents

Updates a LargeObject content

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_large_object_contents(_large_object_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_body	ElementsUpdateLargeObjectContentsBody	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_leaderboard

Performs an update to an existing leaderboard known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_leaderboard(_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_body	ElementsUpdateLeaderboardRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLeaderboard or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_match

This method accepts an instance of MultiMatch and updates the DB entry for it that matches the matchId. Though it is generally recommended to update a MultiMatch via matchmaking code in an Element, it can be updated via REST for the purposes of testing or custom workflows.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_match(_match_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_match_id	String
_body	ElementsMultiMatch	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMultiMatch or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_matchmaking_application_configuration

Updates an existing iOS Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_matchmaking_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsMatchmakingApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMatchmakingApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_metadata

Updates a specific metadata object by name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_metadata(_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_id	String
_body	ElementsUpdateMetadataRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadata or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_metadata_spec

Updates a MetadataSpec with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_metadata_spec(_metadata_spec_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_metadata_spec_id	String
_body	ElementsUpdateMetadataSpecRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMetadataSpec or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_mission

Supplying a mission, this will update the Mission identified by the name or ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_mission(_mission_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_mission_name_or_id	String
_body	ElementsUpdateMissionRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsMission or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_oauth2_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_oauth2_auth_scheme(_oauth2_auth_scheme_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_oauth2_auth_scheme_id	String
_body	ElementsCreateOrUpdateOAuth2AuthSchemeRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateOrUpdateOAuth2AuthSchemeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_oculus_application_configuration

Updates an existing Oculus Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_oculus_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsOculusApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_oidc_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_oidc_auth_scheme(_oidc_auth_scheme_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_oidc_auth_scheme_id	String
_body	ElementsCreateOrUpdateOidcAuthSchemeRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateOrUpdateOidcAuthSchemeResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_product_bundle

Updates the Product Bundle identified by the given database id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_product_bundle(_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_id	String
_body	ElementsProductBundle	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProductBundle or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_product_bundle_for_google_play_application_configuration

Updates the ProductBundle for the given ApplicationConfiguration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_product_bundle_for_google_play_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	Array of ElementsProductBundle	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_product_bundle_for_ios_application_configuration

Updates the ProductBundle for the given ApplicationConfiguration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_product_bundle_for_ios_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	Array of ElementsProductBundle	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_profile

Supplying an update request will attempt to update the profile. The call will return the profile as it was written to the database.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_profile(_profile_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_profile_id	String
_body	ElementsUpdateProfileRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_profile_image

Updates a Profile image object

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_profile_image(_profile_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_profile_id	String
_body	ElementsUpdateProfileImageRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_progress

This will update the Progress identified by the ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_progress(_progress_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_progress_id	String
_body	ElementsUpdateProgressRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProgress or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_provider_configuration

Updates an OIDC provider configuration

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_provider_configuration(_provider_configuration_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_provider_configuration_id	String
_body	ElementsCreateOrUpdateOidcProviderConfigurationRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsCreateOrUpdateOidcProviderConfigurationResponse or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_psn_application_configuration

Updates an existing PSN Application profile if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_psn_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsPSNApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPSNApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_registration

Supplying FCM registration token, this will update the token string with the supplied values. Clients may update the same registration with a different token issued with Firebase if they wish to simply retain the association with the

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_registration(_fcm_registration_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_fcm_registration_id	String
_body	ElementsFCMRegistration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsFCMRegistration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_save_document

Gets a single save data document.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_save_document(_save_data_document_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_save_data_document_id	String
_body	ElementsUpdateSaveDataDocumentRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_schedule

Supplying a schedule, this will update the Schedule identified by the name or ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_schedule(_schedule_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_body	ElementsUpdateScheduleRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSchedule or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_schedule_event

Supplying a schedule, this will update the ScheduleEvent identified by the name or ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_schedule_event(_schedule_name_or_id, _schedule_event_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_schedule_event_id	String
_body	ElementsUpdateScheduleEventRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsScheduleEvent or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_simple_inventory_item

Updates an inventory item for the specified item

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_simple_inventory_item(_inventory_item_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_body	ElementsUpdateInventoryItemRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsInventoryItem or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_smart_contract

Patches a Smart Contract entry, associated with the specified deployed script hash.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_smart_contract(_contract_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_contract_id	String
_body	ElementsUpdateSmartContractRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSmartContract or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_steam_application_configuration

Updates an existing Steam application configuration if it is known to the server.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_steam_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_application_name_or_id	String
_application_configuration_name_or_id	String
_body	ElementsSteamApplicationConfiguration	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSteamApplicationConfiguration or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_user

Supplying the user object, this will update the user with the new information supplied in the body of the request. Optionally, the user's password may be provided in the User object.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_user(_user_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_user_id	String
_body	ElementsUserUpdateRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsUser or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_user_password

Supplying the UserUpdatePasswordRequest, this will attempt to update the user's password only if they supply the correct existing password.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_user_password(_user_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_user_id	String
_body	ElementsUserUpdatePasswordRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSessionCreation or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_vault

Updates a Vault with the specified name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_vault(_vault_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_vault_id	String
_body	ElementsUpdateVaultRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsVault or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_update_wallet

Updates a Wallet with the specified name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_update_wallet(_vault_id, _wallet_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_vault_id	String
_wallet_id	String
_body	ElementsUpdateWalletRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsWallet or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_upload_apple_iap_receipt

Upload Apple IAP Receipt. Returns a list of RewardIssuances, which may contain already-redeemed issuances.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_upload_apple_iap_receipt(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateAppleIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_upload_google_play_iap_purchase

Upload Google Play IAP Receipt data (package name, product id and Google Play-issued purchase token). Returns a list of RewardIssuances, some or all of which may be already redeemed.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_upload_google_play_iap_purchase(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateGooglePlayIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_upload_steam_iap_purchase

Verify a Steam IAP purchase by order ID and return a list of RewardIssuances. The order ID is validated against the Steam ISteamMicroTxn API using the publisher key and app ID stored in the application's SteamApplicationConfiguration. Some or all of the returned RewardIssuances may already be redeemed.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_upload_steam_iap_purchase(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSteamIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Array of ElementsRewardIssuance or Undefined
_request	${struct.ElementsRequest}

Back To Top

elements_verify_oculus_iap_purchase

Attempts to verify the Oculus IAP Receipt data.Returns the result of the verification.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.

Syntax:

elements_verify_oculus_iap_purchase(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOculusIapReceipt	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsOculusIapVerifyReceiptResponse or Undefined
_request	${struct.ElementsRequest}

GameMaker 2026

GMEXT-Elements

Guides

GML Wrapper Structure

REST API

Schemas

Schemas

Uh oh!

elements_rest_api

Elements REST API

Functions

elements_adjust_advanced_inventory_item_quantity

elements_adjust_simple_inventory_item_quantity

elements_blacklist_session

elements_build_indexes

elements_callback

elements_complete_reset

elements_complete_verification

elements_consume_oculus_iap_purchase

elements_create_advanced_inventory_item

elements_create_application

elements_create_custom_auth_scheme

elements_create_distinct_inventory_item

elements_create_element_deployment

elements_create_facebook_application_configuration

elements_create_facebook_iap_receipt

elements_create_fcm_registration

elements_create_firebase_application_configuration

elements_create_follower

elements_create_google_play_application_configuration

elements_create_ios_application_configuration

elements_create_item

elements_create_large_object

elements_create_large_object_from_url

elements_create_leaderboard

elements_create_match

elements_create_matchmaking_application_configuration

elements_create_metadata

elements_create_metadata_spec

elements_create_mission

elements_create_mock_session

elements_create_multipart_large_object

elements_create_new_deployment

elements_create_oauth2_auth_scheme

elements_create_oauth2_session

elements_create_oculus_application_configuration

elements_create_oculus_iap_receipt

elements_create_oidc_auth_scheme

elements_create_oidc_session

elements_create_oidc_session_1

elements_create_product_bundle

elements_create_product_sku_schema

elements_create_profile

elements_create_progress

elements_create_provider_configuration

elements_create_psn_application_configuration

elements_create_receipt

elements_create_save_document

elements_create_schedule

elements_create_schedule_event

elements_create_score

elements_create_simple_inventory_item

elements_create_smart_contract

elements_create_steam_application_configuration

elements_create_user

elements_create_username_password_session

elements_create_vault

elements_create_wallet

elements_deactivate_profile

elements_deactivate_user

elements_delete_advanced_inventory_item

elements_delete_all_matches

elements_delete_application

elements_delete_contract

elements_delete_custom_auth_scheme

elements_delete_deployment

elements_delete_distinct_inventory_item

elements_delete_element_deployment

elements_delete_facebook_application_configuration

elements_delete_fcm_registration

elements_delete_firebase_application_configuration

elements_delete_follower

elements_delete_friend_registration

elements_delete_google_play_application_configuration

elements_delete_ios_application_configuration

elements_delete_item

elements_delete_large_object