playfab-sdk/Scripts/typings/PlayFab/PlayFabClient.d.ts

Playfab SDK for node.js applications

declare module PlayFabClientModule {
    export interface IPlayFabClient {
        settings: PlayFabModule.IPlayFabSettings;
        IsClientLoggedIn(): boolean;

        // Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
        // allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
        // items will be swapped between the two players' inventories.
        // https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade
        AcceptTrade(
            request: PlayFabClientModels.AcceptTradeRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AcceptTradeResponse> | null,
        ): void;
        // Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
        // least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
        // https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
        AddFriend(
            request: PlayFabClientModels.AddFriendRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AddFriendResult> | null,
        ): void;
        // Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
        // ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
        // authentication credentials, as the intent is that it is easily accessible by other players.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid
        AddGenericID(
            request: PlayFabClientModels.AddGenericIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AddGenericIDResult> | null,
        ): void;
        // Adds or updates a contact email to the player's profile.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
        AddOrUpdateContactEmail(
            request: PlayFabClientModels.AddOrUpdateContactEmailRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AddOrUpdateContactEmailResult> | null,
        ): void;
        // Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users
        // in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
        // please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
        // https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers
        AddSharedGroupMembers(
            request: PlayFabClientModels.AddSharedGroupMembersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AddSharedGroupMembersResult> | null,
        ): void;
        // Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
        // ID login.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
        AddUsernamePassword(
            request: PlayFabClientModels.AddUsernamePasswordRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AddUsernamePasswordResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Increments the user's balance of the specified virtual currency by the stated amount
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency
        AddUserVirtualCurrency(
            request: PlayFabClientModels.AddUserVirtualCurrencyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ModifyUserVirtualCurrencyResult> | null,
        ): void;
        // Registers the Android device to receive push notifications
        // https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
        AndroidDevicePushNotificationRegistration(
            request: PlayFabClientModels.AndroidDevicePushNotificationRegistrationRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AndroidDevicePushNotificationRegistrationResult> | null,
        ): void;
        // Attributes an install for advertisment.
        // https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
        AttributeInstall(
            request: PlayFabClientModels.AttributeInstallRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.AttributeInstallResult> | null,
        ): void;
        // Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
        // can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
        // players from accepting them, for trades that can be claimed by more than one player).
        // https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade
        CancelTrade(
            request: PlayFabClientModels.CancelTradeRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.CancelTradeResponse> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
        // virtual currency balances as appropriate
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
        ConfirmPurchase(
            request: PlayFabClientModels.ConfirmPurchaseRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ConfirmPurchaseResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
        // inventory.
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
        ConsumeItem(
            request: PlayFabClientModels.ConsumeItemRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ConsumeItemResult> | null,
        ): void;
        // Grants the player's current entitlements from Microsoft Store's Collection API
        // https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements
        ConsumeMicrosoftStoreEntitlements(
            request: PlayFabClientModels.ConsumeMicrosoftStoreEntitlementsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ConsumeMicrosoftStoreEntitlementsResponse> | null,
        ): void;
        // Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
        // PlayFab items
        // https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements
        ConsumePS5Entitlements(
            request: PlayFabClientModels.ConsumePS5EntitlementsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ConsumePS5EntitlementsResult> | null,
        ): void;
        // Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
        // https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements
        ConsumePSNEntitlements(
            request: PlayFabClientModels.ConsumePSNEntitlementsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ConsumePSNEntitlementsResult> | null,
        ): void;
        // Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
        // player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
        // https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements
        ConsumeXboxEntitlements(
            request: PlayFabClientModels.ConsumeXboxEntitlementsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ConsumeXboxEntitlementsResult> | null,
        ): void;
        // Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
        // group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
        // between a very small number of players, please see our guide:
        // https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
        // https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup
        CreateSharedGroup(
            request: PlayFabClientModels.CreateSharedGroupRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.CreateSharedGroupResult> | null,
        ): void;
        // Deletes title-specific custom properties for a player
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties
        DeletePlayerCustomProperties(
            request: PlayFabClientModels.DeletePlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.DeletePlayerCustomPropertiesResult> | null,
        ): void;
        // Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
        // PlayFab ID is the entity ID of the player's master_player_account entity.
        // https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript
        ExecuteCloudScript(
            request: PlayFabClientModels.ExecuteCloudScriptRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ExecuteCloudScriptResult> | null,
        ): void;
        // Retrieves the user's PlayFab account details
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
        GetAccountInfo(
            request: PlayFabClientModels.GetAccountInfoRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetAccountInfoResult> | null,
        ): void;
        // Returns a list of ad placements and a reward for each
        // https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements
        GetAdPlacements(
            request: PlayFabClientModels.GetAdPlacementsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetAdPlacementsResult> | null,
        ): void;
        // Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
        // evaluated with the parent PlayFabId to guarantee uniqueness.
        // https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
        GetAllUsersCharacters(
            request: PlayFabClientModels.ListUsersCharactersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ListUsersCharactersResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
        // https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems
        GetCatalogItems(
            request: PlayFabClientModels.GetCatalogItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetCatalogItemsResult> | null,
        ): void;
        // Retrieves the title-specific custom data for the character which is readable and writable by the client
        // https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata
        GetCharacterData(
            request: PlayFabClientModels.GetCharacterDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetCharacterDataResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Retrieves the specified character's current inventory of virtual goods
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory
        GetCharacterInventory(
            request: PlayFabClientModels.GetCharacterInventoryRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetCharacterInventoryResult> | null,
        ): void;
        // Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
        // https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard
        GetCharacterLeaderboard(
            request: PlayFabClientModels.GetCharacterLeaderboardRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetCharacterLeaderboardResult> | null,
        ): void;
        // Retrieves the title-specific custom data for the character which can only be read by the client
        // https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata
        GetCharacterReadOnlyData(
            request: PlayFabClientModels.GetCharacterDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetCharacterDataResult> | null,
        ): void;
        // Retrieves the details of all title-specific statistics for the user
        // https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
        GetCharacterStatistics(
            request: PlayFabClientModels.GetCharacterStatisticsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetCharacterStatisticsResult> | null,
        ): void;
        // This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
        // URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
        // content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
        // the query to retrieve the data will fail. See this post for more information:
        // https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
        // please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
        // https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl
        GetContentDownloadUrl(
            request: PlayFabClientModels.GetContentDownloadUrlRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetContentDownloadUrlResult> | null,
        ): void;
        // Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
        // the leaderboard
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard
        GetFriendLeaderboard(
            request: PlayFabClientModels.GetFriendLeaderboardRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetLeaderboardResult> | null,
        ): void;
        // Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
        // user. If PlayFabId is empty or null will return currently logged in user.
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer
        GetFriendLeaderboardAroundPlayer(
            request: PlayFabClientModels.GetFriendLeaderboardAroundPlayerRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetFriendLeaderboardAroundPlayerResult> | null,
        ): void;
        // Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
        // linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
        // https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist
        GetFriendsList(
            request: PlayFabClientModels.GetFriendsListRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetFriendsListResult> | null,
        ): void;
        // Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard
        GetLeaderboard(
            request: PlayFabClientModels.GetLeaderboardRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetLeaderboardResult> | null,
        ): void;
        // Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
        // https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter
        GetLeaderboardAroundCharacter(
            request: PlayFabClientModels.GetLeaderboardAroundCharacterRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetLeaderboardAroundCharacterResult> | null,
        ): void;
        // Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
        // null will return currently logged in user.
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
        GetLeaderboardAroundPlayer(
            request: PlayFabClientModels.GetLeaderboardAroundPlayerRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetLeaderboardAroundPlayerResult> | null,
        ): void;
        // Retrieves a list of all of the user's characters for the given statistic.
        // https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters
        GetLeaderboardForUserCharacters(
            request: PlayFabClientModels.GetLeaderboardForUsersCharactersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetLeaderboardForUsersCharactersResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
        // client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
        // client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken
        GetPaymentToken(
            request: PlayFabClientModels.GetPaymentTokenRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPaymentTokenResult> | null,
        ): void;
        // Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
        // https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
        // https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
        GetPhotonAuthenticationToken(
            request: PlayFabClientModels.GetPhotonAuthenticationTokenRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPhotonAuthenticationTokenResult> | null,
        ): void;
        // Retrieves all of the user's different kinds of info.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo
        GetPlayerCombinedInfo(
            request: PlayFabClientModels.GetPlayerCombinedInfoRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerCombinedInfoResult> | null,
        ): void;
        // Retrieves a title-specific custom property value for a player.
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
        GetPlayerCustomProperty(
            request: PlayFabClientModels.GetPlayerCustomPropertyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerCustomPropertyResult> | null,
        ): void;
        // Retrieves the player's profile
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
        GetPlayerProfile(
            request: PlayFabClientModels.GetPlayerProfileRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerProfileResult> | null,
        ): void;
        // List all segments that a player currently belongs to at this moment in time.
        // https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments
        GetPlayerSegments(
            request: PlayFabClientModels.GetPlayerSegmentsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerSegmentsResult> | null,
        ): void;
        // Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
        // player.
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics
        GetPlayerStatistics(
            request: PlayFabClientModels.GetPlayerStatisticsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerStatisticsResult> | null,
        ): void;
        // Retrieves the information on the available versions of the specified statistic.
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
        GetPlayerStatisticVersions(
            request: PlayFabClientModels.GetPlayerStatisticVersionsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerStatisticVersionsResult> | null,
        ): void;
        // Get all tags with a given Namespace (optional) from a player profile.
        // https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
        GetPlayerTags(
            request: PlayFabClientModels.GetPlayerTagsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerTagsResult> | null,
        ): void;
        // Gets all trades the player has either opened or accepted, optionally filtered by trade status.
        // https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades
        GetPlayerTrades(
            request: PlayFabClientModels.GetPlayerTradesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayerTradesResponse> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids
        GetPlayFabIDsFromFacebookIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromFacebookIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromFacebookIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids
        GetPlayFabIDsFromFacebookInstantGamesIds(
            request: PlayFabClientModels.GetPlayFabIDsFromFacebookInstantGamesIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromFacebookInstantGamesIdsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
        // Programming Guide as the Player Identifier).
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids
        GetPlayFabIDsFromGameCenterIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromGameCenterIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromGameCenterIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
        // service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
        // added to the player account.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids
        GetPlayFabIDsFromGenericIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromGenericIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromGenericIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
        // the user accounts, available as "id" in the Google+ People API calls.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids
        GetPlayFabIDsFromGoogleIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromGoogleIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromGoogleIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
        // identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
        // calls.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids
        GetPlayFabIDsFromGooglePlayGamesPlayerIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
        // IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
        // http://developers.kongregate.com/docs/client/getUserId).
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids
        GetPlayFabIDsFromKongregateIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromKongregateIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromKongregateIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids
        GetPlayFabIDsFromNintendoServiceAccountIds(
            request: PlayFabClientModels.GetPlayFabIDsFromNintendoServiceAccountIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromNintendoServiceAccountIdsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids
        GetPlayFabIDsFromNintendoSwitchDeviceIds(
            request: PlayFabClientModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids
        GetPlayFabIDsFromPSNAccountIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromPSNAccountIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromPSNAccountIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids
        GetPlayFabIDsFromPSNOnlineIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromPSNOnlineIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromPSNOnlineIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
        // IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids
        GetPlayFabIDsFromSteamIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromSteamIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromSteamIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
        // names.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames
        GetPlayFabIDsFromSteamNames(
            request: PlayFabClientModels.GetPlayFabIDsFromSteamNamesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromSteamNamesResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
        // the user accounts, available as "_id" from the Twitch API methods (ex:
        // https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids
        GetPlayFabIDsFromTwitchIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromTwitchIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromTwitchIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids
        GetPlayFabIDsFromXboxLiveIDs(
            request: PlayFabClientModels.GetPlayFabIDsFromXboxLiveIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPlayFabIDsFromXboxLiveIDsResult> | null,
        ): void;
        // Retrieves the key-value store of custom publisher settings
        // https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata
        GetPublisherData(
            request: PlayFabClientModels.GetPublisherDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPublisherDataResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
        // are still active.
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
        GetPurchase(
            request: PlayFabClientModels.GetPurchaseRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetPurchaseResult> | null,
        ): void;
        // Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group
        // may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
        // Shared Groups are designed for sharing data between a very small number of players, please see our guide:
        // https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
        // https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata
        GetSharedGroupData(
            request: PlayFabClientModels.GetSharedGroupDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetSharedGroupDataResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Retrieves the set of items defined for the specified store, including all prices defined
        // https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems
        GetStoreItems(
            request: PlayFabClientModels.GetStoreItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetStoreItemsResult> | null,
        ): void;
        // Retrieves the current server time
        // https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
        GetTime(
            request: PlayFabClientModels.GetTimeRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetTimeResult> | null,
        ): void;
        // Retrieves the key-value store of custom title settings
        // https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata
        GetTitleData(
            request: PlayFabClientModels.GetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetTitleDataResult> | null,
        ): void;
        // Retrieves the title news feed, as configured in the developer portal
        // https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews
        GetTitleNews(
            request: PlayFabClientModels.GetTitleNewsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetTitleNewsResult> | null,
        ): void;
        // Returns the title's base 64 encoded RSA CSP blob.
        // https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
        GetTitlePublicKey(
            request: PlayFabClientModels.GetTitlePublicKeyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetTitlePublicKeyResult> | null,
        ): void;
        // Gets the current status of an existing trade.
        // https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus
        GetTradeStatus(
            request: PlayFabClientModels.GetTradeStatusRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetTradeStatusResponse> | null,
        ): void;
        // Retrieves the title-specific custom data for the user which is readable and writable by the client
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata
        GetUserData(
            request: PlayFabClientModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetUserDataResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
        // version 2._ Retrieves the user's current inventory of virtual goods
        // https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
        GetUserInventory(
            request: PlayFabClientModels.GetUserInventoryRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetUserInventoryResult> | null,
        ): void;
        // Retrieves the publisher-specific custom data for the user which is readable and writable by the client
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata
        GetUserPublisherData(
            request: PlayFabClientModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetUserDataResult> | null,
        ): void;
        // Retrieves the publisher-specific custom data for the user which can only be read by the client
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata
        GetUserPublisherReadOnlyData(
            request: PlayFabClientModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetUserDataResult> | null,
        ): void;
        // Retrieves the title-specific custom data for the user which can only be read by the client
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata
        GetUserReadOnlyData(
            request: PlayFabClientModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GetUserDataResult> | null,
        ): void;
        // Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
        // with the parent PlayFabId to guarantee uniqueness.
        // https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
        GrantCharacterToUser(
            request: PlayFabClientModels.GrantCharacterToUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.GrantCharacterToUserResult> | null,
        ): void;
        // Links the Android device identifier to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
        LinkAndroidDeviceID(
            request: PlayFabClientModels.LinkAndroidDeviceIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkAndroidDeviceIDResult> | null,
        ): void;
        // Links the Apple account associated with the token to the user's PlayFab account.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple
        LinkApple(
            request: PlayFabClientModels.LinkAppleRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.EmptyResult> | null,
        ): void;
        // Links the custom identifier, generated by the title, to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid
        LinkCustomID(
            request: PlayFabClientModels.LinkCustomIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkCustomIDResult> | null,
        ): void;
        // Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount
        LinkFacebookAccount(
            request: PlayFabClientModels.LinkFacebookAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkFacebookAccountResult> | null,
        ): void;
        // Links the Facebook Instant Games Id to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
        LinkFacebookInstantGamesId(
            request: PlayFabClientModels.LinkFacebookInstantGamesIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkFacebookInstantGamesIdResult> | null,
        ): void;
        // Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with
        // a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
        // in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
        // page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount
        LinkGameCenterAccount(
            request: PlayFabClientModels.LinkGameCenterAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkGameCenterAccountResult> | null,
        ): void;
        // Links the currently signed-in user account to their Google account, using their Google account credentials
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount
        LinkGoogleAccount(
            request: PlayFabClientModels.LinkGoogleAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkGoogleAccountResult> | null,
        ): void;
        // Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
        // credentials
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
        LinkGooglePlayGamesServicesAccount(
            request: PlayFabClientModels.LinkGooglePlayGamesServicesAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkGooglePlayGamesServicesAccountResult> | null,
        ): void;
        // Links the vendor-specific iOS device identifier to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid
        LinkIOSDeviceID(
            request: PlayFabClientModels.LinkIOSDeviceIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkIOSDeviceIDResult> | null,
        ): void;
        // Links the Kongregate identifier to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
        LinkKongregate(
            request: PlayFabClientModels.LinkKongregateAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkKongregateAccountResult> | null,
        ): void;
        // Links the Nintendo account associated with the token to the user's PlayFab account.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount
        LinkNintendoServiceAccount(
            request: PlayFabClientModels.LinkNintendoServiceAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.EmptyResult> | null,
        ): void;
        // Links the NintendoSwitchDeviceId to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
        LinkNintendoSwitchDeviceId(
            request: PlayFabClientModels.LinkNintendoSwitchDeviceIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkNintendoSwitchDeviceIdResult> | null,
        ): void;
        // Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
        // Open ID Connect provider and the OpenId Connect JWT from that provider.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
        LinkOpenIdConnect(
            request: PlayFabClientModels.LinkOpenIdConnectRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.EmptyResult> | null,
        ): void;
        // Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount
        LinkPSNAccount(
            request: PlayFabClientModels.LinkPSNAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkPSNAccountResult> | null,
        ): void;
        // Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount
        LinkSteamAccount(
            request: PlayFabClientModels.LinkSteamAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkSteamAccountResult> | null,
        ): void;
        // Links the Twitch account associated with the token to the user's PlayFab account.
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch
        LinkTwitch(
            request: PlayFabClientModels.LinkTwitchAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkTwitchAccountResult> | null,
        ): void;
        // Links the Xbox Live account associated with the provided access code to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount
        LinkXboxAccount(
            request: PlayFabClientModels.LinkXboxAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LinkXboxAccountResult> | null,
        ): void;
        // Retrieves title-specific custom property values for a player.
        // https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
        ListPlayerCustomProperties(
            request: PlayFabClientModels.ListPlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.ListPlayerCustomPropertiesResult> | null,
        ): void;
        // Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
        // API calls which require an authenticated user
        // https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid
        LoginWithAndroidDeviceID(
            request: PlayFabClientModels.LoginWithAndroidDeviceIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LoginResult> | null,
        ): void;
        // Signs in the user with a Sign in with Apple identity token.
        // https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
        LoginWithApple(
            request: PlayFabClientModels.LoginWithAppleRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LoginResult> | null,
        ): void;
        // Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
        // subsequently be used for API calls which require an authenticated user
        // https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
        LoginWithCustomID(
            request: PlayFabClientModels.LoginWithCustomIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LoginResult> | null,
        ): void;
        // Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
        // which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
        // creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
        // RegisterPlayFabUser.
        // https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
        LoginWithEmailAddress(
            request: PlayFabClientModels.LoginWithEmailAddressRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabClientModels.LoginResult> | null,
        ): void;
        // Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
        // calls which require an a