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

Playfab SDK for node.js applications

declare module PlayFabAdminModule {
    export interface IPlayFabAdmin {
        settings: PlayFabModule.IPlayFabSettings;
        // Abort an ongoing task instance.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance
        AbortTaskInstance(
            request: PlayFabAdminModels.AbortTaskInstanceRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.EmptyResponse> | null,
        ): void;
        // Update news item to include localized version
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews
        AddLocalizedNews(
            request: PlayFabAdminModels.AddLocalizedNewsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.AddLocalizedNewsResult> | null,
        ): void;
        // Adds a new news item to the title's news feed
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews
        AddNews(
            request: PlayFabAdminModels.AddNewsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.AddNewsResult> | 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/admin/playstream/addplayertag
        AddPlayerTag(
            request: PlayFabAdminModels.AddPlayerTagRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.AddPlayerTagResult> | 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 specified virtual currency by the stated amount
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency
        AddUserVirtualCurrency(
            request: PlayFabAdminModels.AddUserVirtualCurrencyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ModifyUserVirtualCurrencyResult> | 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 one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum
        // value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes
        AddVirtualCurrencyTypes(
            request: PlayFabAdminModels.AddVirtualCurrencyTypesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.BlankResult> | 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/admin/account-management/banusers
        BanUsers(
            request: PlayFabAdminModels.BanUsersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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._ Checks the global count for the limited edition item.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability
        CheckLimitedEditionItemAvailability(
            request: PlayFabAdminModels.CheckLimitedEditionItemAvailabilityRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CheckLimitedEditionItemAvailabilityResult> | null,
        ): void;
        // Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask
        CreateActionsOnPlayersInSegmentTask(
            request: PlayFabAdminModels.CreateActionsOnPlayerSegmentTaskRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CreateTaskResult> | null,
        ): void;
        // Create a CloudScript task, which can run a CloudScript on a schedule.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask
        CreateCloudScriptTask(
            request: PlayFabAdminModels.CreateCloudScriptTaskRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CreateTaskResult> | null,
        ): void;
        // Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask
        CreateInsightsScheduledScalingTask(
            request: PlayFabAdminModels.CreateInsightsScheduledScalingTaskRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CreateTaskResult> | null,
        ): void;
        // Registers a relationship between a title and an Open ID Connect provider.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection
        CreateOpenIdConnection(
            request: PlayFabAdminModels.CreateOpenIdConnectionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.EmptyResponse> | null,
        ): void;
        // Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after
        // this API returns.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret
        CreatePlayerSharedSecret(
            request: PlayFabAdminModels.CreatePlayerSharedSecretRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CreatePlayerSharedSecretResult> | null,
        ): void;
        // Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval
        // and an aggregation method.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition
        CreatePlayerStatisticDefinition(
            request: PlayFabAdminModels.CreatePlayerStatisticDefinitionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CreatePlayerStatisticDefinitionResult> | null,
        ): void;
        // Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player
        // segments for a title.
        // https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment
        CreateSegment(
            request: PlayFabAdminModels.CreateSegmentRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.CreateSegmentResponse> | null,
        ): void;
        // Delete a content file from the title. When deleting a file that does not exist, it returns success.
        // https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent
        DeleteContent(
            request: PlayFabAdminModels.DeleteContentRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.BlankResult> | null,
        ): void;
        // Removes a master player account entirely from all titles and deletes all associated data
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount
        DeleteMasterPlayerAccount(
            request: PlayFabAdminModels.DeleteMasterPlayerAccountRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteMasterPlayerAccountResult> | null,
        ): void;
        // Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata
        DeleteMasterPlayerEventData(
            request: PlayFabAdminModels.DeleteMasterPlayerEventDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteMasterPlayerEventDataResult> | null,
        ): void;
        // Deletes a player's subscription
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription
        DeleteMembershipSubscription(
            request: PlayFabAdminModels.DeleteMembershipSubscriptionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteMembershipSubscriptionResult> | null,
        ): void;
        // Removes a relationship between a title and an OpenID Connect provider.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection
        DeleteOpenIdConnection(
            request: PlayFabAdminModels.DeleteOpenIdConnectionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.EmptyResponse> | null,
        ): void;
        // Removes a user's player account from a title and deletes all associated data
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer
        DeletePlayer(
            request: PlayFabAdminModels.DeletePlayerRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeletePlayerResult> | null,
        ): void;
        // Deletes title-specific custom properties for a player
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties
        DeletePlayerCustomProperties(
            request: PlayFabAdminModels.DeletePlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeletePlayerCustomPropertiesResult> | null,
        ): void;
        // Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API
        // returns.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret
        DeletePlayerSharedSecret(
            request: PlayFabAdminModels.DeletePlayerSharedSecretRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeletePlayerSharedSecretResult> | null,
        ): void;
        // Deletes an existing player segment and its associated action(s) for a title.
        // https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment
        DeleteSegment(
            request: PlayFabAdminModels.DeleteSegmentRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteSegmentsResponse> | 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._ Deletes an existing virtual item store
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore
        DeleteStore(
            request: PlayFabAdminModels.DeleteStoreRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteStoreResult> | null,
        ): void;
        // Delete a task.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask
        DeleteTask(
            request: PlayFabAdminModels.DeleteTaskRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.EmptyResponse> | null,
        ): void;
        // Permanently deletes a title and all associated configuration
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle
        DeleteTitle(
            request: PlayFabAdminModels.DeleteTitleRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteTitleResult> | null,
        ): void;
        // Deletes a specified set of title data overrides.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride
        DeleteTitleDataOverride(
            request: PlayFabAdminModels.DeleteTitleDataOverrideRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.DeleteTitleDataOverrideResult> | null,
        ): void;
        // Exports all associated data of a master player account
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata
        ExportMasterPlayerData(
            request: PlayFabAdminModels.ExportMasterPlayerDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ExportMasterPlayerDataResult> | null,
        ): void;
        // Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which
        // match the segment definition at the time of the API call. Profiles which change while an export is in progress will not
        // be reflected in the results.
        // https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment
        ExportPlayersInSegment(
            request: PlayFabAdminModels.ExportPlayersInSegmentRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ExportPlayersInSegmentResult> | null,
        ): void;
        // Get information about a ActionsOnPlayersInSegment task instance.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance
        GetActionsOnPlayersInSegmentTaskInstance(
            request: PlayFabAdminModels.GetTaskInstanceRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetActionsOnPlayersInSegmentTaskInstanceResult> | 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/admin/playstream/getallsegments
        GetAllSegments(
            request: PlayFabAdminModels.GetAllSegmentsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetAllSegmentsResult> | 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/admin/title-wide-data-management/getcatalogitems
        GetCatalogItems(
            request: PlayFabAdminModels.GetCatalogItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetCatalogItemsResult> | null,
        ): void;
        // Gets the contents and information of a specific Cloud Script revision.
        // https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision
        GetCloudScriptRevision(
            request: PlayFabAdminModels.GetCloudScriptRevisionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetCloudScriptRevisionResult> | null,
        ): void;
        // Get detail information about a CloudScript task instance.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance
        GetCloudScriptTaskInstance(
            request: PlayFabAdminModels.GetTaskInstanceRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetCloudScriptTaskInstanceResult> | null,
        ): void;
        // Lists all the current cloud script versions. For each version, information about the current published and latest
        // revisions is also listed.
        // https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions
        GetCloudScriptVersions(
            request: PlayFabAdminModels.GetCloudScriptVersionsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetCloudScriptVersionsResult> | null,
        ): void;
        // List all contents of the title and get statistics such as size
        // https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist
        GetContentList(
            request: PlayFabAdminModels.GetContentListRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetContentListResult> | null,
        ): void;
        // Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the
        // content. 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/admin/content/getcontentuploadurl
        GetContentUploadUrl(
            request: PlayFabAdminModels.GetContentUploadUrlRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetContentUploadUrlResult> | null,
        ): void;
        // Retrieves a download URL for the requested report
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport
        GetDataReport(
            request: PlayFabAdminModels.GetDataReportRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetDataReportResult> | null,
        ): void;
        // Get the list of titles that the player has played
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist
        GetPlayedTitleList(
            request: PlayFabAdminModels.GetPlayedTitleListRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayedTitleListResult> | null,
        ): void;
        // Retrieves a title-specific custom property value for a player.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty
        GetPlayerCustomProperty(
            request: PlayFabAdminModels.GetPlayerCustomPropertyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerCustomPropertyResult> | null,
        ): void;
        // Gets a player's ID from an auth token.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken
        GetPlayerIdFromAuthToken(
            request: PlayFabAdminModels.GetPlayerIdFromAuthTokenRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerIdFromAuthTokenResult> | null,
        ): void;
        // Retrieves the player's profile
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile
        GetPlayerProfile(
            request: PlayFabAdminModels.GetPlayerProfileRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerProfileResult> | null,
        ): void;
        // List all segments that a player currently belongs to at this moment in time.
        // https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments
        GetPlayerSegments(
            request: PlayFabAdminModels.GetPlayersSegmentsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerSegmentsResult> | null,
        ): void;
        // Returns all Player Shared Secret Keys including disabled and expired.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets
        GetPlayerSharedSecrets(
            request: PlayFabAdminModels.GetPlayerSharedSecretsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerSharedSecretsResult> | 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/admin/playstream/getplayersinsegment
        GetPlayersInSegment(
            request: PlayFabAdminModels.GetPlayersInSegmentRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayersInSegmentResult> | null,
        ): void;
        // Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have
        // a reset interval.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions
        GetPlayerStatisticDefinitions(
            request: PlayFabAdminModels.GetPlayerStatisticDefinitionsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerStatisticDefinitionsResult> | null,
        ): void;
        // Retrieves the information on the available versions of the specified statistic.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions
        GetPlayerStatisticVersions(
            request: PlayFabAdminModels.GetPlayerStatisticVersionsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerStatisticVersionsResult> | null,
        ): void;
        // Get all tags with a given Namespace (optional) from a player profile.
        // https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags
        GetPlayerTags(
            request: PlayFabAdminModels.GetPlayerTagsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayerTagsResult> | null,
        ): void;
        // Gets the requested policy.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy
        GetPolicy(
            request: PlayFabAdminModels.GetPolicyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPolicyResponse> | null,
        ): void;
        // Retrieves the key-value store of custom publisher settings
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata
        GetPublisherData(
            request: PlayFabAdminModels.GetPublisherDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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 random drop table configuration for the title
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables
        GetRandomResultTables(
            request: PlayFabAdminModels.GetRandomResultTablesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetRandomResultTablesResult> | null,
        ): void;
        // Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and
        // complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls
        // from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of
        // the export
        // https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport
        GetSegmentExport(
            request: PlayFabAdminModels.GetPlayersInSegmentExportRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetPlayersInSegmentExportResponse> | null,
        ): void;
        // Get detail information of a segment and its associated definition(s) and action(s) for a title.
        // https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments
        GetSegments(
            request: PlayFabAdminModels.GetSegmentsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetSegmentsResponse> | 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/admin/title-wide-data-management/getstoreitems
        GetStoreItems(
            request: PlayFabAdminModels.GetStoreItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetStoreItemsResult> | null,
        ): void;
        // Query for task instances by task, status, or time range.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances
        GetTaskInstances(
            request: PlayFabAdminModels.GetTaskInstancesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetTaskInstancesResult> | null,
        ): void;
        // Get definition information on a specified task or all tasks within a title.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks
        GetTasks(
            request: PlayFabAdminModels.GetTasksRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetTasksResult> | null,
        ): void;
        // Retrieves the key-value store of custom title settings which can be read by the client
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata
        GetTitleData(
            request: PlayFabAdminModels.GetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetTitleDataResult> | null,
        ): void;
        // Retrieves the key-value store of custom title settings which cannot be read by the client
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata
        GetTitleInternalData(
            request: PlayFabAdminModels.GetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GetTitleDataResult> | null,
        ): void;
        // Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo
        GetUserAccountInfo(
            request: PlayFabAdminModels.LookupUserAccountInfoRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.LookupUserAccountInfoResult> | null,
        ): void;
        // Gets all bans for a user.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans
        GetUserBans(
            request: PlayFabAdminModels.GetUserBansRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-data-management/getuserdata
        GetUserData(
            request: PlayFabAdminModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-data-management/getuserinternaldata
        GetUserInternalData(
            request: PlayFabAdminModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-item-management/getuserinventory
        GetUserInventory(
            request: PlayFabAdminModels.GetUserInventoryRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-data-management/getuserpublisherdata
        GetUserPublisherData(
            request: PlayFabAdminModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-data-management/getuserpublisherinternaldata
        GetUserPublisherInternalData(
            request: PlayFabAdminModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-data-management/getuserpublisherreadonlydata
        GetUserPublisherReadOnlyData(
            request: PlayFabAdminModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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/admin/player-data-management/getuserreadonlydata
        GetUserReadOnlyData(
            request: PlayFabAdminModels.GetUserDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.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._ Adds the specified items to the specified user inventories
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers
        GrantItemsToUsers(
            request: PlayFabAdminModels.GrantItemsToUsersRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.GrantItemsToUsersResult> | 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._ Increases the global count for the given scarce resource.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability
        IncrementLimitedEditionItemAvailability(
            request: PlayFabAdminModels.IncrementLimitedEditionItemAvailabilityRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.IncrementLimitedEditionItemAvailabilityResult> | null,
        ): void;
        // Resets the indicated statistic, removing all player entries for it and backing up the old values.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion
        IncrementPlayerStatisticVersion(
            request: PlayFabAdminModels.IncrementPlayerStatisticVersionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.IncrementPlayerStatisticVersionResult> | null,
        ): void;
        // Retrieves a list of all Open ID Connect providers registered to a title.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection
        ListOpenIdConnection(
            request: PlayFabAdminModels.ListOpenIdConnectionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ListOpenIdConnectionResponse> | null,
        ): void;
        // Retrieves title-specific custom property values for a player.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties
        ListPlayerCustomProperties(
            request: PlayFabAdminModels.ListPlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ListPlayerCustomPropertiesResult> | 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._ Retuns the list of all defined virtual currencies for the title
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes
        ListVirtualCurrencyTypes(
            request: PlayFabAdminModels.ListVirtualCurrencyTypesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ListVirtualCurrencyTypesResult> | 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._ Attempts to process an order refund through the original real money payment provider.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase
        RefundPurchase(
            request: PlayFabAdminModels.RefundPurchaseRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RefundPurchaseResponse> | null,
        ): void;
        // Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
        // https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag
        RemovePlayerTag(
            request: PlayFabAdminModels.RemovePlayerTagRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RemovePlayerTagResult> | 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._ Removes one or more virtual currencies from the set defined for the title.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes
        RemoveVirtualCurrencyTypes(
            request: PlayFabAdminModels.RemoveVirtualCurrencyTypesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.BlankResult> | null,
        ): void;
        // Completely removes all statistics for the specified character, for the current game
        // https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics
        ResetCharacterStatistics(
            request: PlayFabAdminModels.ResetCharacterStatisticsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ResetCharacterStatisticsResult> | null,
        ): void;
        // Reset a player's password for a given title.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword
        ResetPassword(
            request: PlayFabAdminModels.ResetPasswordRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ResetPasswordResult> | null,
        ): void;
        // Completely removes all statistics for the specified user, for the current game
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics
        ResetUserStatistics(
            request: PlayFabAdminModels.ResetUserStatisticsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ResetUserStatisticsResult> | 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._ Attempts to resolve a dispute with the original order's payment provider.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute
        ResolvePurchaseDispute(
            request: PlayFabAdminModels.ResolvePurchaseDisputeRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ResolvePurchaseDisputeResponse> | null,
        ): void;
        // Revoke all active bans for a user.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser
        RevokeAllBansForUser(
            request: PlayFabAdminModels.RevokeAllBansForUserRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RevokeAllBansForUserResult> | null,
        ): void;
        // Revoke all active bans specified with BanId.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans
        RevokeBans(
            request: PlayFabAdminModels.RevokeBansRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RevokeBansResult> | 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._ Revokes access to an item in a user's inventory
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem
        RevokeInventoryItem(
            request: PlayFabAdminModels.RevokeInventoryItemRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RevokeInventoryResult> | 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._ Revokes access for up to 25 items across multiple users and characters.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems
        RevokeInventoryItems(
            request: PlayFabAdminModels.RevokeInventoryItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RevokeInventoryItemsResult> | null,
        ): void;
        // Run a task immediately regardless of its schedule.
        // https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask
        RunTask(
            request: PlayFabAdminModels.RunTaskRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.RunTaskResult> | null,
        ): void;
        // Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
        // change the password.If an account recovery email template ID is provided, an email using the custom email template will
        // be used.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail
        SendAccountRecoveryEmail(
            request: PlayFabAdminModels.SendAccountRecoveryEmailRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SendAccountRecoveryEmailResult> | 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._ Creates the catalog configuration of all virtual goods for the specified catalog version
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems
        SetCatalogItems(
            request: PlayFabAdminModels.UpdateCatalogItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdateCatalogItemsResult> | null,
        ): void;
        // Sets the override expiration for a membership subscription
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride
        SetMembershipOverride(
            request: PlayFabAdminModels.SetMembershipOverrideRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetMembershipOverrideResult> | null,
        ): void;
        // Sets or resets the player's secret. Player secrets are used to sign API requests.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret
        SetPlayerSecret(
            request: PlayFabAdminModels.SetPlayerSecretRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetPlayerSecretResult> | null,
        ): void;
        // Sets the currently published revision of a title Cloud Script
        // https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision
        SetPublishedRevision(
            request: PlayFabAdminModels.SetPublishedRevisionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetPublishedRevisionResult> | null,
        ): void;
        // Updates the key-value store of custom publisher settings
        // https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata
        SetPublisherData(
            request: PlayFabAdminModels.SetPublisherDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetPublisherDataResult> | 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._ Sets all the items in one virtual store
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems
        SetStoreItems(
            request: PlayFabAdminModels.UpdateStoreItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdateStoreItemsResult> | null,
        ): void;
        // Creates and updates the key-value store of custom title settings which can be read by the client. For example, a
        // developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
        // movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
        // build.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata
        SetTitleData(
            request: PlayFabAdminModels.SetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetTitleDataResult> | null,
        ): void;
        // Set and delete key-value pairs in a title data override instance.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides
        SetTitleDataAndOverrides(
            request: PlayFabAdminModels.SetTitleDataAndOverridesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetTitleDataAndOverridesResult> | null,
        ): void;
        // Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
        // tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata
        SetTitleInternalData(
            request: PlayFabAdminModels.SetTitleDataRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetTitleDataResult> | null,
        ): void;
        // Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can
        // be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device
        // Messaging is not supported.
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification
        SetupPushNotification(
            request: PlayFabAdminModels.SetupPushNotificationRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.SetupPushNotificationResult> | 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._ Decrements the specified virtual currency by the stated amount
        // https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency
        SubtractUserVirtualCurrency(
            request: PlayFabAdminModels.SubtractUserVirtualCurrencyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.ModifyUserVirtualCurrencyResult> | null,
        ): void;
        // Updates information of a list of existing bans specified with Ban Ids.
        // https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans
        UpdateBans(
            request: PlayFabAdminModels.UpdateBansRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdateBansResult> | 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._ Updates the catalog configuration for virtual goods in the specified catalog version
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems
        UpdateCatalogItems(
            request: PlayFabAdminModels.UpdateCatalogItemsRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdateCatalogItemsResult> | null,
        ): void;
        // Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be
        // submitted in the revision.
        // https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript
        UpdateCloudScript(
            request: PlayFabAdminModels.UpdateCloudScriptRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdateCloudScriptResult> | null,
        ): void;
        // Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection
        UpdateOpenIdConnection(
            request: PlayFabAdminModels.UpdateOpenIdConnectionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.EmptyResponse> | null,
        ): void;
        // Updates the title-specific custom property values for a player
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties
        UpdatePlayerCustomProperties(
            request: PlayFabAdminModels.UpdatePlayerCustomPropertiesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdatePlayerCustomPropertiesResult> | null,
        ): void;
        // Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available
        // after this API returns.
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret
        UpdatePlayerSharedSecret(
            request: PlayFabAdminModels.UpdatePlayerSharedSecretRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdatePlayerSharedSecretResult> | null,
        ): void;
        // Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
        // https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition
        UpdatePlayerStatisticDefinition(
            request: PlayFabAdminModels.UpdatePlayerStatisticDefinitionRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdatePlayerStatisticDefinitionResult> | null,
        ): void;
        // Changes a policy for a title
        // https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy
        UpdatePolicy(
            request: PlayFabAdminModels.UpdatePolicyRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdatePolicyResponse> | 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._ Updates the random drop table configuration for the title
        // https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables
        UpdateRandomResultTables(
            request: PlayFabAdminModels.UpdateRandomResultTablesRequest | null,
            callback: PlayFabModule.ApiCallback<PlayFabAdminModels.UpdateRandomResultTablesResult> | null,
        ): void;
        // Updates an existing player segment and its associated definition(s) and action(s) for a title.