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_upload_apple_iap_receipt

Upload Apple IAP Receipt. Returns a list of RewardIssuances, which may contain already-redeemed issuances.

Syntax:

elements_upload_apple_iap_receipt(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateAppleIapReceipt	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_application(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateApplicationRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_application(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_application

Performs an update to an existing application known to the server.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_application

Deletes a specific application known to the server.

Syntax:

elements_delete_application(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_facebook_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_facebook_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_facebook_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_facebook_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_firebase_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_firebase_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_firebase_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_firebase_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_google_play_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_google_play_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_google_play_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_google_play_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_product_bundle_for_application_configuration

Updates the ProductBundle for the given ApplicationConfiguration

Syntax:

elements_update_product_bundle_for_application_configuration(_application_name_or_id, _application_configuration_name_or_id, _body=undefined, _content_type=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 the http request.
_content_type	String	The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_ios_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_ios_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_ios_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_ios_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_product_bundle_for_application_configuration_1

Updates the ProductBundle for the given ApplicationConfiguration

Syntax:

elements_update_product_bundle_for_application_configuration_1(_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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_matchmaking_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_matchmaking_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_matchmaking_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_matchmaking_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_psn_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_psn_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_psn_application_configuration

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_psn_application_configuration

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_auth_schemes

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

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_auth_scheme

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

Syntax:

elements_create_auth_scheme(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateAuthSchemeRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_auth_scheme

Gets a specific Auth Scheme by the authSchemeId.

Syntax:

elements_get_auth_scheme(_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_auth_scheme_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_auth_scheme

Updates an Auth Scheme with the specified data in the auth scheme request.

Syntax:

elements_update_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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_auth_scheme

Deletes an Auth Scheme with the specified id.

Syntax:

elements_delete_auth_scheme(_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_auth_scheme_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_oauth2_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOAuth2SessionRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_auth_schemes_1

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

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_auth_scheme_1

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

Syntax:

elements_create_auth_scheme_1(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateOrUpdateOAuth2AuthSchemeRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_auth_scheme_1

Gets a specific Auth Scheme by the oAuth2AuthSchemeId.

Syntax:

elements_get_auth_scheme_1(_oauth2_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oauth2_auth_scheme_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_auth_scheme_1

Updates an Auth Scheme with the specified data in the auth scheme request.

Syntax:

elements_update_auth_scheme_1(_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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_auth_scheme_1

Deletes an Auth Scheme with the specified id.

Syntax:

elements_delete_auth_scheme_1(_oauth2_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oauth2_auth_scheme_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_oidc_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsOidcSessionRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_auth_schemes_2

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

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_tags	Array of String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_auth_scheme_2

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

Syntax:

elements_create_auth_scheme_2(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateOrUpdateOidcAuthSchemeRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_auth_scheme_2

Gets a specific Auth Scheme by the oidcAuthSchemeId.

Syntax:

elements_get_auth_scheme_2(_oidc_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oidc_auth_scheme_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_auth_scheme_2

Updates an Auth Scheme with the specified data in the auth scheme request.

Syntax:

elements_update_auth_scheme_2(_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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_auth_scheme_2

Deletes an Auth Scheme with the specified id.

Syntax:

elements_delete_auth_scheme_2(_oidc_auth_scheme_id, _callback=undefined)

Argument	Type	Description
_oidc_auth_scheme_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_smart_contracts

Gets a pagination of SmartContracts.

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_api	String	( one of: NEO
_network	Array of String	( one of: NEO
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_smart_contract

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

Syntax:

elements_create_smart_contract(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSmartContractRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_smart_contract

Gets a specific Smart Contract by contractId.

Syntax:

elements_get_smart_contract(_contract_id, _callback=undefined)

Argument	Type	Description
_contract_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_smart_contract

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_contract

Deletes a Smart Contract with the specified contractId.

Syntax:

elements_delete_contract(_contract_id, _callback=undefined)

Argument	Type	Description
_contract_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_vaults

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_vault

Creates a new Vault, associated with the given user.

Syntax:

elements_create_vault(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateVaultRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_vault

Gets a specific Vault by Id.

Syntax:

elements_get_vault(_vault_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_vault

Updates a Vault with the specified name or id.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_vault

Deletes a Vault with the specified id.

Syntax:

elements_delete_vault(_vault_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_wallets

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

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	( one of: NEO
_network	Array of String	( one of: NEO
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_wallet

Creates a new Wallet, associated with the given user.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_wallet

Gets a specific Wallet by Id.

Syntax:

elements_get_wallet(_vault_id, _wallet_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_wallet_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_wallet

Updates a Wallet with the specified name or id.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_wallet

Deletes a Wallet with the specified id.

Syntax:

elements_delete_wallet(_vault_id, _wallet_id, _callback=undefined)

Argument	Type	Description
_vault_id	String
_wallet_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_wallet_1

Gets a specific Wallet by Id.

Syntax:

elements_get_wallet_1(_wallet_id, _callback=undefined)

Argument	Type	Description
_wallet_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_deployments

Syntax:

elements_get_deployments(_application_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_new_deployment

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_deployment

Syntax:

elements_get_deployment(_application_id, _deployment_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_deployment_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_deployment

Syntax:

elements_delete_deployment(_application_id, _deployment_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_deployment_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_current_deployment

Syntax:

elements_get_current_deployment(_application_id, _callback=undefined)

Argument	Type	Description
_application_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_deployment

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_generate_code(_body=undefined, _content_type=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCodegenRequest	The body to be included in the the http request.
_content_type	String	The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_followers

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

Syntax:

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

Argument	Type	Description
_profile_id	String
_offset	Real
_count	Real
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_followers_1

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

Syntax:

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

Argument	Type	Description
_profile_id	String
_offset	Real
_count	Real
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_follower

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_follower

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_follower

Syntax:

elements_get_follower(_profile_id, _followed_id, _callback=undefined)

Argument	Type	Description
_profile_id	String
_followed_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_friend

Gets a specific friend using the ID of the friend.

Syntax:

elements_get_friend(_friend_id, _callback=undefined)

Argument	Type	Description
_friend_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_friend_registration

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

Syntax:

elements_delete_friend_registration(_friend_id, _callback=undefined)

Argument	Type	Description
_friend_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_friends

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

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateItemRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_item_by_identifier

Looks up an item by the passed in identifier

Syntax:

elements_get_item_by_identifier(_identifier, _callback=undefined)

Argument	Type	Description
_identifier	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_update_item(_identifier, _body=undefined, _callback=undefined)

Argument	Type	Description
_identifier	String
_body	ElementsUpdateItemRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_upload_google_play_iap_purchase

Syntax:

elements_upload_google_play_iap_purchase(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateGooglePlayIapReceipt	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_build_indexes

Syntax:

elements_build_indexes(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsBuildIndexRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_plans

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_advanced_inventory_item

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

Syntax:

elements_get_advanced_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_simple_inventory_item

Updates an inventory item for the specified item

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_advanced_inventory_item

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

Syntax:

elements_delete_advanced_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_advanced_inventory_item

Create an inventory item for the specified item

Syntax:

elements_create_advanced_inventory_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateAdvancedInventoryItemRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_distinct_inventory_item

Create an inventory item for the specified item

Syntax:

elements_create_distinct_inventory_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateDistinctInventoryItemRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_distinct_inventory_item

Updates an inventory item for the specified item

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_distinct_inventory_item

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

Syntax:

elements_delete_distinct_inventory_item(_distinct_inventory_item_id, _callback=undefined)

Argument	Type	Description
_distinct_inventory_item_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_distinct_inventory_item

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

Syntax:

elements_get_distinct_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_simple_inventory_item

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

Syntax:

elements_get_simple_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_simple_inventory_item_1

Updates an inventory item for the specified item

Syntax:

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

Argument	Type	Description
_inventory_item_id	String
_body	ElementsUpdateInventoryItemRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_simple_inventory_item

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

Syntax:

elements_delete_simple_inventory_item(_inventory_item_id, _callback=undefined)

Argument	Type	Description
_inventory_item_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_simple_inventory_item

Create an inventory item for the specified item

Syntax:

elements_create_simple_inventory_item(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSimpleInventoryItemRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_matched_user_profiles_with_phone_numbers

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_large_object

Syntax:

elements_create_large_object(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	Struct	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_large_object_1

Syntax:

elements_create_large_object_1(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateLargeObjectRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_large_object_from_url

Syntax:

elements_create_large_object_from_url(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateLargeObjectFromUrlRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_large_object

Syntax:

elements_get_large_object(_large_object_id, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_large_object

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_large_object

Syntax:

elements_delete_large_object(_large_object_id, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_large_object_contents

Syntax:

elements_update_large_object_contents(_large_object_id, _body=undefined, _content_type=undefined, _callback=undefined)

Argument	Type	Description
_large_object_id	String
_body	Struct	The body to be included in the the http request.
_content_type	String	The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_leaderboard(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsLeaderboard	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_leaderboard(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_leaderboard

Performs an update to an existing leaderboard known to the server.

Syntax:

elements_update_leaderboard(_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_body	ElementsLeaderboard	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_leaderboard

Deletes a specific leaderboard known to the server.

Syntax:

elements_delete_leaderboard(_name_or_id, _callback=undefined)

Argument	Type	Description
_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_global_rank_tabular

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_rank_among_friends

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

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	Real	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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_rank_among_mutual_followers

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

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	Real	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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_match

This method accepts an instance of Match, effectively requesting that the server find a suitable opponent for a game. As other suitable players create matches the created match object may be updated as a suitable opponent is found. The client must poll matches for updates and react accordingly.

Syntax:

elements_create_match(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMatch	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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 Match with ID has been updated in the database.

Syntax:

elements_get_match(_match_id, _social_engine_long_poll_timeout=undefined, _callback=undefined)

Argument	Type	Description
_match_id	String
_social_engine_long_poll_timeout	Real	The maximum amount time the server will wait until a request returns a default set of data for long polling. Specifying a zero will request that the server wait indefinitely until responding. Though, the server may enforce a practical upper limit on the amount of time it takes to return. Omitting this header will prompt the server to treat the request as a normal request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_match

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

Syntax:

elements_delete_match(_match_id, _callback=undefined)

Argument	Type	Description
_match_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_metadata_objects

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

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_metadata

Creates a new Metadata object with the provided details.

Syntax:

elements_create_metadata(_body=undefined, _content_type=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMetadataRequest	The body to be included in the the http request.
_content_type	String	The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_metadata_object

Gets a specific metadata object by name or id.

Syntax:

elements_get_metadata_object(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_metadata

Updates a specific metadata object by name or id.

Syntax:

elements_update_metadata(_id, _body=undefined, _content_type=undefined, _callback=undefined)

Argument	Type	Description
_id	String
_body	ElementsUpdateMetadataRequest	The body to be included in the the http request.
_content_type	String	The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_metadata

Deletes a specific metadata object by name or id.

Syntax:

elements_delete_metadata(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_mission(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMission	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_mission_by_name_or_id

Looks up a mission by the passed in identifier

Syntax:

elements_get_mission_by_name_or_id(_mission_name_or_id, _callback=undefined)

Argument	Type	Description
_mission_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_update_mission(_mission_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_mission_name_or_id	String
_body	ElementsMission	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_mission

Deletes a mission by the passed in identifier

Syntax:

elements_delete_mission(_mission_name_or_id, _callback=undefined)

Argument	Type	Description
_mission_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_progress_tabular

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

Syntax:

elements_get_progress_tabular(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_progress

Supplying a progress object, this will create a new progress with a newly assigned unique id. 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.

Syntax:

elements_create_progress(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsProgress	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_progress

Deletes a progress by the passed in identifier

Syntax:

elements_delete_progress(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_progress_by_name_or_id

Looks up a progress by the passed in identifier

Syntax:

elements_get_progress_by_name_or_id(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_progress

Supplying a progress, this will update the Progress identified by the ID in the path with contents from the passed in request body.

Syntax:

elements_update_progress(_progress_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_progress_id	String
_body	ElementsProgress	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_reward_issuance

Syntax:

elements_get_reward_issuance(_reward_issuance_id, _callback=undefined)

Argument	Type	Description
_reward_issuance_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_reward_issuances

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	( one of: ISSUED
_tags	Array of String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_redeem_reward_issuance

Syntax:

elements_redeem_reward_issuance(_reward_issuance_id, _callback=undefined)

Argument	Type	Description
_reward_issuance_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_redeem_reward_issuances

Syntax:

elements_redeem_reward_issuances(_body=undefined, _content_type=undefined, _callback=undefined)

Argument	Type	Description
_body	Array of String	The body to be included in the the http request.
_content_type	String	The type of the body (this will be used by the mapper to convert the body argument to the correct type).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_schedule_event_by_name_or_id

Looks up a schedule by the passed in identifier

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_schedule_event

Deletes a schedule by the passed in identifier

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_schedule_progresses

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

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_schedule(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateScheduleRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_schedule_by_name_or_id

Looks up a schedule by the passed in identifier

Syntax:

elements_get_schedule_by_name_or_id(_schedule_name_or_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_schedule

Deletes a schedule by the passed in identifier

Syntax:

elements_delete_schedule(_schedule_name_or_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_fcm_registration(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsFCMRegistration	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_fcm_registration

Syntax:

elements_delete_fcm_registration(_fcm_registration_id, _callback=undefined)

Argument	Type	Description
_fcm_registration_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_profile(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateProfileRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_deactivate_profile(_profile_id, _callback=undefined)

Argument	Type	Description
_profile_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_current_profile(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_profile

Gets a specific profile by profile ID.

Syntax:

elements_get_profile(_name, _callback=undefined)

Argument	Type	Description
_name	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_profile_image

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_save_data_documents

Gets all save data documents available to the user.

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	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_save_document

Gets a single save data document.

Syntax:

elements_create_save_document(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSaveDataDocumentRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_save_document

Gets a single save data document.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_save_document

Syntax:

elements_delete_save_document(_save_data_document_id, _callback=undefined)

Argument	Type	Description
_save_data_document_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_profile_save_data_document_by_slot(_profile_id, _slot, _callback=undefined)

Argument	Type	Description
_profile_id	String
_slot	Real
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_save_data_document

Gets a single save data document

Syntax:

elements_get_save_data_document(_id, _callback=undefined)

Argument	Type	Description
_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_user_save_data_document_by_slot(_user_id, _slot, _callback=undefined)

Argument	Type	Description
_user_id	String
_slot	Real
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_metadata_specs

Gets a pagination of Metadata Specs for the given query.

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_metadata_spec

Creates a new Metadata Spec definition.

Syntax:

elements_create_metadata_spec(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateMetadataSpecRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_update_metadata_spec

Updates a MetadataSpec with the specified id.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_delete_metadata_spec

Deletes a MetadataSpec with the specified id.

Syntax:

elements_delete_metadata_spec(_metadata_spec_id, _callback=undefined)

Argument	Type	Description
_metadata_spec_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_editor_schema

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

Syntax:

elements_get_editor_schema(_metadata_spec_name, _callback=undefined)

Argument	Type	Description
_metadata_spec_name	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_json_schema

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

Syntax:

elements_get_json_schema(_metadata_spec_name, _callback=undefined)

Argument	Type	Description
_metadata_spec_name	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_metadata_spec

Gets a specific MetadataSpec by name or Id.

Syntax:

elements_get_metadata_spec(_metadata_spec_name_or_id, _callback=undefined)

Argument	Type	Description
_metadata_spec_name_or_id	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_mock_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMockSessionRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_blacklist_session

Syntax:

elements_blacklist_session(_session_secret, _callback=undefined)

Argument	Type	Description
_session_secret	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_create_username_password_session

Begins a session by accepting both the UserID and the Passoword. 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.

Syntax:

elements_create_username_password_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUsernamePasswordSessionRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_server_health(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_get_version(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_sign_up_user

Supplying the user create request object, this will create a new user.

Syntax:

elements_sign_up_user(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUserCreateRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_users

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

Syntax:

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

Argument	Type	Description
_offset	Real
_count	Real
_search	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_create_user(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsUserCreateRequest	The body to be included in the the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

Back To Top

elements_get_user

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

Syntax:

elements_get_user(_name, _callback=undefined)

Argument	Type	Description
_name	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

Syntax:

elements_deactivate_user(_name, _callback=undefined)

Argument	Type	Description
_name	String
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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

Syntax:

elements_get_current_user(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

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.

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 the http request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns: