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

Playfab SDK for node.js applications

declare module PlayFabServerModule {
    export interface IPlayFabServer {
        settings: PlayFabModule.IPlayFabSettings;
        // _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 character's balance of the specified virtual currency by the stated amount
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency
        AddCharacterVirtualCurrency(
            request: PlayFabServerModels.AddCharacterVirtualCurrencyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ModifyCharacterVirtualCurrencyResult> | null,
        ): void;
        // Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
        // FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
        // https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend
        AddFriend(
            request: PlayFabServerModels.AddFriendRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EmptyResponse> | 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/server/account-management/addgenericid
        AddGenericID(
            request: PlayFabServerModels.AddGenericIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EmptyResult> | null,
        ): void;
        // Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
        // https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag
        AddPlayerTag(
            request: PlayFabServerModels.AddPlayerTagRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.AddPlayerTagResult> | 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 (and the server) 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/server/shared-group-data/addsharedgroupmembers
        AddSharedGroupMembers(
            request: PlayFabServerModels.AddSharedGroupMembersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.AddSharedGroupMembersResult> | 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/server/player-item-management/adduservirtualcurrency
        AddUserVirtualCurrency(
            request: PlayFabServerModels.AddUserVirtualCurrencyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ModifyUserVirtualCurrencyResult> | null,
        ): void;
        // Validated a client's session ticket, and if successful, returns details for that user
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket
        AuthenticateSessionTicket(
            request: PlayFabServerModels.AuthenticateSessionTicketRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.AuthenticateSessionTicketResult> | null,
        ): void;
        // Awards the specified users the specified Steam achievements
        // https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement
        AwardSteamAchievement(
            request: PlayFabServerModels.AwardSteamAchievementRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.AwardSteamAchievementResult> | null,
        ): void;
        // Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers
        BanUsers(
            request: PlayFabServerModels.BanUsersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.BanUsersResult> | 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/server/player-item-management/consumeitem
        ConsumeItem(
            request: PlayFabServerModels.ConsumeItemRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ConsumeItemResult> | null,
        ): void;
        // Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
        // group. When created by a server, the group will initially have no 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/server/shared-group-data/createsharedgroup
        CreateSharedGroup(
            request: PlayFabServerModels.CreateSharedGroupRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.CreateSharedGroupResult> | null,
        ): void;
        // Deletes the specific character ID from the specified user.
        // https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser
        DeleteCharacterFromUser(
            request: PlayFabServerModels.DeleteCharacterFromUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.DeleteCharacterFromUserResult> | null,
        ): void;
        // Removes a user's player account from a title and deletes all associated data
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer
        DeletePlayer(
            request: PlayFabServerModels.DeletePlayerRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.DeletePlayerResult> | null,
        ): void;
        // Deletes title-specific custom properties for a player
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties
        DeletePlayerCustomProperties(
            request: PlayFabServerModels.DeletePlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.DeletePlayerCustomPropertiesResult> | null,
        ): void;
        // Deletes push notification template for title
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate
        DeletePushNotificationTemplate(
            request: PlayFabServerModels.DeletePushNotificationTemplateRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.DeletePushNotificationTemplateResult> | null,
        ): void;
        // Deletes a shared group, freeing up the shared group ID to be reused for a new 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/server/shared-group-data/deletesharedgroup
        DeleteSharedGroup(
            request: PlayFabServerModels.DeleteSharedGroupRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EmptyResponse> | 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._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
        // have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to
        // UnlockContainer.
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable
        EvaluateRandomResultTable(
            request: PlayFabServerModels.EvaluateRandomResultTableRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EvaluateRandomResultTableResult> | 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/server/server-side-cloud-script/executecloudscript
        ExecuteCloudScript(
            request: PlayFabServerModels.ExecuteCloudScriptServerRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ExecuteCloudScriptResult> | null,
        ): void;
        // Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
        // GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
        // https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments
        GetAllSegments(
            request: PlayFabServerModels.GetAllSegmentsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetAllSegmentsResult> | 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/server/characters/getalluserscharacters
        GetAllUsersCharacters(
            request: PlayFabServerModels.ListUsersCharactersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/title-wide-data-management/getcatalogitems
        GetCatalogItems(
            request: PlayFabServerModels.GetCatalogItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetCatalogItemsResult> | 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/server/character-data/getcharacterdata
        GetCharacterData(
            request: PlayFabServerModels.GetCharacterDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetCharacterDataResult> | null,
        ): void;
        // Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
        // https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata
        GetCharacterInternalData(
            request: PlayFabServerModels.GetCharacterDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/player-item-management/getcharacterinventory
        GetCharacterInventory(
            request: PlayFabServerModels.GetCharacterInventoryRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/characters/getcharacterleaderboard
        GetCharacterLeaderboard(
            request: PlayFabServerModels.GetCharacterLeaderboardRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetCharacterLeaderboardResult> | null,
        ): void;
        // Retrieves the title-specific custom data for the user's character which can only be read by the client
        // https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata
        GetCharacterReadOnlyData(
            request: PlayFabServerModels.GetCharacterDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetCharacterDataResult> | null,
        ): void;
        // Retrieves the details of all title-specific statistics for the specific character
        // https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics
        GetCharacterStatistics(
            request: PlayFabServerModels.GetCharacterStatisticsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/content/getcontentdownloadurl
        GetContentDownloadUrl(
            request: PlayFabServerModels.GetContentDownloadUrlRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetContentDownloadUrlResult> | null,
        ): void;
        // Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
        // leaderboard
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard
        GetFriendLeaderboard(
            request: PlayFabServerModels.GetFriendLeaderboardRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetLeaderboardResult> | null,
        ): void;
        // Retrieves the current friends for the user with PlayFabId, 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/server/friend-list-management/getfriendslist
        GetFriendsList(
            request: PlayFabServerModels.GetFriendsListRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/player-data-management/getleaderboard
        GetLeaderboard(
            request: PlayFabServerModels.GetLeaderboardRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetLeaderboardResult> | null,
        ): void;
        // Retrieves a list of ranked characters for the given statistic, centered on the requested user
        // https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter
        GetLeaderboardAroundCharacter(
            request: PlayFabServerModels.GetLeaderboardAroundCharacterRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetLeaderboardAroundCharacterResult> | null,
        ): void;
        // Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser
        GetLeaderboardAroundUser(
            request: PlayFabServerModels.GetLeaderboardAroundUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetLeaderboardAroundUserResult> | null,
        ): void;
        // Retrieves a list of all of the user's characters for the given statistic.
        // https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters
        GetLeaderboardForUserCharacters(
            request: PlayFabServerModels.GetLeaderboardForUsersCharactersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetLeaderboardForUsersCharactersResult> | null,
        ): void;
        // Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
        // returned. All parameters default to false.
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo
        GetPlayerCombinedInfo(
            request: PlayFabServerModels.GetPlayerCombinedInfoRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerCombinedInfoResult> | null,
        ): void;
        // Retrieves a title-specific custom property value for a player.
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty
        GetPlayerCustomProperty(
            request: PlayFabServerModels.GetPlayerCustomPropertyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerCustomPropertyResult> | null,
        ): void;
        // Retrieves the player's profile
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile
        GetPlayerProfile(
            request: PlayFabServerModels.GetPlayerProfileRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerProfileResult> | null,
        ): void;
        // List all segments that a player currently belongs to at this moment in time.
        // https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments
        GetPlayerSegments(
            request: PlayFabServerModels.GetPlayersSegmentsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerSegmentsResult> | null,
        ): void;
        // Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
        // the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
        // on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
        // in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
        // called 30 times in one minute. You will be returned an error if you exceed this threshold.
        // https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment
        GetPlayersInSegment(
            request: PlayFabServerModels.GetPlayersInSegmentRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayersInSegmentResult> | null,
        ): void;
        // Retrieves the current version and values for the indicated statistics, for the local player.
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics
        GetPlayerStatistics(
            request: PlayFabServerModels.GetPlayerStatisticsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerStatisticsResult> | null,
        ): void;
        // Retrieves the information on the available versions of the specified statistic.
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions
        GetPlayerStatisticVersions(
            request: PlayFabServerModels.GetPlayerStatisticVersionsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerStatisticVersionsResult> | null,
        ): void;
        // Get all tags with a given Namespace (optional) from a player profile.
        // https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags
        GetPlayerTags(
            request: PlayFabServerModels.GetPlayerTagsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayerTagsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids
        GetPlayFabIDsFromBattleNetAccountIds(
            request: PlayFabServerModels.GetPlayFabIDsFromBattleNetAccountIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromBattleNetAccountIdsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids
        GetPlayFabIDsFromFacebookIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromFacebookIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromFacebookIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids
        GetPlayFabIDsFromFacebookInstantGamesIds(
            request: PlayFabServerModels.GetPlayFabIDsFromFacebookInstantGamesIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromFacebookInstantGamesIdsResult> | 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/server/account-management/getplayfabidsfromgenericids
        GetPlayFabIDsFromGenericIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromGenericIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromGenericIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids
        GetPlayFabIDsFromNintendoServiceAccountIds(
            request: PlayFabServerModels.GetPlayFabIDsFromNintendoServiceAccountIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromNintendoServiceAccountIdsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids
        GetPlayFabIDsFromNintendoSwitchDeviceIds(
            request: PlayFabServerModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids
        GetPlayFabIDsFromPSNAccountIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromPSNAccountIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromPSNAccountIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids
        GetPlayFabIDsFromPSNOnlineIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromPSNOnlineIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/account-management/getplayfabidsfromsteamids
        GetPlayFabIDsFromSteamIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromSteamIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/account-management/getplayfabidsfromsteamnames
        GetPlayFabIDsFromSteamNames(
            request: PlayFabServerModels.GetPlayFabIDsFromSteamNamesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/account-management/getplayfabidsfromtwitchids
        GetPlayFabIDsFromTwitchIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromTwitchIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromTwitchIDsResult> | null,
        ): void;
        // Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids
        GetPlayFabIDsFromXboxLiveIDs(
            request: PlayFabServerModels.GetPlayFabIDsFromXboxLiveIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetPlayFabIDsFromXboxLiveIDsResult> | null,
        ): void;
        // Retrieves the key-value store of custom publisher settings
        // https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata
        GetPublisherData(
            request: PlayFabServerModels.GetPublisherDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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 the configuration information for the specified random results tables for the title, including all
        // ItemId values and weights
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables
        GetRandomResultTables(
            request: PlayFabServerModels.GetRandomResultTablesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetRandomResultTablesResult> | null,
        ): void;
        // Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids
        GetServerCustomIDsFromPlayFabIDs(
            request: PlayFabServerModels.GetServerCustomIDsFromPlayFabIDsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetServerCustomIDsFromPlayFabIDsResult> | null,
        ): void;
        // Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
        // public and private group data. 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/server/shared-group-data/getsharedgroupdata
        GetSharedGroupData(
            request: PlayFabServerModels.GetSharedGroupDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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, for the specified
        // player
        // https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems
        GetStoreItems(
            request: PlayFabServerModels.GetStoreItemsServerRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetStoreItemsResult> | null,
        ): void;
        // Retrieves the current server time
        // https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime
        GetTime(
            request: PlayFabServerModels.GetTimeRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetTimeResult> | null,
        ): void;
        // Retrieves the key-value store of custom title settings
        // https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata
        GetTitleData(
            request: PlayFabServerModels.GetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetTitleDataResult> | null,
        ): void;
        // Retrieves the key-value store of custom internal title settings
        // https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata
        GetTitleInternalData(
            request: PlayFabServerModels.GetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetTitleDataResult> | null,
        ): void;
        // Retrieves the title news feed, as configured in the developer portal
        // https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews
        GetTitleNews(
            request: PlayFabServerModels.GetTitleNewsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetTitleNewsResult> | null,
        ): void;
        // Retrieves the relevant details for a specified user
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo
        GetUserAccountInfo(
            request: PlayFabServerModels.GetUserAccountInfoRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetUserAccountInfoResult> | null,
        ): void;
        // Gets all bans for a user.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans
        GetUserBans(
            request: PlayFabServerModels.GetUserBansRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetUserBansResult> | 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/server/player-data-management/getuserdata
        GetUserData(
            request: PlayFabServerModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetUserDataResult> | null,
        ): void;
        // Retrieves the title-specific custom data for the user which cannot be accessed by the client
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata
        GetUserInternalData(
            request: PlayFabServerModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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 specified user's current inventory of virtual goods
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory
        GetUserInventory(
            request: PlayFabServerModels.GetUserInventoryRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/player-data-management/getuserpublisherdata
        GetUserPublisherData(
            request: PlayFabServerModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GetUserDataResult> | null,
        ): void;
        // Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata
        GetUserPublisherInternalData(
            request: PlayFabServerModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/player-data-management/getuserpublisherreadonlydata
        GetUserPublisherReadOnlyData(
            request: PlayFabServerModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/player-data-management/getuserreadonlydata
        GetUserReadOnlyData(
            request: PlayFabServerModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/characters/grantcharactertouser
        GrantCharacterToUser(
            request: PlayFabServerModels.GrantCharacterToUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GrantCharacterToUserResult> | 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._ Adds the specified items to the specified character's inventory
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter
        GrantItemsToCharacter(
            request: PlayFabServerModels.GrantItemsToCharacterRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GrantItemsToCharacterResult> | 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._ Adds the specified items to the specified user's inventory
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser
        GrantItemsToUser(
            request: PlayFabServerModels.GrantItemsToUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GrantItemsToUserResult> | 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._ Adds the specified items to the specified user inventories
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers
        GrantItemsToUsers(
            request: PlayFabServerModels.GrantItemsToUsersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.GrantItemsToUsersResult> | null,
        ): void;
        // Links the Battle.net account associated with the token to the user's PlayFab account.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount
        LinkBattleNetAccount(
            request: PlayFabServerModels.LinkBattleNetAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EmptyResult> | null,
        ): void;
        // Links the Nintendo account associated with the token to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount
        LinkNintendoServiceAccount(
            request: PlayFabServerModels.LinkNintendoServiceAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EmptyResult> | null,
        ): void;
        // Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject
        LinkNintendoServiceAccountSubject(
            request: PlayFabServerModels.LinkNintendoServiceAccountSubjectRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.EmptyResult> | null,
        ): void;
        // Links the NintendoSwitchDeviceId to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid
        LinkNintendoSwitchDeviceId(
            request: PlayFabServerModels.LinkNintendoSwitchDeviceIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.LinkNintendoSwitchDeviceIdResult> | 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/server/account-management/linkpsnaccount
        LinkPSNAccount(
            request: PlayFabServerModels.LinkPSNAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.LinkPSNAccountResult> | null,
        ): void;
        // Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid
        LinkPSNId(
            request: PlayFabServerModels.LinkPSNIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.LinkPSNIdResponse> | null,
        ): void;
        // Links the custom server identifier, generated by the title, to the user's PlayFab account.
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid
        LinkServerCustomId(
            request: PlayFabServerModels.LinkServerCustomIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.LinkServerCustomIdResult> | null,
        ): void;
        // Links the Steam account associated with the provided Steam ID to the user's PlayFab account
        // https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid
        LinkSteamId(
            request: PlayFabServerModels.LinkSteamIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.LinkSteamIdResult> | 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/server/account-management/linkxboxaccount
        LinkXboxAccount(
            request: PlayFabServerModels.LinkXboxAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.LinkXboxAccountResult> | null,
        ): void;
        // Retrieves title-specific custom property values for a player.
        // https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties
        ListPlayerCustomProperties(
            request: PlayFabServerModels.ListPlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.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/server/authentication/loginwithandroiddeviceid
        LoginWithAndroidDeviceID(
            request: PlayFabServerModels.LoginWithAndroidDeviceIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Sign in the user with a Battle.net identity token
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet
        LoginWithBattleNet(
            request: PlayFabServerModels.LoginWithBattleNetRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | 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/server/authentication/loginwithcustomid
        LoginWithCustomID(
            request: PlayFabServerModels.LoginWithCustomIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Signs the user in using the iOS 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/server/authentication/loginwithiosdeviceid
        LoginWithIOSDeviceID(
            request: PlayFabServerModels.LoginWithIOSDeviceIDRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
        // subsequently be used for API calls which require an authenticated user
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn
        LoginWithPSN(
            request: PlayFabServerModels.LoginWithPSNRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
        // and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid
        LoginWithServerCustomId(
            request: PlayFabServerModels.LoginWithServerCustomIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which
        // require an authenticated user
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid
        LoginWithSteamId(
            request: PlayFabServerModels.LoginWithSteamIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
        // subsequently be used for API calls which require an authenticated user
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox
        LoginWithXbox(
            request: PlayFabServerModels.LoginWithXboxRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | null,
        ): void;
        // Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API
        // calls which require an authenticated user
        // https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid
        LoginWithXboxId(
            request: PlayFabServerModels.LoginWithXboxIdRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ServerLoginResult> | 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._ Modifies the number of remaining uses of a player's inventory item
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses
        ModifyItemUses(
            request: PlayFabServerModels.ModifyItemUsesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.ModifyItemUsesResult> | 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._ Moves an item from a character's inventory into another of the users's character's inventory.
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter
        MoveItemToCharacterFromCharacter(
            request: PlayFabServerModels.MoveItemToCharacterFromCharacterRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.MoveItemToCharacterFromCharacterResult> | 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._ Moves an item from a user's inventory into their character's inventory.
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser
        MoveItemToCharacterFromUser(
            request: PlayFabServerModels.MoveItemToCharacterFromUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.MoveItemToCharacterFromUserResult> | 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._ Moves an item from a character's inventory into the owning user's inventory.
        // https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter
        MoveItemToUserFromCharacter(
            request: PlayFabServerModels.MoveItemToUserFromCharacterRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabServerModels.MoveItemToUserFromCharacterResult> | null,
        ): void;
        // _NOTE: This is a Legacy Economy API