async-playfab-web-sdk 1.192.250526-2 → 1.192.250526-3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Addon.d.ts +31 -31
- package/dist/Addon.js +2 -2
- package/dist/Admin.d.ts +118 -118
- package/dist/Admin.js +2 -2
- package/dist/Authentication.d.ts +5 -5
- package/dist/Authentication.js +2 -2
- package/dist/Client.d.ts +174 -174
- package/dist/Client.js +2 -2
- package/dist/CloudScript.d.ts +16 -16
- package/dist/CloudScript.js +2 -2
- package/dist/Data.d.ts +8 -8
- package/dist/Data.js +2 -2
- package/dist/Economy.d.ts +47 -47
- package/dist/Economy.js +2 -2
- package/dist/Events.d.ts +13 -13
- package/dist/Events.js +2 -2
- package/dist/Experimentation.d.ts +14 -14
- package/dist/Experimentation.js +2 -2
- package/dist/Groups.d.ts +26 -26
- package/dist/Groups.js +2 -2
- package/dist/Insights.d.ts +7 -7
- package/dist/Insights.js +2 -2
- package/dist/Localization.d.ts +2 -2
- package/dist/Localization.js +2 -2
- package/dist/Multiplayer.d.ts +88 -88
- package/dist/Multiplayer.js +2 -2
- package/dist/{PlayFabCommon-BUv4zqXf.d.ts → PlayFabCommon-BX3jSqGx.d.ts} +4 -6
- package/dist/Profiles.d.ts +10 -10
- package/dist/Profiles.js +2 -2
- package/dist/Progression.d.ts +24 -24
- package/dist/Progression.js +2 -2
- package/dist/Server.d.ts +150 -150
- package/dist/Server.js +2 -2
- package/dist/{chunk-CDBIRT6V.js → chunk-3FCAP7OZ.js} +52 -52
- package/dist/chunk-3FCAP7OZ.js.map +1 -0
- package/dist/{chunk-CY3H2GBI.js → chunk-62SULWOK.js} +25 -69
- package/dist/chunk-62SULWOK.js.map +1 -0
- package/dist/{chunk-ZY56RXKC.js → chunk-A7VD6ALV.js} +62 -62
- package/dist/chunk-A7VD6ALV.js.map +1 -0
- package/dist/{chunk-2NRPVFSH.js → chunk-BX65UND2.js} +176 -176
- package/dist/chunk-BX65UND2.js.map +1 -0
- package/dist/{chunk-D53KEX67.js → chunk-J4QS5VX5.js} +4 -4
- package/dist/chunk-J4QS5VX5.js.map +1 -0
- package/dist/{chunk-QCCQJDCR.js → chunk-JGDO2ZE3.js} +348 -348
- package/dist/chunk-JGDO2ZE3.js.map +1 -0
- package/dist/{chunk-7VP4SIOQ.js → chunk-POMI7LEF.js} +20 -20
- package/dist/chunk-POMI7LEF.js.map +1 -0
- package/dist/{chunk-JRE75IDS.js → chunk-Q3OF3AOJ.js} +26 -26
- package/dist/chunk-Q3OF3AOJ.js.map +1 -0
- package/dist/{chunk-EY77H23H.js → chunk-QUZHVSVZ.js} +48 -48
- package/dist/chunk-QUZHVSVZ.js.map +1 -0
- package/dist/{chunk-BZECCU2H.js → chunk-QVLIVSO4.js} +300 -300
- package/dist/chunk-QVLIVSO4.js.map +1 -0
- package/dist/{chunk-42AWSTMK.js → chunk-R7V7DFCF.js} +28 -28
- package/dist/chunk-R7V7DFCF.js.map +1 -0
- package/dist/{chunk-RODJAJP2.js → chunk-SGSEOIKS.js} +14 -14
- package/dist/chunk-SGSEOIKS.js.map +1 -0
- package/dist/{chunk-5AAYYQU7.js → chunk-UOHHNVCJ.js} +32 -32
- package/dist/chunk-UOHHNVCJ.js.map +1 -0
- package/dist/{chunk-RHQFG2EP.js → chunk-USKFWNQK.js} +94 -94
- package/dist/chunk-USKFWNQK.js.map +1 -0
- package/dist/{chunk-VTCQRNBL.js → chunk-UX7LFJCX.js} +16 -16
- package/dist/chunk-UX7LFJCX.js.map +1 -0
- package/dist/{chunk-V56QSAWL.js → chunk-X34XZJB6.js} +10 -10
- package/dist/chunk-X34XZJB6.js.map +1 -0
- package/dist/{chunk-FPCXHDA7.js → chunk-YNZF3WXS.js} +236 -236
- package/dist/chunk-YNZF3WXS.js.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +17 -17
- package/package.json +1 -1
- package/dist/chunk-2NRPVFSH.js.map +0 -1
- package/dist/chunk-42AWSTMK.js.map +0 -1
- package/dist/chunk-5AAYYQU7.js.map +0 -1
- package/dist/chunk-7VP4SIOQ.js.map +0 -1
- package/dist/chunk-BZECCU2H.js.map +0 -1
- package/dist/chunk-CDBIRT6V.js.map +0 -1
- package/dist/chunk-CY3H2GBI.js.map +0 -1
- package/dist/chunk-D53KEX67.js.map +0 -1
- package/dist/chunk-EY77H23H.js.map +0 -1
- package/dist/chunk-FPCXHDA7.js.map +0 -1
- package/dist/chunk-JRE75IDS.js.map +0 -1
- package/dist/chunk-QCCQJDCR.js.map +0 -1
- package/dist/chunk-RHQFG2EP.js.map +0 -1
- package/dist/chunk-RODJAJP2.js.map +0 -1
- package/dist/chunk-V56QSAWL.js.map +0 -1
- package/dist/chunk-VTCQRNBL.js.map +0 -1
- package/dist/chunk-ZY56RXKC.js.map +0 -1
package/dist/Admin.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-
|
1
|
+
import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BX3jSqGx.js';
|
2
2
|
|
3
3
|
interface AbortTaskInstanceRequest extends IPlayFabRequestCommon {
|
4
4
|
/** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
|
@@ -2847,243 +2847,243 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
2847
2847
|
* Abort an ongoing task instance.
|
2848
2848
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance
|
2849
2849
|
*/
|
2850
|
-
AbortTaskInstance(request: AbortTaskInstanceRequest,
|
2850
|
+
AbortTaskInstance(request: AbortTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2851
2851
|
/**
|
2852
2852
|
* Update news item to include localized version
|
2853
2853
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews
|
2854
2854
|
*/
|
2855
|
-
AddLocalizedNews(request: AddLocalizedNewsRequest,
|
2855
|
+
AddLocalizedNews(request: AddLocalizedNewsRequest, extraHeaders?: Record<string, string>): Promise<AddLocalizedNewsResult>;
|
2856
2856
|
/**
|
2857
2857
|
* Adds a new news item to the title's news feed
|
2858
2858
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews
|
2859
2859
|
*/
|
2860
|
-
AddNews(request: AddNewsRequest,
|
2860
|
+
AddNews(request: AddNewsRequest, extraHeaders?: Record<string, string>): Promise<AddNewsResult>;
|
2861
2861
|
/**
|
2862
2862
|
* Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
2863
2863
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/addplayertag
|
2864
2864
|
*/
|
2865
|
-
AddPlayerTag(request: AddPlayerTagRequest,
|
2865
|
+
AddPlayerTag(request: AddPlayerTagRequest, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
|
2866
2866
|
/**
|
2867
2867
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2868
2868
|
* version 2._ Increments the specified virtual currency by the stated amount
|
2869
2869
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency
|
2870
2870
|
*/
|
2871
|
-
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest,
|
2871
|
+
AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
2872
2872
|
/**
|
2873
2873
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2874
2874
|
* version 2._ Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum
|
2875
2875
|
* value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
|
2876
2876
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes
|
2877
2877
|
*/
|
2878
|
-
AddVirtualCurrencyTypes(request: AddVirtualCurrencyTypesRequest,
|
2878
|
+
AddVirtualCurrencyTypes(request: AddVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
2879
2879
|
/**
|
2880
2880
|
* Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
|
2881
2881
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers
|
2882
2882
|
*/
|
2883
|
-
BanUsers(request: BanUsersRequest,
|
2883
|
+
BanUsers(request: BanUsersRequest, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
|
2884
2884
|
/**
|
2885
2885
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2886
2886
|
* version 2._ Checks the global count for the limited edition item.
|
2887
2887
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability
|
2888
2888
|
*/
|
2889
|
-
CheckLimitedEditionItemAvailability(request: CheckLimitedEditionItemAvailabilityRequest,
|
2889
|
+
CheckLimitedEditionItemAvailability(request: CheckLimitedEditionItemAvailabilityRequest, extraHeaders?: Record<string, string>): Promise<CheckLimitedEditionItemAvailabilityResult>;
|
2890
2890
|
/**
|
2891
2891
|
* Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
|
2892
2892
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask
|
2893
2893
|
*/
|
2894
|
-
CreateActionsOnPlayersInSegmentTask(request: CreateActionsOnPlayerSegmentTaskRequest,
|
2894
|
+
CreateActionsOnPlayersInSegmentTask(request: CreateActionsOnPlayerSegmentTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
2895
2895
|
/**
|
2896
2896
|
* Create a CloudScript task, which can run a CloudScript on a schedule.
|
2897
2897
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask
|
2898
2898
|
*/
|
2899
|
-
CreateCloudScriptTask(request: CreateCloudScriptTaskRequest,
|
2899
|
+
CreateCloudScriptTask(request: CreateCloudScriptTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
2900
2900
|
/**
|
2901
2901
|
* Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
|
2902
2902
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask
|
2903
2903
|
*/
|
2904
|
-
CreateInsightsScheduledScalingTask(request: CreateInsightsScheduledScalingTaskRequest,
|
2904
|
+
CreateInsightsScheduledScalingTask(request: CreateInsightsScheduledScalingTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
|
2905
2905
|
/**
|
2906
2906
|
* Registers a relationship between a title and an Open ID Connect provider.
|
2907
2907
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection
|
2908
2908
|
*/
|
2909
|
-
CreateOpenIdConnection(request: CreateOpenIdConnectionRequest,
|
2909
|
+
CreateOpenIdConnection(request: CreateOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2910
2910
|
/**
|
2911
2911
|
* Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after
|
2912
2912
|
* this API returns.
|
2913
2913
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret
|
2914
2914
|
*/
|
2915
|
-
CreatePlayerSharedSecret(request: CreatePlayerSharedSecretRequest,
|
2915
|
+
CreatePlayerSharedSecret(request: CreatePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<CreatePlayerSharedSecretResult>;
|
2916
2916
|
/**
|
2917
2917
|
* Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval
|
2918
2918
|
* and an aggregation method.
|
2919
2919
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition
|
2920
2920
|
*/
|
2921
|
-
CreatePlayerStatisticDefinition(request: CreatePlayerStatisticDefinitionRequest,
|
2921
|
+
CreatePlayerStatisticDefinition(request: CreatePlayerStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<CreatePlayerStatisticDefinitionResult>;
|
2922
2922
|
/**
|
2923
2923
|
* Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player
|
2924
2924
|
* segments for a title.
|
2925
2925
|
* https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment
|
2926
2926
|
*/
|
2927
|
-
CreateSegment(request: CreateSegmentRequest,
|
2927
|
+
CreateSegment(request: CreateSegmentRequest, extraHeaders?: Record<string, string>): Promise<CreateSegmentResponse>;
|
2928
2928
|
/**
|
2929
2929
|
* Delete a content file from the title. When deleting a file that does not exist, it returns success.
|
2930
2930
|
* https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent
|
2931
2931
|
*/
|
2932
|
-
DeleteContent(request: DeleteContentRequest,
|
2932
|
+
DeleteContent(request: DeleteContentRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
2933
2933
|
/**
|
2934
2934
|
* Removes a master player account entirely from all titles and deletes all associated data
|
2935
2935
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount
|
2936
2936
|
*/
|
2937
|
-
DeleteMasterPlayerAccount(request: DeleteMasterPlayerAccountRequest,
|
2937
|
+
DeleteMasterPlayerAccount(request: DeleteMasterPlayerAccountRequest, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerAccountResult>;
|
2938
2938
|
/**
|
2939
2939
|
* Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
|
2940
2940
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata
|
2941
2941
|
*/
|
2942
|
-
DeleteMasterPlayerEventData(request: DeleteMasterPlayerEventDataRequest,
|
2942
|
+
DeleteMasterPlayerEventData(request: DeleteMasterPlayerEventDataRequest, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerEventDataResult>;
|
2943
2943
|
/**
|
2944
2944
|
* Deletes a player's subscription
|
2945
2945
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription
|
2946
2946
|
*/
|
2947
|
-
DeleteMembershipSubscription(request: DeleteMembershipSubscriptionRequest,
|
2947
|
+
DeleteMembershipSubscription(request: DeleteMembershipSubscriptionRequest, extraHeaders?: Record<string, string>): Promise<DeleteMembershipSubscriptionResult>;
|
2948
2948
|
/**
|
2949
2949
|
* Removes a relationship between a title and an OpenID Connect provider.
|
2950
2950
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection
|
2951
2951
|
*/
|
2952
|
-
DeleteOpenIdConnection(request: DeleteOpenIdConnectionRequest,
|
2952
|
+
DeleteOpenIdConnection(request: DeleteOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2953
2953
|
/**
|
2954
2954
|
* Removes a user's player account from a title and deletes all associated data
|
2955
2955
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer
|
2956
2956
|
*/
|
2957
|
-
DeletePlayer(request: DeletePlayerRequest,
|
2957
|
+
DeletePlayer(request: DeletePlayerRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
|
2958
2958
|
/**
|
2959
2959
|
* Deletes title-specific custom properties for a player
|
2960
2960
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties
|
2961
2961
|
*/
|
2962
|
-
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest,
|
2962
|
+
DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
|
2963
2963
|
/**
|
2964
2964
|
* Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API
|
2965
2965
|
* returns.
|
2966
2966
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret
|
2967
2967
|
*/
|
2968
|
-
DeletePlayerSharedSecret(request: DeletePlayerSharedSecretRequest,
|
2968
|
+
DeletePlayerSharedSecret(request: DeletePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerSharedSecretResult>;
|
2969
2969
|
/**
|
2970
2970
|
* Deletes an existing player segment and its associated action(s) for a title.
|
2971
2971
|
* https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment
|
2972
2972
|
*/
|
2973
|
-
DeleteSegment(request: DeleteSegmentRequest,
|
2973
|
+
DeleteSegment(request: DeleteSegmentRequest, extraHeaders?: Record<string, string>): Promise<DeleteSegmentsResponse>;
|
2974
2974
|
/**
|
2975
2975
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
2976
2976
|
* version 2._ Deletes an existing virtual item store
|
2977
2977
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore
|
2978
2978
|
*/
|
2979
|
-
DeleteStore(request: DeleteStoreRequest,
|
2979
|
+
DeleteStore(request: DeleteStoreRequest, extraHeaders?: Record<string, string>): Promise<DeleteStoreResult>;
|
2980
2980
|
/**
|
2981
2981
|
* Delete a task.
|
2982
2982
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask
|
2983
2983
|
*/
|
2984
|
-
DeleteTask(request: DeleteTaskRequest,
|
2984
|
+
DeleteTask(request: DeleteTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
2985
2985
|
/**
|
2986
2986
|
* Permanently deletes a title and all associated configuration
|
2987
2987
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle
|
2988
2988
|
*/
|
2989
|
-
DeleteTitle(request: DeleteTitleRequest,
|
2989
|
+
DeleteTitle(request: DeleteTitleRequest, extraHeaders?: Record<string, string>): Promise<DeleteTitleResult>;
|
2990
2990
|
/**
|
2991
2991
|
* Deletes a specified set of title data overrides.
|
2992
2992
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride
|
2993
2993
|
*/
|
2994
|
-
DeleteTitleDataOverride(request: DeleteTitleDataOverrideRequest,
|
2994
|
+
DeleteTitleDataOverride(request: DeleteTitleDataOverrideRequest, extraHeaders?: Record<string, string>): Promise<DeleteTitleDataOverrideResult>;
|
2995
2995
|
/**
|
2996
2996
|
* Exports all associated data of a master player account
|
2997
2997
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata
|
2998
2998
|
*/
|
2999
|
-
ExportMasterPlayerData(request: ExportMasterPlayerDataRequest,
|
2999
|
+
ExportMasterPlayerData(request: ExportMasterPlayerDataRequest, extraHeaders?: Record<string, string>): Promise<ExportMasterPlayerDataResult>;
|
3000
3000
|
/**
|
3001
3001
|
* Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which
|
3002
3002
|
* match the segment definition at the time of the API call. Profiles which change while an export is in progress will not
|
3003
3003
|
* be reflected in the results.
|
3004
3004
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment
|
3005
3005
|
*/
|
3006
|
-
ExportPlayersInSegment(request: ExportPlayersInSegmentRequest,
|
3006
|
+
ExportPlayersInSegment(request: ExportPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<ExportPlayersInSegmentResult>;
|
3007
3007
|
/**
|
3008
3008
|
* Get information about a ActionsOnPlayersInSegment task instance.
|
3009
3009
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance
|
3010
3010
|
*/
|
3011
|
-
GetActionsOnPlayersInSegmentTaskInstance(request: GetTaskInstanceRequest,
|
3011
|
+
GetActionsOnPlayersInSegmentTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetActionsOnPlayersInSegmentTaskInstanceResult>;
|
3012
3012
|
/**
|
3013
3013
|
* Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
|
3014
3014
|
* GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
|
3015
3015
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments
|
3016
3016
|
*/
|
3017
|
-
GetAllSegments(request: GetAllSegmentsRequest,
|
3017
|
+
GetAllSegments(request: GetAllSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
|
3018
3018
|
/**
|
3019
3019
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3020
3020
|
* version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
|
3021
3021
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getcatalogitems
|
3022
3022
|
*/
|
3023
|
-
GetCatalogItems(request: GetCatalogItemsRequest,
|
3023
|
+
GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
|
3024
3024
|
/**
|
3025
3025
|
* Gets the contents and information of a specific Cloud Script revision.
|
3026
3026
|
* https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision
|
3027
3027
|
*/
|
3028
|
-
GetCloudScriptRevision(request: GetCloudScriptRevisionRequest,
|
3028
|
+
GetCloudScriptRevision(request: GetCloudScriptRevisionRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptRevisionResult>;
|
3029
3029
|
/**
|
3030
3030
|
* Get detail information about a CloudScript task instance.
|
3031
3031
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance
|
3032
3032
|
*/
|
3033
|
-
GetCloudScriptTaskInstance(request: GetTaskInstanceRequest,
|
3033
|
+
GetCloudScriptTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptTaskInstanceResult>;
|
3034
3034
|
/**
|
3035
3035
|
* Lists all the current cloud script versions. For each version, information about the current published and latest
|
3036
3036
|
* revisions is also listed.
|
3037
3037
|
* https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions
|
3038
3038
|
*/
|
3039
|
-
GetCloudScriptVersions(request: GetCloudScriptVersionsRequest,
|
3039
|
+
GetCloudScriptVersions(request: GetCloudScriptVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptVersionsResult>;
|
3040
3040
|
/**
|
3041
3041
|
* List all contents of the title and get statistics such as size
|
3042
3042
|
* https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist
|
3043
3043
|
*/
|
3044
|
-
GetContentList(request: GetContentListRequest,
|
3044
|
+
GetContentList(request: GetContentListRequest, extraHeaders?: Record<string, string>): Promise<GetContentListResult>;
|
3045
3045
|
/**
|
3046
3046
|
* Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the
|
3047
3047
|
* content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN
|
3048
3048
|
* rates apply.
|
3049
3049
|
* https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentuploadurl
|
3050
3050
|
*/
|
3051
|
-
GetContentUploadUrl(request: GetContentUploadUrlRequest,
|
3051
|
+
GetContentUploadUrl(request: GetContentUploadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentUploadUrlResult>;
|
3052
3052
|
/**
|
3053
3053
|
* Retrieves a download URL for the requested report
|
3054
3054
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport
|
3055
3055
|
*/
|
3056
|
-
GetDataReport(request: GetDataReportRequest,
|
3056
|
+
GetDataReport(request: GetDataReportRequest, extraHeaders?: Record<string, string>): Promise<GetDataReportResult>;
|
3057
3057
|
/**
|
3058
3058
|
* Get the list of titles that the player has played
|
3059
3059
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist
|
3060
3060
|
*/
|
3061
|
-
GetPlayedTitleList(request: GetPlayedTitleListRequest,
|
3061
|
+
GetPlayedTitleList(request: GetPlayedTitleListRequest, extraHeaders?: Record<string, string>): Promise<GetPlayedTitleListResult>;
|
3062
3062
|
/**
|
3063
3063
|
* Retrieves a title-specific custom property value for a player.
|
3064
3064
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty
|
3065
3065
|
*/
|
3066
|
-
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest,
|
3066
|
+
GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
|
3067
3067
|
/**
|
3068
3068
|
* Gets a player's ID from an auth token.
|
3069
3069
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken
|
3070
3070
|
*/
|
3071
|
-
GetPlayerIdFromAuthToken(request: GetPlayerIdFromAuthTokenRequest,
|
3071
|
+
GetPlayerIdFromAuthToken(request: GetPlayerIdFromAuthTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerIdFromAuthTokenResult>;
|
3072
3072
|
/**
|
3073
3073
|
* Retrieves the player's profile
|
3074
3074
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile
|
3075
3075
|
*/
|
3076
|
-
GetPlayerProfile(request: GetPlayerProfileRequest,
|
3076
|
+
GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
|
3077
3077
|
/**
|
3078
3078
|
* List all segments that a player currently belongs to at this moment in time.
|
3079
3079
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments
|
3080
3080
|
*/
|
3081
|
-
GetPlayerSegments(request: GetPlayersSegmentsRequest,
|
3081
|
+
GetPlayerSegments(request: GetPlayersSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
|
3082
3082
|
/**
|
3083
3083
|
* Returns all Player Shared Secret Keys including disabled and expired.
|
3084
3084
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets
|
3085
3085
|
*/
|
3086
|
-
GetPlayerSharedSecrets(request: GetPlayerSharedSecretsRequest,
|
3086
|
+
GetPlayerSharedSecrets(request: GetPlayerSharedSecretsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSharedSecretsResult>;
|
3087
3087
|
/**
|
3088
3088
|
* Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
|
3089
3089
|
* the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
|
@@ -3092,39 +3092,39 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
3092
3092
|
* called 30 times in one minute. You will be returned an error if you exceed this threshold.
|
3093
3093
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment
|
3094
3094
|
*/
|
3095
|
-
GetPlayersInSegment(request: GetPlayersInSegmentRequest,
|
3095
|
+
GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
|
3096
3096
|
/**
|
3097
3097
|
* Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have
|
3098
3098
|
* a reset interval.
|
3099
3099
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions
|
3100
3100
|
*/
|
3101
|
-
GetPlayerStatisticDefinitions(request: GetPlayerStatisticDefinitionsRequest,
|
3101
|
+
GetPlayerStatisticDefinitions(request: GetPlayerStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticDefinitionsResult>;
|
3102
3102
|
/**
|
3103
3103
|
* Retrieves the information on the available versions of the specified statistic.
|
3104
3104
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions
|
3105
3105
|
*/
|
3106
|
-
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest,
|
3106
|
+
GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
|
3107
3107
|
/**
|
3108
3108
|
* Get all tags with a given Namespace (optional) from a player profile.
|
3109
3109
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags
|
3110
3110
|
*/
|
3111
|
-
GetPlayerTags(request: GetPlayerTagsRequest,
|
3111
|
+
GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
|
3112
3112
|
/**
|
3113
3113
|
* Gets the requested policy.
|
3114
3114
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy
|
3115
3115
|
*/
|
3116
|
-
GetPolicy(request: GetPolicyRequest,
|
3116
|
+
GetPolicy(request: GetPolicyRequest, extraHeaders?: Record<string, string>): Promise<GetPolicyResponse>;
|
3117
3117
|
/**
|
3118
3118
|
* Retrieves the key-value store of custom publisher settings
|
3119
3119
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata
|
3120
3120
|
*/
|
3121
|
-
GetPublisherData(request: GetPublisherDataRequest,
|
3121
|
+
GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
|
3122
3122
|
/**
|
3123
3123
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3124
3124
|
* version 2._ Retrieves the random drop table configuration for the title
|
3125
3125
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables
|
3126
3126
|
*/
|
3127
|
-
GetRandomResultTables(request: GetRandomResultTablesRequest,
|
3127
|
+
GetRandomResultTables(request: GetRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
|
3128
3128
|
/**
|
3129
3129
|
* Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and
|
3130
3130
|
* complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls
|
@@ -3132,221 +3132,221 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
3132
3132
|
* the export
|
3133
3133
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport
|
3134
3134
|
*/
|
3135
|
-
GetSegmentExport(request: GetPlayersInSegmentExportRequest,
|
3135
|
+
GetSegmentExport(request: GetPlayersInSegmentExportRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentExportResponse>;
|
3136
3136
|
/**
|
3137
3137
|
* Get detail information of a segment and its associated definition(s) and action(s) for a title.
|
3138
3138
|
* https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments
|
3139
3139
|
*/
|
3140
|
-
GetSegments(request: GetSegmentsRequest,
|
3140
|
+
GetSegments(request: GetSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetSegmentsResponse>;
|
3141
3141
|
/**
|
3142
3142
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3143
3143
|
* version 2._ Retrieves the set of items defined for the specified store, including all prices defined
|
3144
3144
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems
|
3145
3145
|
*/
|
3146
|
-
GetStoreItems(request: GetStoreItemsRequest,
|
3146
|
+
GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
|
3147
3147
|
/**
|
3148
3148
|
* Query for task instances by task, status, or time range.
|
3149
3149
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances
|
3150
3150
|
*/
|
3151
|
-
GetTaskInstances(request: GetTaskInstancesRequest,
|
3151
|
+
GetTaskInstances(request: GetTaskInstancesRequest, extraHeaders?: Record<string, string>): Promise<GetTaskInstancesResult>;
|
3152
3152
|
/**
|
3153
3153
|
* Get definition information on a specified task or all tasks within a title.
|
3154
3154
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks
|
3155
3155
|
*/
|
3156
|
-
GetTasks(request: GetTasksRequest,
|
3156
|
+
GetTasks(request: GetTasksRequest, extraHeaders?: Record<string, string>): Promise<GetTasksResult>;
|
3157
3157
|
/**
|
3158
3158
|
* Retrieves the key-value store of custom title settings which can be read by the client
|
3159
3159
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata
|
3160
3160
|
*/
|
3161
|
-
GetTitleData(request: GetTitleDataRequest,
|
3161
|
+
GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3162
3162
|
/**
|
3163
3163
|
* Retrieves the key-value store of custom title settings which cannot be read by the client
|
3164
3164
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata
|
3165
3165
|
*/
|
3166
|
-
GetTitleInternalData(request: GetTitleDataRequest,
|
3166
|
+
GetTitleInternalData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
|
3167
3167
|
/**
|
3168
3168
|
* Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
|
3169
3169
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo
|
3170
3170
|
*/
|
3171
|
-
GetUserAccountInfo(request: LookupUserAccountInfoRequest,
|
3171
|
+
GetUserAccountInfo(request: LookupUserAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<LookupUserAccountInfoResult>;
|
3172
3172
|
/**
|
3173
3173
|
* Gets all bans for a user.
|
3174
3174
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans
|
3175
3175
|
*/
|
3176
|
-
GetUserBans(request: GetUserBansRequest,
|
3176
|
+
GetUserBans(request: GetUserBansRequest, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
|
3177
3177
|
/**
|
3178
3178
|
* Retrieves the title-specific custom data for the user which is readable and writable by the client
|
3179
3179
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserdata
|
3180
3180
|
*/
|
3181
|
-
GetUserData(request: GetUserDataRequest,
|
3181
|
+
GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3182
3182
|
/**
|
3183
3183
|
* Retrieves the title-specific custom data for the user which cannot be accessed by the client
|
3184
3184
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserinternaldata
|
3185
3185
|
*/
|
3186
|
-
GetUserInternalData(request: GetUserDataRequest,
|
3186
|
+
GetUserInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3187
3187
|
/**
|
3188
3188
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3189
3189
|
* version 2._ Retrieves the specified user's current inventory of virtual goods
|
3190
3190
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/getuserinventory
|
3191
3191
|
*/
|
3192
|
-
GetUserInventory(request: GetUserInventoryRequest,
|
3192
|
+
GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
|
3193
3193
|
/**
|
3194
3194
|
* Retrieves the publisher-specific custom data for the user which is readable and writable by the client
|
3195
3195
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherdata
|
3196
3196
|
*/
|
3197
|
-
GetUserPublisherData(request: GetUserDataRequest,
|
3197
|
+
GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3198
3198
|
/**
|
3199
3199
|
* Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
|
3200
3200
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherinternaldata
|
3201
3201
|
*/
|
3202
|
-
GetUserPublisherInternalData(request: GetUserDataRequest,
|
3202
|
+
GetUserPublisherInternalData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3203
3203
|
/**
|
3204
3204
|
* Retrieves the publisher-specific custom data for the user which can only be read by the client
|
3205
3205
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherreadonlydata
|
3206
3206
|
*/
|
3207
|
-
GetUserPublisherReadOnlyData(request: GetUserDataRequest,
|
3207
|
+
GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3208
3208
|
/**
|
3209
3209
|
* Retrieves the title-specific custom data for the user which can only be read by the client
|
3210
3210
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserreadonlydata
|
3211
3211
|
*/
|
3212
|
-
GetUserReadOnlyData(request: GetUserDataRequest,
|
3212
|
+
GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
|
3213
3213
|
/**
|
3214
3214
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3215
3215
|
* version 2._ Adds the specified items to the specified user inventories
|
3216
3216
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers
|
3217
3217
|
*/
|
3218
|
-
GrantItemsToUsers(request: GrantItemsToUsersRequest,
|
3218
|
+
GrantItemsToUsers(request: GrantItemsToUsersRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
|
3219
3219
|
/**
|
3220
3220
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3221
3221
|
* version 2._ Increases the global count for the given scarce resource.
|
3222
3222
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability
|
3223
3223
|
*/
|
3224
|
-
IncrementLimitedEditionItemAvailability(request: IncrementLimitedEditionItemAvailabilityRequest,
|
3224
|
+
IncrementLimitedEditionItemAvailability(request: IncrementLimitedEditionItemAvailabilityRequest, extraHeaders?: Record<string, string>): Promise<IncrementLimitedEditionItemAvailabilityResult>;
|
3225
3225
|
/**
|
3226
3226
|
* Resets the indicated statistic, removing all player entries for it and backing up the old values.
|
3227
3227
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion
|
3228
3228
|
*/
|
3229
|
-
IncrementPlayerStatisticVersion(request: IncrementPlayerStatisticVersionRequest,
|
3229
|
+
IncrementPlayerStatisticVersion(request: IncrementPlayerStatisticVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementPlayerStatisticVersionResult>;
|
3230
3230
|
/**
|
3231
3231
|
* Retrieves a list of all Open ID Connect providers registered to a title.
|
3232
3232
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection
|
3233
3233
|
*/
|
3234
|
-
ListOpenIdConnection(request: ListOpenIdConnectionRequest,
|
3234
|
+
ListOpenIdConnection(request: ListOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<ListOpenIdConnectionResponse>;
|
3235
3235
|
/**
|
3236
3236
|
* Retrieves title-specific custom property values for a player.
|
3237
3237
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties
|
3238
3238
|
*/
|
3239
|
-
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest,
|
3239
|
+
ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
|
3240
3240
|
/**
|
3241
3241
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3242
3242
|
* version 2._ Retuns the list of all defined virtual currencies for the title
|
3243
3243
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes
|
3244
3244
|
*/
|
3245
|
-
ListVirtualCurrencyTypes(request: ListVirtualCurrencyTypesRequest,
|
3245
|
+
ListVirtualCurrencyTypes(request: ListVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<ListVirtualCurrencyTypesResult>;
|
3246
3246
|
/**
|
3247
3247
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3248
3248
|
* version 2._ Attempts to process an order refund through the original real money payment provider.
|
3249
3249
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase
|
3250
3250
|
*/
|
3251
|
-
RefundPurchase(request: RefundPurchaseRequest,
|
3251
|
+
RefundPurchase(request: RefundPurchaseRequest, extraHeaders?: Record<string, string>): Promise<RefundPurchaseResponse>;
|
3252
3252
|
/**
|
3253
3253
|
* Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
|
3254
3254
|
* https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag
|
3255
3255
|
*/
|
3256
|
-
RemovePlayerTag(request: RemovePlayerTagRequest,
|
3256
|
+
RemovePlayerTag(request: RemovePlayerTagRequest, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
|
3257
3257
|
/**
|
3258
3258
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3259
3259
|
* version 2._ Removes one or more virtual currencies from the set defined for the title.
|
3260
3260
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes
|
3261
3261
|
*/
|
3262
|
-
RemoveVirtualCurrencyTypes(request: RemoveVirtualCurrencyTypesRequest,
|
3262
|
+
RemoveVirtualCurrencyTypes(request: RemoveVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
|
3263
3263
|
/**
|
3264
3264
|
* Completely removes all statistics for the specified character, for the current game
|
3265
3265
|
* https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics
|
3266
3266
|
*/
|
3267
|
-
ResetCharacterStatistics(request: ResetCharacterStatisticsRequest,
|
3267
|
+
ResetCharacterStatistics(request: ResetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<ResetCharacterStatisticsResult>;
|
3268
3268
|
/**
|
3269
3269
|
* Reset a player's password for a given title.
|
3270
3270
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword
|
3271
3271
|
*/
|
3272
|
-
ResetPassword(request: ResetPasswordRequest,
|
3272
|
+
ResetPassword(request: ResetPasswordRequest, extraHeaders?: Record<string, string>): Promise<ResetPasswordResult>;
|
3273
3273
|
/**
|
3274
3274
|
* Completely removes all statistics for the specified user, for the current game
|
3275
3275
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics
|
3276
3276
|
*/
|
3277
|
-
ResetUserStatistics(request: ResetUserStatisticsRequest,
|
3277
|
+
ResetUserStatistics(request: ResetUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<ResetUserStatisticsResult>;
|
3278
3278
|
/**
|
3279
3279
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3280
3280
|
* version 2._ Attempts to resolve a dispute with the original order's payment provider.
|
3281
3281
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute
|
3282
3282
|
*/
|
3283
|
-
ResolvePurchaseDispute(request: ResolvePurchaseDisputeRequest,
|
3283
|
+
ResolvePurchaseDispute(request: ResolvePurchaseDisputeRequest, extraHeaders?: Record<string, string>): Promise<ResolvePurchaseDisputeResponse>;
|
3284
3284
|
/**
|
3285
3285
|
* Revoke all active bans for a user.
|
3286
3286
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser
|
3287
3287
|
*/
|
3288
|
-
RevokeAllBansForUser(request: RevokeAllBansForUserRequest,
|
3288
|
+
RevokeAllBansForUser(request: RevokeAllBansForUserRequest, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
|
3289
3289
|
/**
|
3290
3290
|
* Revoke all active bans specified with BanId.
|
3291
3291
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans
|
3292
3292
|
*/
|
3293
|
-
RevokeBans(request: RevokeBansRequest,
|
3293
|
+
RevokeBans(request: RevokeBansRequest, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
|
3294
3294
|
/**
|
3295
3295
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3296
3296
|
* version 2._ Revokes access to an item in a user's inventory
|
3297
3297
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem
|
3298
3298
|
*/
|
3299
|
-
RevokeInventoryItem(request: RevokeInventoryItemRequest,
|
3299
|
+
RevokeInventoryItem(request: RevokeInventoryItemRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
|
3300
3300
|
/**
|
3301
3301
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3302
3302
|
* version 2._ Revokes access for up to 25 items across multiple users and characters.
|
3303
3303
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems
|
3304
3304
|
*/
|
3305
|
-
RevokeInventoryItems(request: RevokeInventoryItemsRequest,
|
3305
|
+
RevokeInventoryItems(request: RevokeInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
|
3306
3306
|
/**
|
3307
3307
|
* Run a task immediately regardless of its schedule.
|
3308
3308
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask
|
3309
3309
|
*/
|
3310
|
-
RunTask(request: RunTaskRequest,
|
3310
|
+
RunTask(request: RunTaskRequest, extraHeaders?: Record<string, string>): Promise<RunTaskResult>;
|
3311
3311
|
/**
|
3312
3312
|
* Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
|
3313
3313
|
* change the password.If an account recovery email template ID is provided, an email using the custom email template will
|
3314
3314
|
* be used.
|
3315
3315
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail
|
3316
3316
|
*/
|
3317
|
-
SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest,
|
3317
|
+
SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
|
3318
3318
|
/**
|
3319
3319
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3320
3320
|
* version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version
|
3321
3321
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems
|
3322
3322
|
*/
|
3323
|
-
SetCatalogItems(request: UpdateCatalogItemsRequest,
|
3323
|
+
SetCatalogItems(request: UpdateCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
|
3324
3324
|
/**
|
3325
3325
|
* Sets the override expiration for a membership subscription
|
3326
3326
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride
|
3327
3327
|
*/
|
3328
|
-
SetMembershipOverride(request: SetMembershipOverrideRequest,
|
3328
|
+
SetMembershipOverride(request: SetMembershipOverrideRequest, extraHeaders?: Record<string, string>): Promise<SetMembershipOverrideResult>;
|
3329
3329
|
/**
|
3330
3330
|
* Sets or resets the player's secret. Player secrets are used to sign API requests.
|
3331
3331
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret
|
3332
3332
|
*/
|
3333
|
-
SetPlayerSecret(request: SetPlayerSecretRequest,
|
3333
|
+
SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
|
3334
3334
|
/**
|
3335
3335
|
* Sets the currently published revision of a title Cloud Script
|
3336
3336
|
* https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision
|
3337
3337
|
*/
|
3338
|
-
SetPublishedRevision(request: SetPublishedRevisionRequest,
|
3338
|
+
SetPublishedRevision(request: SetPublishedRevisionRequest, extraHeaders?: Record<string, string>): Promise<SetPublishedRevisionResult>;
|
3339
3339
|
/**
|
3340
3340
|
* Updates the key-value store of custom publisher settings
|
3341
3341
|
* https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata
|
3342
3342
|
*/
|
3343
|
-
SetPublisherData(request: SetPublisherDataRequest,
|
3343
|
+
SetPublisherData(request: SetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
|
3344
3344
|
/**
|
3345
3345
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3346
3346
|
* version 2._ Sets all the items in one virtual store
|
3347
3347
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems
|
3348
3348
|
*/
|
3349
|
-
SetStoreItems(request: UpdateStoreItemsRequest,
|
3349
|
+
SetStoreItems(request: UpdateStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
|
3350
3350
|
/**
|
3351
3351
|
* Creates and updates the key-value store of custom title settings which can be read by the client. For example, a
|
3352
3352
|
* developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
|
@@ -3354,131 +3354,131 @@ declare class PlayFabAdminApi extends PlayFabCommon {
|
|
3354
3354
|
* build.
|
3355
3355
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata
|
3356
3356
|
*/
|
3357
|
-
SetTitleData(request: SetTitleDataRequest,
|
3357
|
+
SetTitleData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3358
3358
|
/**
|
3359
3359
|
* Set and delete key-value pairs in a title data override instance.
|
3360
3360
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides
|
3361
3361
|
*/
|
3362
|
-
SetTitleDataAndOverrides(request: SetTitleDataAndOverridesRequest,
|
3362
|
+
SetTitleDataAndOverrides(request: SetTitleDataAndOverridesRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataAndOverridesResult>;
|
3363
3363
|
/**
|
3364
3364
|
* Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
|
3365
3365
|
* tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
|
3366
3366
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata
|
3367
3367
|
*/
|
3368
|
-
SetTitleInternalData(request: SetTitleDataRequest,
|
3368
|
+
SetTitleInternalData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
|
3369
3369
|
/**
|
3370
3370
|
* Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can
|
3371
3371
|
* be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device
|
3372
3372
|
* Messaging is not supported.
|
3373
3373
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification
|
3374
3374
|
*/
|
3375
|
-
SetupPushNotification(request: SetupPushNotificationRequest,
|
3375
|
+
SetupPushNotification(request: SetupPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<SetupPushNotificationResult>;
|
3376
3376
|
/**
|
3377
3377
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3378
3378
|
* version 2._ Decrements the specified virtual currency by the stated amount
|
3379
3379
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency
|
3380
3380
|
*/
|
3381
|
-
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest,
|
3381
|
+
SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
|
3382
3382
|
/**
|
3383
3383
|
* Updates information of a list of existing bans specified with Ban Ids.
|
3384
3384
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans
|
3385
3385
|
*/
|
3386
|
-
UpdateBans(request: UpdateBansRequest,
|
3386
|
+
UpdateBans(request: UpdateBansRequest, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
|
3387
3387
|
/**
|
3388
3388
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3389
3389
|
* version 2._ Updates the catalog configuration for virtual goods in the specified catalog version
|
3390
3390
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems
|
3391
3391
|
*/
|
3392
|
-
UpdateCatalogItems(request: UpdateCatalogItemsRequest,
|
3392
|
+
UpdateCatalogItems(request: UpdateCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
|
3393
3393
|
/**
|
3394
3394
|
* Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be
|
3395
3395
|
* submitted in the revision.
|
3396
3396
|
* https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript
|
3397
3397
|
*/
|
3398
|
-
UpdateCloudScript(request: UpdateCloudScriptRequest,
|
3398
|
+
UpdateCloudScript(request: UpdateCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<UpdateCloudScriptResult>;
|
3399
3399
|
/**
|
3400
3400
|
* Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider
|
3401
3401
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection
|
3402
3402
|
*/
|
3403
|
-
UpdateOpenIdConnection(request: UpdateOpenIdConnectionRequest,
|
3403
|
+
UpdateOpenIdConnection(request: UpdateOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3404
3404
|
/**
|
3405
3405
|
* Updates the title-specific custom property values for a player
|
3406
3406
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties
|
3407
3407
|
*/
|
3408
|
-
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest,
|
3408
|
+
UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
|
3409
3409
|
/**
|
3410
3410
|
* Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available
|
3411
3411
|
* after this API returns.
|
3412
3412
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret
|
3413
3413
|
*/
|
3414
|
-
UpdatePlayerSharedSecret(request: UpdatePlayerSharedSecretRequest,
|
3414
|
+
UpdatePlayerSharedSecret(request: UpdatePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerSharedSecretResult>;
|
3415
3415
|
/**
|
3416
3416
|
* Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
|
3417
3417
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition
|
3418
3418
|
*/
|
3419
|
-
UpdatePlayerStatisticDefinition(request: UpdatePlayerStatisticDefinitionRequest,
|
3419
|
+
UpdatePlayerStatisticDefinition(request: UpdatePlayerStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticDefinitionResult>;
|
3420
3420
|
/**
|
3421
3421
|
* Changes a policy for a title
|
3422
3422
|
* https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy
|
3423
3423
|
*/
|
3424
|
-
UpdatePolicy(request: UpdatePolicyRequest,
|
3424
|
+
UpdatePolicy(request: UpdatePolicyRequest, extraHeaders?: Record<string, string>): Promise<UpdatePolicyResponse>;
|
3425
3425
|
/**
|
3426
3426
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3427
3427
|
* version 2._ Updates the random drop table configuration for the title
|
3428
3428
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables
|
3429
3429
|
*/
|
3430
|
-
UpdateRandomResultTables(request: UpdateRandomResultTablesRequest,
|
3430
|
+
UpdateRandomResultTables(request: UpdateRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<UpdateRandomResultTablesResult>;
|
3431
3431
|
/**
|
3432
3432
|
* Updates an existing player segment and its associated definition(s) and action(s) for a title.
|
3433
3433
|
* https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment
|
3434
3434
|
*/
|
3435
|
-
UpdateSegment(request: UpdateSegmentRequest,
|
3435
|
+
UpdateSegment(request: UpdateSegmentRequest, extraHeaders?: Record<string, string>): Promise<UpdateSegmentResponse>;
|
3436
3436
|
/**
|
3437
3437
|
* _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
|
3438
3438
|
* version 2._ Updates an existing virtual item store with new or modified items
|
3439
3439
|
* https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems
|
3440
3440
|
*/
|
3441
|
-
UpdateStoreItems(request: UpdateStoreItemsRequest,
|
3441
|
+
UpdateStoreItems(request: UpdateStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
|
3442
3442
|
/**
|
3443
3443
|
* Update an existing task.
|
3444
3444
|
* https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask
|
3445
3445
|
*/
|
3446
|
-
UpdateTask(request: UpdateTaskRequest,
|
3446
|
+
UpdateTask(request: UpdateTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
|
3447
3447
|
/**
|
3448
3448
|
* Updates the title-specific custom data for the user which is readable and writable by the client
|
3449
3449
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata
|
3450
3450
|
*/
|
3451
|
-
UpdateUserData(request: UpdateUserDataRequest,
|
3451
|
+
UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3452
3452
|
/**
|
3453
3453
|
* Updates the title-specific custom data for the user which cannot be accessed by the client
|
3454
3454
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserinternaldata
|
3455
3455
|
*/
|
3456
|
-
UpdateUserInternalData(request: UpdateUserInternalDataRequest,
|
3456
|
+
UpdateUserInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3457
3457
|
/**
|
3458
3458
|
* Updates the publisher-specific custom data for the user which is readable and writable by the client
|
3459
3459
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata
|
3460
3460
|
*/
|
3461
|
-
UpdateUserPublisherData(request: UpdateUserDataRequest,
|
3461
|
+
UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3462
3462
|
/**
|
3463
3463
|
* Updates the publisher-specific custom data for the user which cannot be accessed by the client
|
3464
3464
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherinternaldata
|
3465
3465
|
*/
|
3466
|
-
UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest,
|
3466
|
+
UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3467
3467
|
/**
|
3468
3468
|
* Updates the publisher-specific custom data for the user which can only be read by the client
|
3469
3469
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherreadonlydata
|
3470
3470
|
*/
|
3471
|
-
UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest,
|
3471
|
+
UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3472
3472
|
/**
|
3473
3473
|
* Updates the title-specific custom data for the user which can only be read by the client
|
3474
3474
|
* https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserreadonlydata
|
3475
3475
|
*/
|
3476
|
-
UpdateUserReadOnlyData(request: UpdateUserDataRequest,
|
3476
|
+
UpdateUserReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
|
3477
3477
|
/**
|
3478
3478
|
* Updates the title specific display name for a user
|
3479
3479
|
* https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname
|
3480
3480
|
*/
|
3481
|
-
UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest,
|
3481
|
+
UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
|
3482
3482
|
}
|
3483
3483
|
|
3484
3484
|
export { PlayFabAdminApi as default };
|