async-playfab-web-sdk 1.192.250526-3 → 1.192.250526-5

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.
Files changed (103) hide show
  1. package/dist/Addon.d.ts +179 -39
  2. package/dist/Addon.js +2 -2
  3. package/dist/Admin.d.ts +2386 -195
  4. package/dist/Admin.js +2 -2
  5. package/dist/Authentication.d.ts +32 -5
  6. package/dist/Authentication.js +2 -2
  7. package/dist/Client.d.ts +2235 -321
  8. package/dist/Client.js +2 -2
  9. package/dist/CloudScript.d.ts +199 -31
  10. package/dist/CloudScript.js +2 -2
  11. package/dist/Data.d.ts +137 -18
  12. package/dist/Data.js +2 -2
  13. package/dist/Economy.d.ts +1145 -106
  14. package/dist/Economy.js +2 -2
  15. package/dist/Events.d.ts +200 -13
  16. package/dist/Events.js +2 -2
  17. package/dist/Experimentation.d.ts +164 -17
  18. package/dist/Experimentation.js +2 -2
  19. package/dist/Groups.d.ts +267 -28
  20. package/dist/Groups.js +2 -2
  21. package/dist/Insights.d.ts +33 -7
  22. package/dist/Insights.js +2 -2
  23. package/dist/Localization.d.ts +5 -2
  24. package/dist/Localization.js +2 -2
  25. package/dist/Matchmaker.d.ts +271 -0
  26. package/dist/Matchmaker.js +8 -0
  27. package/dist/Matchmaker.js.map +1 -0
  28. package/dist/Multiplayer.d.ts +2697 -169
  29. package/dist/Multiplayer.js +2 -2
  30. package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
  31. package/dist/Profiles.d.ts +163 -19
  32. package/dist/Profiles.js +2 -2
  33. package/dist/Progression.d.ts +287 -35
  34. package/dist/Progression.js +2 -2
  35. package/dist/Server.d.ts +1904 -242
  36. package/dist/Server.js +2 -2
  37. package/dist/chunk-3I6ONUUQ.js +237 -0
  38. package/dist/chunk-3I6ONUUQ.js.map +1 -0
  39. package/dist/chunk-3O5QT4SL.js +2477 -0
  40. package/dist/chunk-3O5QT4SL.js.map +1 -0
  41. package/dist/chunk-3OBHYLBF.js +2673 -0
  42. package/dist/chunk-3OBHYLBF.js.map +1 -0
  43. package/dist/chunk-57KYHGBO.js +421 -0
  44. package/dist/chunk-57KYHGBO.js.map +1 -0
  45. package/dist/{chunk-J4QS5VX5.js → chunk-5CWZN75H.js} +6 -3
  46. package/dist/chunk-5CWZN75H.js.map +1 -0
  47. package/dist/chunk-73SVDH45.js +197 -0
  48. package/dist/chunk-73SVDH45.js.map +1 -0
  49. package/dist/chunk-ADHTNFTN.js +175 -0
  50. package/dist/chunk-ADHTNFTN.js.map +1 -0
  51. package/dist/chunk-C7U2JQNZ.js +76 -0
  52. package/dist/chunk-C7U2JQNZ.js.map +1 -0
  53. package/dist/{chunk-SGSEOIKS.js → chunk-GAZYZIK2.js} +34 -8
  54. package/dist/chunk-GAZYZIK2.js.map +1 -0
  55. package/dist/chunk-J54WY4UN.js +413 -0
  56. package/dist/chunk-J54WY4UN.js.map +1 -0
  57. package/dist/chunk-NFWQ4MMZ.js +1048 -0
  58. package/dist/chunk-NFWQ4MMZ.js.map +1 -0
  59. package/dist/{chunk-A7VD6ALV.js → chunk-P7UVG26J.js} +167 -32
  60. package/dist/chunk-P7UVG26J.js.map +1 -0
  61. package/dist/chunk-PFXZB4UN.js +2387 -0
  62. package/dist/chunk-PFXZB4UN.js.map +1 -0
  63. package/dist/{chunk-X34XZJB6.js → chunk-QNGQW3YB.js} +28 -6
  64. package/dist/chunk-QNGQW3YB.js.map +1 -0
  65. package/dist/chunk-SQWILU5T.js +270 -0
  66. package/dist/chunk-SQWILU5T.js.map +1 -0
  67. package/dist/{chunk-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
  68. package/dist/chunk-SR2RIRLX.js.map +1 -0
  69. package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
  70. package/dist/chunk-XVDYM74A.js.map +1 -0
  71. package/dist/chunk-ZW4TJ3MQ.js +225 -0
  72. package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
  73. package/dist/index.d.ts +7 -6
  74. package/dist/index.js +29 -25
  75. package/package.json +2 -2
  76. package/dist/chunk-3FCAP7OZ.js +0 -187
  77. package/dist/chunk-3FCAP7OZ.js.map +0 -1
  78. package/dist/chunk-62SULWOK.js.map +0 -1
  79. package/dist/chunk-A7VD6ALV.js.map +0 -1
  80. package/dist/chunk-BX65UND2.js +0 -632
  81. package/dist/chunk-BX65UND2.js.map +0 -1
  82. package/dist/chunk-J4QS5VX5.js.map +0 -1
  83. package/dist/chunk-JGDO2ZE3.js.map +0 -1
  84. package/dist/chunk-POMI7LEF.js +0 -76
  85. package/dist/chunk-POMI7LEF.js.map +0 -1
  86. package/dist/chunk-Q3OF3AOJ.js +0 -97
  87. package/dist/chunk-Q3OF3AOJ.js.map +0 -1
  88. package/dist/chunk-QUZHVSVZ.js +0 -174
  89. package/dist/chunk-QUZHVSVZ.js.map +0 -1
  90. package/dist/chunk-QVLIVSO4.js +0 -1147
  91. package/dist/chunk-QVLIVSO4.js.map +0 -1
  92. package/dist/chunk-R7V7DFCF.js +0 -103
  93. package/dist/chunk-R7V7DFCF.js.map +0 -1
  94. package/dist/chunk-SGSEOIKS.js.map +0 -1
  95. package/dist/chunk-UOHHNVCJ.js +0 -119
  96. package/dist/chunk-UOHHNVCJ.js.map +0 -1
  97. package/dist/chunk-USKFWNQK.js +0 -384
  98. package/dist/chunk-USKFWNQK.js.map +0 -1
  99. package/dist/chunk-UX7LFJCX.js +0 -61
  100. package/dist/chunk-UX7LFJCX.js.map +0 -1
  101. package/dist/chunk-X34XZJB6.js.map +0 -1
  102. package/dist/chunk-YNZF3WXS.js +0 -882
  103. package/dist/chunk-YNZF3WXS.js.map +0 -1
@@ -0,0 +1,2673 @@
1
+ import {
2
+ PlayFabCommon
3
+ } from "./chunk-XVDYM74A.js";
4
+
5
+ // src/apis/PlayFabAdminApi.ts
6
+ var PlayFabAdminApi = class extends PlayFabCommon {
7
+ /**
8
+ * Abort an ongoing task instance.
9
+ *
10
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance Microsoft Documentation}
11
+ * @example
12
+ * await adminClient.AbortTaskInstance({
13
+ * "TaskInstanceId": "E52531B47B1761C7-4"
14
+ * });
15
+ */
16
+ AbortTaskInstance(request, extraHeaders) {
17
+ return this.ExecuteRequestWrapper("/Admin/AbortTaskInstance", request, "X-SecretKey", extraHeaders);
18
+ }
19
+ /**
20
+ * Update news item to include localized version
21
+ *
22
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews Microsoft Documentation}
23
+ * @example
24
+ * await adminClient.AddLocalizedNews({
25
+ * "NewsId": "74623b12-6c80-ee4b-7c3b-58e638aa62bd",
26
+ * "Language": "en",
27
+ * "Title": "News of the Day",
28
+ * "Body": "<b>We have a new object to buy!</b>"
29
+ * });
30
+ */
31
+ AddLocalizedNews(request, extraHeaders) {
32
+ return this.ExecuteRequestWrapper("/Admin/AddLocalizedNews", request, "X-SecretKey", extraHeaders);
33
+ }
34
+ /**
35
+ * Adds a new news item to the title's news feed
36
+ *
37
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews Microsoft Documentation}
38
+ * @example
39
+ * await adminClient.AddNews({
40
+ * "Timestamp": "2014-04-06T00:00:00Z",
41
+ * "Title": "News of the Day",
42
+ * "Body": "<b>We have a new object to buy!</b>"
43
+ * });
44
+ */
45
+ AddNews(request, extraHeaders) {
46
+ return this.ExecuteRequestWrapper("/Admin/AddNews", request, "X-SecretKey", extraHeaders);
47
+ }
48
+ /**
49
+ * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
50
+ *
51
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/addplayertag Microsoft Documentation}
52
+ * @example
53
+ * await adminClient.AddPlayerTag({
54
+ * "PlayFabId": "10931252888739651331",
55
+ * "TagName": "MostKilled"
56
+ * });
57
+ */
58
+ AddPlayerTag(request, extraHeaders) {
59
+ return this.ExecuteRequestWrapper("/Admin/AddPlayerTag", request, "X-SecretKey", extraHeaders);
60
+ }
61
+ /**
62
+ * Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a
63
+ * client is permitted to request in a call to StartGame
64
+ *
65
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/addserverbuild Microsoft Documentation}
66
+ * @deprecated Do not use
67
+ */
68
+ AddServerBuild(request, extraHeaders) {
69
+ return this.ExecuteRequestWrapper("/Admin/AddServerBuild", request, "X-SecretKey", extraHeaders);
70
+ }
71
+ /**
72
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
73
+ * version 2._ Increments the specified virtual currency by the stated amount
74
+ *
75
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency Microsoft Documentation}
76
+ * @example
77
+ * await adminClient.AddUserVirtualCurrency({
78
+ * "PlayFabId": "20394883",
79
+ * "VirtualCurrency": "GC",
80
+ * "Amount": 100
81
+ * });
82
+ */
83
+ AddUserVirtualCurrency(request, extraHeaders) {
84
+ return this.ExecuteRequestWrapper("/Admin/AddUserVirtualCurrency", request, "X-SecretKey", extraHeaders);
85
+ }
86
+ /**
87
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
88
+ * version 2._ Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum
89
+ * value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
90
+ *
91
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes Microsoft Documentation}
92
+ * @example
93
+ * await adminClient.AddVirtualCurrencyTypes({
94
+ * "VirtualCurrencies": [
95
+ * {
96
+ * "CurrencyCode": "CC",
97
+ * "DisplayName": "Chump Coins",
98
+ * "InitialDeposit": 100,
99
+ * "RechargeRate": 1000,
100
+ * "RechargeMax": 1000
101
+ * },
102
+ * {
103
+ * "CurrencyCode": "GC"
104
+ * }
105
+ * ]
106
+ * });
107
+ */
108
+ AddVirtualCurrencyTypes(request, extraHeaders) {
109
+ return this.ExecuteRequestWrapper("/Admin/AddVirtualCurrencyTypes", request, "X-SecretKey", extraHeaders);
110
+ }
111
+ /**
112
+ * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
113
+ *
114
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers Microsoft Documentation}
115
+ * @example
116
+ * await adminClient.BanUsers({
117
+ * "Bans": [
118
+ * {
119
+ * "PlayFabId": "1679AF5CD04BD838",
120
+ * "IPAddress": "192.168.1.1",
121
+ * "Reason": "You cheated!",
122
+ * "DurationInHours": 7
123
+ * },
124
+ * {
125
+ * "PlayFabId": "2329AF5CD04BF513",
126
+ * "Reason": "Caught you using speed hack!"
127
+ * }
128
+ * ]
129
+ * });
130
+ */
131
+ BanUsers(request, extraHeaders) {
132
+ return this.ExecuteRequestWrapper("/Admin/BanUsers", request, "X-SecretKey", extraHeaders);
133
+ }
134
+ /**
135
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
136
+ * version 2._ Checks the global count for the limited edition item.
137
+ *
138
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability Microsoft Documentation}
139
+ * @example
140
+ * await adminClient.CheckLimitedEditionItemAvailability({
141
+ * "CatalogVersion": "Rares",
142
+ * "ItemId": "FreeHoodie"
143
+ * });
144
+ */
145
+ CheckLimitedEditionItemAvailability(request, extraHeaders) {
146
+ return this.ExecuteRequestWrapper("/Admin/CheckLimitedEditionItemAvailability", request, "X-SecretKey", extraHeaders);
147
+ }
148
+ /**
149
+ * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
150
+ *
151
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask Microsoft Documentation}
152
+ * @example
153
+ * await adminClient.CreateActionsOnPlayersInSegmentTask({
154
+ * "Name": "PushNotificationVIP_Halloween",
155
+ * "Description": "Send push notification to VIP players about Halloween event",
156
+ * "IsActive": false,
157
+ * "Parameter": {
158
+ * "SegmentId": "274828AF93F13472",
159
+ * "Actions": [
160
+ * {
161
+ * "GrantItemContent": {
162
+ * "CatalogVersion": "foo",
163
+ * "ItemId": "bar",
164
+ * "ItemQuantity": 1
165
+ * }
166
+ * }
167
+ * ]
168
+ * }
169
+ * });
170
+ */
171
+ CreateActionsOnPlayersInSegmentTask(request, extraHeaders) {
172
+ return this.ExecuteRequestWrapper("/Admin/CreateActionsOnPlayersInSegmentTask", request, "X-SecretKey", extraHeaders);
173
+ }
174
+ /**
175
+ * Create a CloudScript task, which can run a CloudScript on a schedule.
176
+ *
177
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscriptazurefunctionstask Microsoft Documentation}
178
+ * @example
179
+ * await adminClient.CreateCloudScriptAzureFunctionsTask({
180
+ * "Name": "EnableWeekdayHappyHour",
181
+ * "Description": "Turn on special pricing for weekday happy hour.",
182
+ * "Schedule": "0 17 * * 1-5",
183
+ * "IsActive": false,
184
+ * "Parameter": {
185
+ * "FunctionName": "applyStorePreset",
186
+ * "Argument": {
187
+ * "preset": "WeekdayHappyHour"
188
+ * }
189
+ * }
190
+ * });
191
+ */
192
+ CreateCloudScriptAzureFunctionsTask(request, extraHeaders) {
193
+ return this.ExecuteRequestWrapper("/Admin/CreateCloudScriptAzureFunctionsTask", request, "X-SecretKey", extraHeaders);
194
+ }
195
+ /**
196
+ * Create a CloudScript task, which can run a CloudScript on a schedule.
197
+ *
198
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask Microsoft Documentation}
199
+ * @example
200
+ * await adminClient.CreateCloudScriptTask({
201
+ * "Name": "EnableWeekdayHappyHour",
202
+ * "Description": "Turn on special pricing for weekday happy hour.",
203
+ * "Schedule": "0 17 * * 1-5",
204
+ * "IsActive": false,
205
+ * "Parameter": {
206
+ * "FunctionName": "applyStorePreset",
207
+ * "Argument": {
208
+ * "preset": "WeekdayHappyHour"
209
+ * }
210
+ * }
211
+ * });
212
+ */
213
+ CreateCloudScriptTask(request, extraHeaders) {
214
+ return this.ExecuteRequestWrapper("/Admin/CreateCloudScriptTask", request, "X-SecretKey", extraHeaders);
215
+ }
216
+ /**
217
+ * Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
218
+ *
219
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask Microsoft Documentation}
220
+ * @example
221
+ * await adminClient.CreateInsightsScheduledScalingTask({
222
+ * "Name": "EnableWeekdayPerformance",
223
+ * "Description": "Scale up Insights Performance Units during weekdays.",
224
+ * "Schedule": "0 0 * * 1-5",
225
+ * "IsActive": false,
226
+ * "Parameter": {
227
+ * "Level": 3
228
+ * }
229
+ * });
230
+ */
231
+ CreateInsightsScheduledScalingTask(request, extraHeaders) {
232
+ return this.ExecuteRequestWrapper("/Admin/CreateInsightsScheduledScalingTask", request, "X-SecretKey", extraHeaders);
233
+ }
234
+ /**
235
+ * Registers a relationship between a title and an Open ID Connect provider.
236
+ *
237
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection Microsoft Documentation}
238
+ * @example
239
+ * await adminClient.CreateOpenIdConnection({
240
+ * "ConnectionId": "oidconnection1",
241
+ * "ClientId": "example_id_1",
242
+ * "ClientSecret": "example_secret_1",
243
+ * "IssuerInformation": {
244
+ * "Issuer": "https://issuer.example.com/",
245
+ * "AuthorizationUrl": "https://issuer.example.com/authorize",
246
+ * "TokenUrl": "https://issuer.example.com/oauth2/token",
247
+ * "JsonWebKeySet": {
248
+ * "keys": [
249
+ * "..."
250
+ * ]
251
+ * }
252
+ * },
253
+ * "IssuerOverride": "https://issueroverride.example.com/",
254
+ * "IgnoreNonce": true
255
+ * });
256
+ */
257
+ CreateOpenIdConnection(request, extraHeaders) {
258
+ return this.ExecuteRequestWrapper("/Admin/CreateOpenIdConnection", request, "X-SecretKey", extraHeaders);
259
+ }
260
+ /**
261
+ * Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after
262
+ * this API returns.
263
+ *
264
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret Microsoft Documentation}
265
+ * @example
266
+ * await adminClient.CreatePlayerSharedSecret({
267
+ * "FriendlyName": "iOS Users"
268
+ * });
269
+ */
270
+ CreatePlayerSharedSecret(request, extraHeaders) {
271
+ return this.ExecuteRequestWrapper("/Admin/CreatePlayerSharedSecret", request, "X-SecretKey", extraHeaders);
272
+ }
273
+ /**
274
+ * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval
275
+ * and an aggregation method.
276
+ *
277
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition Microsoft Documentation}
278
+ * @example
279
+ * await adminClient.CreatePlayerStatisticDefinition({
280
+ * "StatisticName": "headshots",
281
+ * "VersionChangeInterval": "Never",
282
+ * "ShouldProvisionLeaderboard": false
283
+ * });
284
+ */
285
+ CreatePlayerStatisticDefinition(request, extraHeaders) {
286
+ return this.ExecuteRequestWrapper("/Admin/CreatePlayerStatisticDefinition", request, "X-SecretKey", extraHeaders);
287
+ }
288
+ /**
289
+ * Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player
290
+ * segments for a title.
291
+ *
292
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment Microsoft Documentation}
293
+ * @example
294
+ * await adminClient.CreateSegment({
295
+ * "SegmentModel": {
296
+ * "Name": "My user segment",
297
+ * "LastUpdateTime": "0001-01-01T00:00:00Z",
298
+ * "SegmentOrDefinitions": [
299
+ * {
300
+ * "SegmentAndDefinitions": [
301
+ * {
302
+ * "AllPlayersFilter": {}
303
+ * }
304
+ * ]
305
+ * }
306
+ * ],
307
+ * "EnteredSegmentActions": [
308
+ * {
309
+ * "BanPlayerAction": {
310
+ * "BanHours": 2,
311
+ * "ReasonForBan": "Not played for a year"
312
+ * }
313
+ * }
314
+ * ],
315
+ * "LeftSegmentActions": [
316
+ * {
317
+ * "ExecuteAzureFunctionAction": {
318
+ * "AzureFunction": "AzureFunction1",
319
+ * "FunctionParameter": "{\"InputParam\": \"1\"}",
320
+ * "GenerateFunctionExecutedEvents": false
321
+ * }
322
+ * }
323
+ * ]
324
+ * }
325
+ * });
326
+ */
327
+ CreateSegment(request, extraHeaders) {
328
+ return this.ExecuteRequestWrapper("/Admin/CreateSegment", request, "X-SecretKey", extraHeaders);
329
+ }
330
+ /**
331
+ * Delete a content file from the title. When deleting a file that does not exist, it returns success.
332
+ *
333
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent Microsoft Documentation}
334
+ * @example
335
+ * await adminClient.DeleteContent({
336
+ * "Key": "images/sword_icon.png"
337
+ * });
338
+ */
339
+ DeleteContent(request, extraHeaders) {
340
+ return this.ExecuteRequestWrapper("/Admin/DeleteContent", request, "X-SecretKey", extraHeaders);
341
+ }
342
+ /**
343
+ * Deletes a sink to stop sending PlayStream and Telemetry event data
344
+ *
345
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/deleteeventsink Microsoft Documentation}
346
+ * @example
347
+ * await adminClient.DeleteEventSink({
348
+ * "Name": "MyStorage"
349
+ * });
350
+ */
351
+ DeleteEventSink(request, extraHeaders) {
352
+ return this.ExecuteRequestWrapper("/Admin/DeleteEventSink", request, "X-SecretKey", extraHeaders);
353
+ }
354
+ /**
355
+ * Removes a master player account entirely from all titles and deletes all associated data
356
+ *
357
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount Microsoft Documentation}
358
+ * @example
359
+ * await adminClient.DeleteMasterPlayerAccount({
360
+ * "PlayFabId": "A68C908B66C23C5",
361
+ * "MetaData": "Identifying info"
362
+ * });
363
+ */
364
+ DeleteMasterPlayerAccount(request, extraHeaders) {
365
+ return this.ExecuteRequestWrapper("/Admin/DeleteMasterPlayerAccount", request, "X-SecretKey", extraHeaders);
366
+ }
367
+ /**
368
+ * Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
369
+ *
370
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata Microsoft Documentation}
371
+ * @example
372
+ * await adminClient.DeleteMasterPlayerEventData({
373
+ * "PlayFabId": "A68C908B66C23C5"
374
+ * });
375
+ */
376
+ DeleteMasterPlayerEventData(request, extraHeaders) {
377
+ return this.ExecuteRequestWrapper("/Admin/DeleteMasterPlayerEventData", request, "X-SecretKey", extraHeaders);
378
+ }
379
+ /**
380
+ * Deletes a player's subscription
381
+ *
382
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription Microsoft Documentation}
383
+ * @example
384
+ * await adminClient.DeleteMembershipSubscription({
385
+ * "MembershipId": "ShieldBonusMembership",
386
+ * "SubscriptionId": "39F6B89A-0F0C-4D96-B12C-BA89543A11A1",
387
+ * "PlayFabId": "204883457"
388
+ * });
389
+ */
390
+ DeleteMembershipSubscription(request, extraHeaders) {
391
+ return this.ExecuteRequestWrapper("/Admin/DeleteMembershipSubscription", request, "X-SecretKey", extraHeaders);
392
+ }
393
+ /**
394
+ * Removes a relationship between a title and an OpenID Connect provider.
395
+ *
396
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection Microsoft Documentation}
397
+ * @example
398
+ * await adminClient.DeleteOpenIdConnection({
399
+ * "ConnectionId": "oidconnection1"
400
+ * });
401
+ */
402
+ DeleteOpenIdConnection(request, extraHeaders) {
403
+ return this.ExecuteRequestWrapper("/Admin/DeleteOpenIdConnection", request, "X-SecretKey", extraHeaders);
404
+ }
405
+ /**
406
+ * Removes a user's player account from a title and deletes all associated data
407
+ *
408
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer Microsoft Documentation}
409
+ * @example
410
+ * await adminClient.DeletePlayer({
411
+ * "PlayFabId": "A68C908B66C23C5"
412
+ * });
413
+ */
414
+ DeletePlayer(request, extraHeaders) {
415
+ return this.ExecuteRequestWrapper("/Admin/DeletePlayer", request, "X-SecretKey", extraHeaders);
416
+ }
417
+ /**
418
+ * Deletes title-specific custom properties for a player
419
+ *
420
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties Microsoft Documentation}
421
+ * @example
422
+ * await adminClient.DeletePlayerCustomProperties({
423
+ * "PlayFabId": "2039475",
424
+ * "PropertyNames": [
425
+ * "level",
426
+ * "created"
427
+ * ],
428
+ * "ExpectedPropertiesVersion": 12
429
+ * });
430
+ */
431
+ DeletePlayerCustomProperties(request, extraHeaders) {
432
+ return this.ExecuteRequestWrapper("/Admin/DeletePlayerCustomProperties", request, "X-SecretKey", extraHeaders);
433
+ }
434
+ /**
435
+ * Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API
436
+ * returns.
437
+ *
438
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret Microsoft Documentation}
439
+ * @example
440
+ * await adminClient.DeletePlayerSharedSecret({
441
+ * "SecretKey": "keysaresecret"
442
+ * });
443
+ */
444
+ DeletePlayerSharedSecret(request, extraHeaders) {
445
+ return this.ExecuteRequestWrapper("/Admin/DeletePlayerSharedSecret", request, "X-SecretKey", extraHeaders);
446
+ }
447
+ /**
448
+ * Deletes an existing player segment and its associated action(s) for a title.
449
+ *
450
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment Microsoft Documentation}
451
+ * @example
452
+ * await adminClient.DeleteSegment({
453
+ * "SegmentId": "97EF0E9302CBE996"
454
+ * });
455
+ */
456
+ DeleteSegment(request, extraHeaders) {
457
+ return this.ExecuteRequestWrapper("/Admin/DeleteSegment", request, "X-SecretKey", extraHeaders);
458
+ }
459
+ /**
460
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
461
+ * version 2._ Deletes an existing virtual item store
462
+ *
463
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore Microsoft Documentation}
464
+ * @example
465
+ * await adminClient.DeleteStore({
466
+ * "StoreId": "BonusStore"
467
+ * });
468
+ */
469
+ DeleteStore(request, extraHeaders) {
470
+ return this.ExecuteRequestWrapper("/Admin/DeleteStore", request, "X-SecretKey", extraHeaders);
471
+ }
472
+ /**
473
+ * Delete a task.
474
+ *
475
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask Microsoft Documentation}
476
+ * @example
477
+ * await adminClient.DeleteTask({
478
+ * "Identifier": {
479
+ * "Id": "E1772FD927D8539D"
480
+ * }
481
+ * });
482
+ */
483
+ DeleteTask(request, extraHeaders) {
484
+ return this.ExecuteRequestWrapper("/Admin/DeleteTask", request, "X-SecretKey", extraHeaders);
485
+ }
486
+ /**
487
+ * Permanently deletes a title and all associated configuration
488
+ *
489
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle Microsoft Documentation}
490
+ * @example
491
+ * await adminClient.DeleteTitle({});
492
+ */
493
+ DeleteTitle(request, extraHeaders) {
494
+ return this.ExecuteRequestWrapper("/Admin/DeleteTitle", request, "X-SecretKey", extraHeaders);
495
+ }
496
+ /**
497
+ * Deletes a specified set of title data overrides.
498
+ *
499
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride Microsoft Documentation}
500
+ * @example
501
+ * await adminClient.DeleteTitleDataOverride({
502
+ * "OverrideLabel": "LaunchData"
503
+ * });
504
+ */
505
+ DeleteTitleDataOverride(request, extraHeaders) {
506
+ return this.ExecuteRequestWrapper("/Admin/DeleteTitleDataOverride", request, "X-SecretKey", extraHeaders);
507
+ }
508
+ /**
509
+ * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not
510
+ * remove the player's event history, login history, inventory items, nor virtual currencies.
511
+ *
512
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteusers Microsoft Documentation}
513
+ * @deprecated Please use DeletePlayer instead.
514
+ */
515
+ DeleteUsers(request, extraHeaders) {
516
+ return this.ExecuteRequestWrapper("/Admin/DeleteUsers", request, "X-SecretKey", extraHeaders);
517
+ }
518
+ /**
519
+ * Exports all associated data of a master player account
520
+ *
521
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata Microsoft Documentation}
522
+ * @example
523
+ * await adminClient.ExportMasterPlayerData({
524
+ * "PlayFabId": "A68C908B66C23C5"
525
+ * });
526
+ */
527
+ ExportMasterPlayerData(request, extraHeaders) {
528
+ return this.ExecuteRequestWrapper("/Admin/ExportMasterPlayerData", request, "X-SecretKey", extraHeaders);
529
+ }
530
+ /**
531
+ * Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which
532
+ * match the segment definition at the time of the API call. Profiles which change while an export is in progress will not
533
+ * be reflected in the results.
534
+ *
535
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment Microsoft Documentation}
536
+ * @example
537
+ * await adminClient.ExportPlayersInSegment({
538
+ * "SegmentId": "ABCDEF1234567890"
539
+ * });
540
+ */
541
+ ExportPlayersInSegment(request, extraHeaders) {
542
+ return this.ExecuteRequestWrapper("/Admin/ExportPlayersInSegment", request, "X-SecretKey", extraHeaders);
543
+ }
544
+ /**
545
+ * Get information about a ActionsOnPlayersInSegment task instance.
546
+ *
547
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance Microsoft Documentation}
548
+ * @example
549
+ * await adminClient.GetActionsOnPlayersInSegmentTaskInstance({
550
+ * "TaskInstanceId": "E52531B47B1761C7-4"
551
+ * });
552
+ */
553
+ GetActionsOnPlayersInSegmentTaskInstance(request, extraHeaders) {
554
+ return this.ExecuteRequestWrapper("/Admin/GetActionsOnPlayersInSegmentTaskInstance", request, "X-SecretKey", extraHeaders);
555
+ }
556
+ /**
557
+ * Retrieve a list of all PlayStream actions groups.
558
+ *
559
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallactiongroups Microsoft Documentation}
560
+ * @deprecated Please use GetTasks instead.
561
+ */
562
+ GetAllActionGroups(request, extraHeaders) {
563
+ return this.ExecuteRequestWrapper("/Admin/GetAllActionGroups", request, "X-SecretKey", extraHeaders);
564
+ }
565
+ /**
566
+ * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
567
+ * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
568
+ *
569
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments Microsoft Documentation}
570
+ * @example
571
+ * await adminClient.GetAllSegments({});
572
+ */
573
+ GetAllSegments(request, extraHeaders) {
574
+ return this.ExecuteRequestWrapper("/Admin/GetAllSegments", request, "X-SecretKey", extraHeaders);
575
+ }
576
+ /**
577
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
578
+ * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
579
+ *
580
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getcatalogitems Microsoft Documentation}
581
+ * @example
582
+ * await adminClient.GetCatalogItems({
583
+ * "CatalogVersion": "1"
584
+ * });
585
+ */
586
+ GetCatalogItems(request, extraHeaders) {
587
+ return this.ExecuteRequestWrapper("/Admin/GetCatalogItems", request, "X-SecretKey", extraHeaders);
588
+ }
589
+ /**
590
+ * Get detail information about a CloudScript Azure Functions task instance.
591
+ *
592
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscriptazurefunctionstaskinstance Microsoft Documentation}
593
+ * @example
594
+ * await adminClient.GetCloudScriptAzureFunctionsTaskInstance({
595
+ * "TaskInstanceId": "E52531B47B1761C7-4"
596
+ * });
597
+ */
598
+ GetCloudScriptAzureFunctionsTaskInstance(request, extraHeaders) {
599
+ return this.ExecuteRequestWrapper("/Admin/GetCloudScriptAzureFunctionsTaskInstance", request, "X-SecretKey", extraHeaders);
600
+ }
601
+ /**
602
+ * Gets the contents and information of a specific Cloud Script revision.
603
+ *
604
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision Microsoft Documentation}
605
+ * @example
606
+ * await adminClient.GetCloudScriptRevision({
607
+ * "Version": 1,
608
+ * "Revision": 3
609
+ * });
610
+ */
611
+ GetCloudScriptRevision(request, extraHeaders) {
612
+ return this.ExecuteRequestWrapper("/Admin/GetCloudScriptRevision", request, "X-SecretKey", extraHeaders);
613
+ }
614
+ /**
615
+ * Get detail information about a CloudScript task instance.
616
+ *
617
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance Microsoft Documentation}
618
+ * @example
619
+ * await adminClient.GetCloudScriptTaskInstance({
620
+ * "TaskInstanceId": "E52531B47B1761C7-4"
621
+ * });
622
+ */
623
+ GetCloudScriptTaskInstance(request, extraHeaders) {
624
+ return this.ExecuteRequestWrapper("/Admin/GetCloudScriptTaskInstance", request, "X-SecretKey", extraHeaders);
625
+ }
626
+ /**
627
+ * Lists all the current cloud script versions. For each version, information about the current published and latest
628
+ * revisions is also listed.
629
+ *
630
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions Microsoft Documentation}
631
+ * @example
632
+ * await adminClient.GetCloudScriptVersions({});
633
+ */
634
+ GetCloudScriptVersions(request, extraHeaders) {
635
+ return this.ExecuteRequestWrapper("/Admin/GetCloudScriptVersions", request, "X-SecretKey", extraHeaders);
636
+ }
637
+ /**
638
+ * List all contents of the title and get statistics such as size
639
+ *
640
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist Microsoft Documentation}
641
+ * @example
642
+ * await adminClient.GetContentList({
643
+ * "Prefix": "2016/1"
644
+ * });
645
+ */
646
+ GetContentList(request, extraHeaders) {
647
+ return this.ExecuteRequestWrapper("/Admin/GetContentList", request, "X-SecretKey", extraHeaders);
648
+ }
649
+ /**
650
+ * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the
651
+ * content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN
652
+ * rates apply.
653
+ *
654
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentuploadurl Microsoft Documentation}
655
+ * @example
656
+ * await adminClient.GetContentUploadUrl({
657
+ * "Key": "images/sword_icon.png",
658
+ * "ContentType": "image/png"
659
+ * });
660
+ */
661
+ GetContentUploadUrl(request, extraHeaders) {
662
+ return this.ExecuteRequestWrapper("/Admin/GetContentUploadUrl", request, "X-SecretKey", extraHeaders);
663
+ }
664
+ /**
665
+ * Retrieves a download URL for the requested report
666
+ *
667
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport Microsoft Documentation}
668
+ * @example
669
+ * await adminClient.GetDataReport({
670
+ * "ReportName": "PurchaseDataReport",
671
+ * "Year": 2014,
672
+ * "Month": 12,
673
+ * "Day": 5
674
+ * });
675
+ */
676
+ GetDataReport(request, extraHeaders) {
677
+ return this.ExecuteRequestWrapper("/Admin/GetDataReport", request, "X-SecretKey", extraHeaders);
678
+ }
679
+ /**
680
+ * Retrieves the set of sinks to which to route PlayStream and Telemetry event data.
681
+ *
682
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/geteventsinks Microsoft Documentation}
683
+ * @example
684
+ * await adminClient.GetEventSinks({});
685
+ */
686
+ GetEventSinks(request, extraHeaders) {
687
+ return this.ExecuteRequestWrapper("/Admin/GetEventSinks", request, "X-SecretKey", extraHeaders);
688
+ }
689
+ /**
690
+ * Retrieves the details for a specific completed session, including links to standard out and standard error logs
691
+ *
692
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/getmatchmakergameinfo Microsoft Documentation}
693
+ * @deprecated Please use MultiplayerServer/GetMultiplayerSessionLogsBySessionId instead.
694
+ */
695
+ GetMatchmakerGameInfo(request, extraHeaders) {
696
+ return this.ExecuteRequestWrapper("/Admin/GetMatchmakerGameInfo", request, "X-SecretKey", extraHeaders);
697
+ }
698
+ /**
699
+ * Retrieves the details of defined game modes for the specified game server executable
700
+ *
701
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/getmatchmakergamemodes Microsoft Documentation}
702
+ * @deprecated Do not use
703
+ */
704
+ GetMatchmakerGameModes(request, extraHeaders) {
705
+ return this.ExecuteRequestWrapper("/Admin/GetMatchmakerGameModes", request, "X-SecretKey", extraHeaders);
706
+ }
707
+ /**
708
+ * Get the list of titles that the player has played
709
+ *
710
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist Microsoft Documentation}
711
+ * @example
712
+ * await adminClient.GetPlayedTitleList({
713
+ * "PlayFabId": "A68C908B66C23C5"
714
+ * });
715
+ */
716
+ GetPlayedTitleList(request, extraHeaders) {
717
+ return this.ExecuteRequestWrapper("/Admin/GetPlayedTitleList", request, "X-SecretKey", extraHeaders);
718
+ }
719
+ /**
720
+ * Retrieves a title-specific custom property value for a player.
721
+ *
722
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty Microsoft Documentation}
723
+ * @example
724
+ * await adminClient.GetPlayerCustomProperty({
725
+ * "PlayFabId": "2039475",
726
+ * "PropertyName": "level"
727
+ * });
728
+ */
729
+ GetPlayerCustomProperty(request, extraHeaders) {
730
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerCustomProperty", request, "X-SecretKey", extraHeaders);
731
+ }
732
+ /**
733
+ * Gets a player's ID from an auth token.
734
+ *
735
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken Microsoft Documentation}
736
+ * @example
737
+ * await adminClient.GetPlayerIdFromAuthToken({
738
+ * "Token": "3F584AD0EF943E2",
739
+ * "TokenType": "Email"
740
+ * });
741
+ */
742
+ GetPlayerIdFromAuthToken(request, extraHeaders) {
743
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerIdFromAuthToken", request, "X-SecretKey", extraHeaders);
744
+ }
745
+ /**
746
+ * Retrieves the player's profile
747
+ *
748
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile Microsoft Documentation}
749
+ * @example
750
+ * await adminClient.GetPlayerProfile({
751
+ * "PlayFabId": "621EF20237534A44"
752
+ * });
753
+ */
754
+ GetPlayerProfile(request, extraHeaders) {
755
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerProfile", request, "X-SecretKey", extraHeaders);
756
+ }
757
+ /**
758
+ * List all segments that a player currently belongs to at this moment in time.
759
+ *
760
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments Microsoft Documentation}
761
+ * @example
762
+ * await adminClient.GetPlayerSegments({
763
+ * "PlayFabId": "1337AA00"
764
+ * });
765
+ */
766
+ GetPlayerSegments(request, extraHeaders) {
767
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerSegments", request, "X-SecretKey", extraHeaders);
768
+ }
769
+ /**
770
+ * Returns all Player Shared Secret Keys including disabled and expired.
771
+ *
772
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets Microsoft Documentation}
773
+ * @example
774
+ * await adminClient.GetPlayerSharedSecrets({});
775
+ */
776
+ GetPlayerSharedSecrets(request, extraHeaders) {
777
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerSharedSecrets", request, "X-SecretKey", extraHeaders);
778
+ }
779
+ /**
780
+ * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
781
+ * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
782
+ * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
783
+ * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
784
+ * called 30 times in one minute. You will be returned an error if you exceed this threshold.
785
+ *
786
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment Microsoft Documentation}
787
+ * @example
788
+ * await adminClient.GetPlayersInSegment({
789
+ * "SegmentId": "1337AA00",
790
+ * "SecondsToLive": 5,
791
+ * "MaxBatchSize": 500
792
+ * });
793
+ */
794
+ GetPlayersInSegment(request, extraHeaders) {
795
+ return this.ExecuteRequestWrapper("/Admin/GetPlayersInSegment", request, "X-SecretKey", extraHeaders);
796
+ }
797
+ /**
798
+ * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have
799
+ * a reset interval.
800
+ *
801
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions Microsoft Documentation}
802
+ * @example
803
+ * await adminClient.GetPlayerStatisticDefinitions({});
804
+ */
805
+ GetPlayerStatisticDefinitions(request, extraHeaders) {
806
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerStatisticDefinitions", request, "X-SecretKey", extraHeaders);
807
+ }
808
+ /**
809
+ * Retrieves the information on the available versions of the specified statistic.
810
+ *
811
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions Microsoft Documentation}
812
+ * @example
813
+ * await adminClient.GetPlayerStatisticVersions({
814
+ * "StatisticName": "headshots"
815
+ * });
816
+ */
817
+ GetPlayerStatisticVersions(request, extraHeaders) {
818
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerStatisticVersions", request, "X-SecretKey", extraHeaders);
819
+ }
820
+ /**
821
+ * Get all tags with a given Namespace (optional) from a player profile.
822
+ *
823
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags Microsoft Documentation}
824
+ * @example
825
+ * await adminClient.GetPlayerTags({
826
+ * "PlayFabId": "10931252888739651331",
827
+ * "Namespace": "title.AAA"
828
+ * });
829
+ */
830
+ GetPlayerTags(request, extraHeaders) {
831
+ return this.ExecuteRequestWrapper("/Admin/GetPlayerTags", request, "X-SecretKey", extraHeaders);
832
+ }
833
+ /**
834
+ * Gets the requested policy.
835
+ *
836
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy Microsoft Documentation}
837
+ * @example
838
+ * await adminClient.GetPolicy({
839
+ * "PolicyName": "ApiPolicy"
840
+ * });
841
+ */
842
+ GetPolicy(request, extraHeaders) {
843
+ return this.ExecuteRequestWrapper("/Admin/GetPolicy", request, "X-SecretKey", extraHeaders);
844
+ }
845
+ /**
846
+ * Retrieves the key-value store of custom publisher settings
847
+ *
848
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata Microsoft Documentation}
849
+ * @example
850
+ * await adminClient.GetPublisherData({
851
+ * "Keys": [
852
+ * "color",
853
+ * "propertyA"
854
+ * ]
855
+ * });
856
+ */
857
+ GetPublisherData(request, extraHeaders) {
858
+ return this.ExecuteRequestWrapper("/Admin/GetPublisherData", request, "X-SecretKey", extraHeaders);
859
+ }
860
+ /**
861
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
862
+ * version 2._ Retrieves the random drop table configuration for the title
863
+ *
864
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables Microsoft Documentation}
865
+ * @example
866
+ * await adminClient.GetRandomResultTables({});
867
+ */
868
+ GetRandomResultTables(request, extraHeaders) {
869
+ return this.ExecuteRequestWrapper("/Admin/GetRandomResultTables", request, "X-SecretKey", extraHeaders);
870
+ }
871
+ /**
872
+ * Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and
873
+ * complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls
874
+ * from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of
875
+ * the export
876
+ *
877
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport Microsoft Documentation}
878
+ * @example
879
+ * await adminClient.GetSegmentExport({
880
+ * "ExportId": "ABCDEF1234567890"
881
+ * });
882
+ */
883
+ GetSegmentExport(request, extraHeaders) {
884
+ return this.ExecuteRequestWrapper("/Admin/GetSegmentExport", request, "X-SecretKey", extraHeaders);
885
+ }
886
+ /**
887
+ * Get detail information of a segment and its associated definition(s) and action(s) for a title.
888
+ *
889
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments Microsoft Documentation}
890
+ * @example
891
+ * await adminClient.GetSegments({
892
+ * "SegmentIds": [
893
+ * "B05FC8CB558A6570",
894
+ * "97EF0E9302CBE996"
895
+ * ]
896
+ * });
897
+ */
898
+ GetSegments(request, extraHeaders) {
899
+ return this.ExecuteRequestWrapper("/Admin/GetSegments", request, "X-SecretKey", extraHeaders);
900
+ }
901
+ /**
902
+ * Retrieves the build details for the specified game server executable
903
+ *
904
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/getserverbuildinfo Microsoft Documentation}
905
+ * @deprecated Do not use
906
+ */
907
+ GetServerBuildInfo(request, extraHeaders) {
908
+ return this.ExecuteRequestWrapper("/Admin/GetServerBuildInfo", request, "X-SecretKey", extraHeaders);
909
+ }
910
+ /**
911
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
912
+ * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
913
+ *
914
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems Microsoft Documentation}
915
+ * @example
916
+ * await adminClient.GetStoreItems({
917
+ * "StoreId": "BonusStore"
918
+ * });
919
+ */
920
+ GetStoreItems(request, extraHeaders) {
921
+ return this.ExecuteRequestWrapper("/Admin/GetStoreItems", request, "X-SecretKey", extraHeaders);
922
+ }
923
+ /**
924
+ * Query for task instances by task, status, or time range.
925
+ *
926
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances Microsoft Documentation}
927
+ * @example
928
+ * await adminClient.GetTaskInstances({
929
+ * "StatusFilter": "Failed",
930
+ * "StartedAtRangeFrom": "2016-08-23T11:00:00Z"
931
+ * });
932
+ */
933
+ GetTaskInstances(request, extraHeaders) {
934
+ return this.ExecuteRequestWrapper("/Admin/GetTaskInstances", request, "X-SecretKey", extraHeaders);
935
+ }
936
+ /**
937
+ * Get definition information on a specified task or all tasks within a title.
938
+ *
939
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks Microsoft Documentation}
940
+ * @example
941
+ * await adminClient.GetTasks({
942
+ * "Identifier": {
943
+ * "Name": "EnableDailyHappyHour"
944
+ * }
945
+ * });
946
+ */
947
+ GetTasks(request, extraHeaders) {
948
+ return this.ExecuteRequestWrapper("/Admin/GetTasks", request, "X-SecretKey", extraHeaders);
949
+ }
950
+ /**
951
+ * Retrieves the key-value store of custom title settings which can be read by the client
952
+ *
953
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata Microsoft Documentation}
954
+ * @example
955
+ * await adminClient.GetTitleData({
956
+ * "Keys": [
957
+ * "color",
958
+ * "propertyA"
959
+ * ]
960
+ * });
961
+ */
962
+ GetTitleData(request, extraHeaders) {
963
+ return this.ExecuteRequestWrapper("/Admin/GetTitleData", request, "X-SecretKey", extraHeaders);
964
+ }
965
+ /**
966
+ * Retrieves the key-value store of custom title settings which cannot be read by the client
967
+ *
968
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata Microsoft Documentation}
969
+ * @example
970
+ * await adminClient.GetTitleInternalData({
971
+ * "Keys": [
972
+ * "color",
973
+ * "propertyA"
974
+ * ]
975
+ * });
976
+ */
977
+ GetTitleInternalData(request, extraHeaders) {
978
+ return this.ExecuteRequestWrapper("/Admin/GetTitleInternalData", request, "X-SecretKey", extraHeaders);
979
+ }
980
+ /**
981
+ * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
982
+ *
983
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo Microsoft Documentation}
984
+ * @example
985
+ * await adminClient.GetUserAccountInfo({
986
+ * "PlayFabId": "293753934",
987
+ * "IgnoreMissingTitleActivation": false
988
+ * });
989
+ */
990
+ GetUserAccountInfo(request, extraHeaders) {
991
+ return this.ExecuteRequestWrapper("/Admin/GetUserAccountInfo", request, "X-SecretKey", extraHeaders);
992
+ }
993
+ /**
994
+ * Gets all bans for a user.
995
+ *
996
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans Microsoft Documentation}
997
+ * @example
998
+ * await adminClient.GetUserBans({
999
+ * "PlayFabId": "1679AF5CD04BD838"
1000
+ * });
1001
+ */
1002
+ GetUserBans(request, extraHeaders) {
1003
+ return this.ExecuteRequestWrapper("/Admin/GetUserBans", request, "X-SecretKey", extraHeaders);
1004
+ }
1005
+ /**
1006
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
1007
+ *
1008
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserdata Microsoft Documentation}
1009
+ * @example
1010
+ * await adminClient.GetUserData({
1011
+ * "PlayFabId": "2039475",
1012
+ * "Keys": [
1013
+ * "preferences",
1014
+ * "progress"
1015
+ * ],
1016
+ * "IfChangedFromDataVersion": 13
1017
+ * });
1018
+ */
1019
+ GetUserData(request, extraHeaders) {
1020
+ return this.ExecuteRequestWrapper("/Admin/GetUserData", request, "X-SecretKey", extraHeaders);
1021
+ }
1022
+ /**
1023
+ * Retrieves the title-specific custom data for the user which cannot be accessed by the client
1024
+ *
1025
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserinternaldata Microsoft Documentation}
1026
+ * @example
1027
+ * await adminClient.GetUserInternalData({
1028
+ * "PlayFabId": "2039475",
1029
+ * "Keys": [
1030
+ * "preferences",
1031
+ * "progress"
1032
+ * ],
1033
+ * "IfChangedFromDataVersion": 13
1034
+ * });
1035
+ */
1036
+ GetUserInternalData(request, extraHeaders) {
1037
+ return this.ExecuteRequestWrapper("/Admin/GetUserInternalData", request, "X-SecretKey", extraHeaders);
1038
+ }
1039
+ /**
1040
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1041
+ * version 2._ Retrieves the specified user's current inventory of virtual goods
1042
+ *
1043
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/getuserinventory Microsoft Documentation}
1044
+ * @example
1045
+ * await adminClient.GetUserInventory({
1046
+ * "PlayFabId": "204883457"
1047
+ * });
1048
+ */
1049
+ GetUserInventory(request, extraHeaders) {
1050
+ return this.ExecuteRequestWrapper("/Admin/GetUserInventory", request, "X-SecretKey", extraHeaders);
1051
+ }
1052
+ /**
1053
+ * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
1054
+ *
1055
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherdata Microsoft Documentation}
1056
+ * @example
1057
+ * await adminClient.GetUserPublisherData({
1058
+ * "PlayFabId": "2039475",
1059
+ * "Keys": [
1060
+ * "preferences",
1061
+ * "progress"
1062
+ * ],
1063
+ * "IfChangedFromDataVersion": 13
1064
+ * });
1065
+ */
1066
+ GetUserPublisherData(request, extraHeaders) {
1067
+ return this.ExecuteRequestWrapper("/Admin/GetUserPublisherData", request, "X-SecretKey", extraHeaders);
1068
+ }
1069
+ /**
1070
+ * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
1071
+ *
1072
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherinternaldata Microsoft Documentation}
1073
+ * @example
1074
+ * await adminClient.GetUserPublisherInternalData({
1075
+ * "PlayFabId": "2039475",
1076
+ * "Keys": [
1077
+ * "preferences",
1078
+ * "progress"
1079
+ * ],
1080
+ * "IfChangedFromDataVersion": 13
1081
+ * });
1082
+ */
1083
+ GetUserPublisherInternalData(request, extraHeaders) {
1084
+ return this.ExecuteRequestWrapper("/Admin/GetUserPublisherInternalData", request, "X-SecretKey", extraHeaders);
1085
+ }
1086
+ /**
1087
+ * Retrieves the publisher-specific custom data for the user which can only be read by the client
1088
+ *
1089
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
1090
+ * @example
1091
+ * await adminClient.GetUserPublisherReadOnlyData({
1092
+ * "PlayFabId": "2039475",
1093
+ * "Keys": [
1094
+ * "preferences",
1095
+ * "progress"
1096
+ * ],
1097
+ * "IfChangedFromDataVersion": 13
1098
+ * });
1099
+ */
1100
+ GetUserPublisherReadOnlyData(request, extraHeaders) {
1101
+ return this.ExecuteRequestWrapper("/Admin/GetUserPublisherReadOnlyData", request, "X-SecretKey", extraHeaders);
1102
+ }
1103
+ /**
1104
+ * Retrieves the title-specific custom data for the user which can only be read by the client
1105
+ *
1106
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserreadonlydata Microsoft Documentation}
1107
+ * @example
1108
+ * await adminClient.GetUserReadOnlyData({
1109
+ * "PlayFabId": "2039475",
1110
+ * "Keys": [
1111
+ * "preferences",
1112
+ * "progress"
1113
+ * ],
1114
+ * "IfChangedFromDataVersion": 13
1115
+ * });
1116
+ */
1117
+ GetUserReadOnlyData(request, extraHeaders) {
1118
+ return this.ExecuteRequestWrapper("/Admin/GetUserReadOnlyData", request, "X-SecretKey", extraHeaders);
1119
+ }
1120
+ /**
1121
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1122
+ * version 2._ Adds the specified items to the specified user inventories
1123
+ *
1124
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers Microsoft Documentation}
1125
+ * @example
1126
+ * await adminClient.GrantItemsToUsers({
1127
+ * "CatalogVersion": "5",
1128
+ * "ItemGrants": [
1129
+ * {
1130
+ * "PlayFabId": "20394883",
1131
+ * "ItemId": "shield_level_1",
1132
+ * "Annotation": "Entered Level 2"
1133
+ * },
1134
+ * {
1135
+ * "PlayFabId": "20394883",
1136
+ * "ItemId": "shield_level_2",
1137
+ * "Annotation": "Entered Level 2",
1138
+ * "Data": {
1139
+ * "Equipped": "True",
1140
+ * "Slot": "Head"
1141
+ * }
1142
+ * }
1143
+ * ]
1144
+ * });
1145
+ */
1146
+ GrantItemsToUsers(request, extraHeaders) {
1147
+ return this.ExecuteRequestWrapper("/Admin/GrantItemsToUsers", request, "X-SecretKey", extraHeaders);
1148
+ }
1149
+ /**
1150
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1151
+ * version 2._ Increases the global count for the given scarce resource.
1152
+ *
1153
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability Microsoft Documentation}
1154
+ * @example
1155
+ * await adminClient.IncrementLimitedEditionItemAvailability({
1156
+ * "CatalogVersion": "Rares",
1157
+ * "ItemId": "FreeHoodie",
1158
+ * "Amount": 50
1159
+ * });
1160
+ */
1161
+ IncrementLimitedEditionItemAvailability(request, extraHeaders) {
1162
+ return this.ExecuteRequestWrapper("/Admin/IncrementLimitedEditionItemAvailability", request, "X-SecretKey", extraHeaders);
1163
+ }
1164
+ /**
1165
+ * Resets the indicated statistic, removing all player entries for it and backing up the old values.
1166
+ *
1167
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion Microsoft Documentation}
1168
+ * @example
1169
+ * await adminClient.IncrementPlayerStatisticVersion({
1170
+ * "StatisticName": "headshots"
1171
+ * });
1172
+ */
1173
+ IncrementPlayerStatisticVersion(request, extraHeaders) {
1174
+ return this.ExecuteRequestWrapper("/Admin/IncrementPlayerStatisticVersion", request, "X-SecretKey", extraHeaders);
1175
+ }
1176
+ /**
1177
+ * Retrieves a list of all Open ID Connect providers registered to a title.
1178
+ *
1179
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection Microsoft Documentation}
1180
+ * @example
1181
+ * await adminClient.ListOpenIdConnection({});
1182
+ */
1183
+ ListOpenIdConnection(request, extraHeaders) {
1184
+ return this.ExecuteRequestWrapper("/Admin/ListOpenIdConnection", request, "X-SecretKey", extraHeaders);
1185
+ }
1186
+ /**
1187
+ * Retrieves title-specific custom property values for a player.
1188
+ *
1189
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties Microsoft Documentation}
1190
+ * @example
1191
+ * await adminClient.ListPlayerCustomProperties({
1192
+ * "PlayFabId": "2039475"
1193
+ * });
1194
+ */
1195
+ ListPlayerCustomProperties(request, extraHeaders) {
1196
+ return this.ExecuteRequestWrapper("/Admin/ListPlayerCustomProperties", request, "X-SecretKey", extraHeaders);
1197
+ }
1198
+ /**
1199
+ * Retrieves the build details for all game server executables which are currently defined for the title
1200
+ *
1201
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/listserverbuilds Microsoft Documentation}
1202
+ * @deprecated Do not use
1203
+ */
1204
+ ListServerBuilds(request, extraHeaders) {
1205
+ return this.ExecuteRequestWrapper("/Admin/ListServerBuilds", request, "X-SecretKey", extraHeaders);
1206
+ }
1207
+ /**
1208
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1209
+ * version 2._ Retuns the list of all defined virtual currencies for the title
1210
+ *
1211
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes Microsoft Documentation}
1212
+ * @example
1213
+ * await adminClient.ListVirtualCurrencyTypes({});
1214
+ */
1215
+ ListVirtualCurrencyTypes(request, extraHeaders) {
1216
+ return this.ExecuteRequestWrapper("/Admin/ListVirtualCurrencyTypes", request, "X-SecretKey", extraHeaders);
1217
+ }
1218
+ /**
1219
+ * Updates the game server mode details for the specified game server executable
1220
+ *
1221
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/modifymatchmakergamemodes Microsoft Documentation}
1222
+ * @deprecated Do not use
1223
+ */
1224
+ ModifyMatchmakerGameModes(request, extraHeaders) {
1225
+ return this.ExecuteRequestWrapper("/Admin/ModifyMatchmakerGameModes", request, "X-SecretKey", extraHeaders);
1226
+ }
1227
+ /**
1228
+ * Updates the build details for the specified game server executable
1229
+ *
1230
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/modifyserverbuild Microsoft Documentation}
1231
+ * @deprecated Do not use
1232
+ */
1233
+ ModifyServerBuild(request, extraHeaders) {
1234
+ return this.ExecuteRequestWrapper("/Admin/ModifyServerBuild", request, "X-SecretKey", extraHeaders);
1235
+ }
1236
+ /**
1237
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1238
+ * version 2._ Attempts to process an order refund through the original real money payment provider.
1239
+ *
1240
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase Microsoft Documentation}
1241
+ * @example
1242
+ * await adminClient.RefundPurchase({
1243
+ * "PlayFabId": "20394883",
1244
+ * "OrderId": "B456AE0",
1245
+ * "Reason": "Customer Request"
1246
+ * });
1247
+ */
1248
+ RefundPurchase(request, extraHeaders) {
1249
+ return this.ExecuteRequestWrapper("/Admin/RefundPurchase", request, "X-SecretKey", extraHeaders);
1250
+ }
1251
+ /**
1252
+ * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
1253
+ *
1254
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag Microsoft Documentation}
1255
+ * @example
1256
+ * await adminClient.RemovePlayerTag({
1257
+ * "PlayFabId": "10931252888739651331",
1258
+ * "TagName": "MostKilled"
1259
+ * });
1260
+ */
1261
+ RemovePlayerTag(request, extraHeaders) {
1262
+ return this.ExecuteRequestWrapper("/Admin/RemovePlayerTag", request, "X-SecretKey", extraHeaders);
1263
+ }
1264
+ /**
1265
+ * Removes the game server executable specified from the set of those a client is permitted to request in a call to
1266
+ * StartGame
1267
+ *
1268
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/removeserverbuild Microsoft Documentation}
1269
+ * @deprecated Do not use
1270
+ */
1271
+ RemoveServerBuild(request, extraHeaders) {
1272
+ return this.ExecuteRequestWrapper("/Admin/RemoveServerBuild", request, "X-SecretKey", extraHeaders);
1273
+ }
1274
+ /**
1275
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1276
+ * version 2._ Removes one or more virtual currencies from the set defined for the title.
1277
+ *
1278
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes Microsoft Documentation}
1279
+ * @example
1280
+ * await adminClient.RemoveVirtualCurrencyTypes({
1281
+ * "VirtualCurrencies": [
1282
+ * {
1283
+ * "CurrencyCode": "CC"
1284
+ * },
1285
+ * {
1286
+ * "CurrencyCode": "GC"
1287
+ * }
1288
+ * ]
1289
+ * });
1290
+ */
1291
+ RemoveVirtualCurrencyTypes(request, extraHeaders) {
1292
+ return this.ExecuteRequestWrapper("/Admin/RemoveVirtualCurrencyTypes", request, "X-SecretKey", extraHeaders);
1293
+ }
1294
+ /**
1295
+ * Completely removes all statistics for the specified character, for the current game
1296
+ *
1297
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics Microsoft Documentation}
1298
+ * @example
1299
+ * await adminClient.ResetCharacterStatistics({
1300
+ * "PlayFabId": "293753934",
1301
+ * "CharacterId": "7654321"
1302
+ * });
1303
+ */
1304
+ ResetCharacterStatistics(request, extraHeaders) {
1305
+ return this.ExecuteRequestWrapper("/Admin/ResetCharacterStatistics", request, "X-SecretKey", extraHeaders);
1306
+ }
1307
+ /**
1308
+ * Reset a player's password for a given title.
1309
+ *
1310
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword Microsoft Documentation}
1311
+ * @example
1312
+ * await adminClient.ResetPassword({
1313
+ * "Token": "2B584FA1DF645E4",
1314
+ * "Password": "ExampleSecret@r"
1315
+ * });
1316
+ */
1317
+ ResetPassword(request, extraHeaders) {
1318
+ return this.ExecuteRequestWrapper("/Admin/ResetPassword", request, "X-SecretKey", extraHeaders);
1319
+ }
1320
+ /**
1321
+ * Resets all title-specific information about a particular account, including user data, virtual currency balances,
1322
+ * inventory, purchase history, and statistics
1323
+ *
1324
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetusers Microsoft Documentation}
1325
+ * @deprecated Please use DeletePlayer instead.
1326
+ */
1327
+ ResetUsers(request, extraHeaders) {
1328
+ return this.ExecuteRequestWrapper("/Admin/ResetUsers", request, "X-SecretKey", extraHeaders);
1329
+ }
1330
+ /**
1331
+ * Completely removes all statistics for the specified user, for the current game
1332
+ *
1333
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics Microsoft Documentation}
1334
+ * @example
1335
+ * await adminClient.ResetUserStatistics({
1336
+ * "PlayFabId": "293753934"
1337
+ * });
1338
+ */
1339
+ ResetUserStatistics(request, extraHeaders) {
1340
+ return this.ExecuteRequestWrapper("/Admin/ResetUserStatistics", request, "X-SecretKey", extraHeaders);
1341
+ }
1342
+ /**
1343
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1344
+ * version 2._ Attempts to resolve a dispute with the original order's payment provider.
1345
+ *
1346
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute Microsoft Documentation}
1347
+ * @example
1348
+ * await adminClient.ResolvePurchaseDispute({
1349
+ * "PlayFabId": "20394883",
1350
+ * "OrderId": "B456AE0",
1351
+ * "Reason": "Customer Request",
1352
+ * "Outcome": "Reinstate"
1353
+ * });
1354
+ */
1355
+ ResolvePurchaseDispute(request, extraHeaders) {
1356
+ return this.ExecuteRequestWrapper("/Admin/ResolvePurchaseDispute", request, "X-SecretKey", extraHeaders);
1357
+ }
1358
+ /**
1359
+ * Revoke all active bans for a user.
1360
+ *
1361
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser Microsoft Documentation}
1362
+ * @example
1363
+ * await adminClient.RevokeAllBansForUser({
1364
+ * "PlayFabId": "1679AF5CD04BD838"
1365
+ * });
1366
+ */
1367
+ RevokeAllBansForUser(request, extraHeaders) {
1368
+ return this.ExecuteRequestWrapper("/Admin/RevokeAllBansForUser", request, "X-SecretKey", extraHeaders);
1369
+ }
1370
+ /**
1371
+ * Revoke all active bans specified with BanId.
1372
+ *
1373
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans Microsoft Documentation}
1374
+ * @example
1375
+ * await adminClient.RevokeBans({
1376
+ * "BanIds": [
1377
+ * "E0B5FF89542D413C",
1378
+ * "EF43FF89542G1546"
1379
+ * ]
1380
+ * });
1381
+ */
1382
+ RevokeBans(request, extraHeaders) {
1383
+ return this.ExecuteRequestWrapper("/Admin/RevokeBans", request, "X-SecretKey", extraHeaders);
1384
+ }
1385
+ /**
1386
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1387
+ * version 2._ Revokes access to an item in a user's inventory
1388
+ *
1389
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem Microsoft Documentation}
1390
+ * @example
1391
+ * await adminClient.RevokeInventoryItem({
1392
+ * "PlayFabId": "203945882",
1393
+ * "ItemInstanceId": "2048583045"
1394
+ * });
1395
+ */
1396
+ RevokeInventoryItem(request, extraHeaders) {
1397
+ return this.ExecuteRequestWrapper("/Admin/RevokeInventoryItem", request, "X-SecretKey", extraHeaders);
1398
+ }
1399
+ /**
1400
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1401
+ * version 2._ Revokes access for up to 25 items across multiple users and characters.
1402
+ *
1403
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems Microsoft Documentation}
1404
+ * @example
1405
+ * await adminClient.RevokeInventoryItems({
1406
+ * "Items": [
1407
+ * {
1408
+ * "PlayFabId": "203945882",
1409
+ * "ItemInstanceId": "2048583045"
1410
+ * }
1411
+ * ]
1412
+ * });
1413
+ */
1414
+ RevokeInventoryItems(request, extraHeaders) {
1415
+ return this.ExecuteRequestWrapper("/Admin/RevokeInventoryItems", request, "X-SecretKey", extraHeaders);
1416
+ }
1417
+ /**
1418
+ * Run a task immediately regardless of its schedule.
1419
+ *
1420
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask Microsoft Documentation}
1421
+ * @example
1422
+ * await adminClient.RunTask({
1423
+ * "Identifier": {
1424
+ * "Id": "E1772FD927D8539D"
1425
+ * }
1426
+ * });
1427
+ */
1428
+ RunTask(request, extraHeaders) {
1429
+ return this.ExecuteRequestWrapper("/Admin/RunTask", request, "X-SecretKey", extraHeaders);
1430
+ }
1431
+ /**
1432
+ * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
1433
+ * change the password.If an account recovery email template ID is provided, an email using the custom email template will
1434
+ * be used.
1435
+ *
1436
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail Microsoft Documentation}
1437
+ * @example
1438
+ * await adminClient.SendAccountRecoveryEmail({
1439
+ * "Email": "assignedemail@here.com",
1440
+ * "EmailTemplateId": "D53AB15D8F12E330"
1441
+ * });
1442
+ */
1443
+ SendAccountRecoveryEmail(request, extraHeaders) {
1444
+ return this.ExecuteRequestWrapper("/Admin/SendAccountRecoveryEmail", request, "X-SecretKey", extraHeaders);
1445
+ }
1446
+ /**
1447
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1448
+ * version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version
1449
+ *
1450
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems Microsoft Documentation}
1451
+ * @example
1452
+ * await adminClient.SetCatalogItems({
1453
+ * "CatalogVersion": "5",
1454
+ * "Catalog": [
1455
+ * {
1456
+ * "ItemId": "shield_level_5",
1457
+ * "ItemClass": "shields",
1458
+ * "DisplayName": "Level 5 Shield",
1459
+ * "Description": "Strong defense against projectile attacks",
1460
+ * "VirtualCurrencyPrices": {
1461
+ * "RM": 199,
1462
+ * "GV": 25
1463
+ * },
1464
+ * "RealCurrencyPrices": {
1465
+ * "GBP": 149,
1466
+ * "EUR": 169
1467
+ * },
1468
+ * "CanBecomeCharacter": false,
1469
+ * "IsStackable": false,
1470
+ * "IsTradable": false,
1471
+ * "IsLimitedEdition": false,
1472
+ * "InitialLimitedEditionCount": 0
1473
+ * },
1474
+ * {
1475
+ * "ItemId": "energy_boost_1",
1476
+ * "ItemClass": "boosts",
1477
+ * "DisplayName": "Energy Drink Six-Pack",
1478
+ * "Description": "Get a quick burst of energy whenever you need it",
1479
+ * "VirtualCurrencyPrices": {
1480
+ * "RM": 199,
1481
+ * "GV": 25
1482
+ * },
1483
+ * "CanBecomeCharacter": false,
1484
+ * "IsStackable": false,
1485
+ * "IsTradable": false,
1486
+ * "IsLimitedEdition": false,
1487
+ * "InitialLimitedEditionCount": 0
1488
+ * },
1489
+ * {
1490
+ * "ItemId": "required_item_for_grant_a_1",
1491
+ * "ItemClass": "sets",
1492
+ * "DisplayName": "Grant Set Item 1",
1493
+ * "Description": "Item 1 from the set of items needed to get Granted Item A for free",
1494
+ * "VirtualCurrencyPrices": {
1495
+ * "RM": 249,
1496
+ * "GV": 1500
1497
+ * },
1498
+ * "CanBecomeCharacter": false,
1499
+ * "IsStackable": false,
1500
+ * "IsTradable": false,
1501
+ * "IsLimitedEdition": false,
1502
+ * "InitialLimitedEditionCount": 0
1503
+ * },
1504
+ * {
1505
+ * "ItemId": "required_item_for_grant_a_2",
1506
+ * "ItemClass": "sets",
1507
+ * "DisplayName": "Grant Set Item 2",
1508
+ * "Description": "Item 2 from the set of items needed to get Granted Item A for free",
1509
+ * "VirtualCurrencyPrices": {
1510
+ * "RM": 249,
1511
+ * "GV": 1500
1512
+ * },
1513
+ * "CanBecomeCharacter": false,
1514
+ * "IsStackable": false,
1515
+ * "IsTradable": false,
1516
+ * "IsLimitedEdition": false,
1517
+ * "InitialLimitedEditionCount": 0
1518
+ * },
1519
+ * {
1520
+ * "ItemId": "required_item_for_grant_a_3",
1521
+ * "ItemClass": "sets",
1522
+ * "DisplayName": "Grant Set Item 3",
1523
+ * "Description": "Item 3 from the set of items needed to get Granted Item A for free",
1524
+ * "VirtualCurrencyPrices": {
1525
+ * "RM": 249,
1526
+ * "GV": 1500
1527
+ * },
1528
+ * "CanBecomeCharacter": false,
1529
+ * "IsStackable": false,
1530
+ * "IsTradable": false,
1531
+ * "IsLimitedEdition": false,
1532
+ * "InitialLimitedEditionCount": 0
1533
+ * },
1534
+ * {
1535
+ * "ItemId": "required_item_for_grant_a_4",
1536
+ * "ItemClass": "sets",
1537
+ * "DisplayName": "Grant Set Item 4",
1538
+ * "Description": "Item 4 from the set of items needed to get Granted Item A for free",
1539
+ * "VirtualCurrencyPrices": {
1540
+ * "RM": 249,
1541
+ * "GV": 1500
1542
+ * },
1543
+ * "CanBecomeCharacter": false,
1544
+ * "IsStackable": false,
1545
+ * "IsTradable": false,
1546
+ * "IsLimitedEdition": false,
1547
+ * "InitialLimitedEditionCount": 0
1548
+ * },
1549
+ * {
1550
+ * "ItemId": "granted_item_a",
1551
+ * "ItemClass": "sets",
1552
+ * "DisplayName": "Granted Item A",
1553
+ * "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
1554
+ * "CanBecomeCharacter": false,
1555
+ * "IsStackable": false,
1556
+ * "IsTradable": false,
1557
+ * "IsLimitedEdition": false,
1558
+ * "InitialLimitedEditionCount": 0
1559
+ * },
1560
+ * {
1561
+ * "ItemId": "consumable_item_1",
1562
+ * "ItemClass": "Consumables",
1563
+ * "DisplayName": "Consumable Item 1",
1564
+ * "Description": "Item demonstrating usage-based consumables",
1565
+ * "VirtualCurrencyPrices": {
1566
+ * "GV": 500
1567
+ * },
1568
+ * "Consumable": {
1569
+ * "UsageCount": 3
1570
+ * },
1571
+ * "CanBecomeCharacter": false,
1572
+ * "IsStackable": false,
1573
+ * "IsTradable": false,
1574
+ * "IsLimitedEdition": false,
1575
+ * "InitialLimitedEditionCount": 0
1576
+ * },
1577
+ * {
1578
+ * "ItemId": "consumable_item_2",
1579
+ * "ItemClass": "Consumables",
1580
+ * "DisplayName": "Consumable Item 2",
1581
+ * "Description": "Item demonstrating time-based consumables",
1582
+ * "VirtualCurrencyPrices": {
1583
+ * "GV": 750
1584
+ * },
1585
+ * "Consumable": {
1586
+ * "UsagePeriod": 3600,
1587
+ * "UsagePeriodGroup": "usage_group_1"
1588
+ * },
1589
+ * "CanBecomeCharacter": false,
1590
+ * "IsStackable": false,
1591
+ * "IsTradable": false,
1592
+ * "IsLimitedEdition": false,
1593
+ * "InitialLimitedEditionCount": 0
1594
+ * },
1595
+ * {
1596
+ * "ItemId": "sub_bundle_item_1",
1597
+ * "ItemClass": "Bundles",
1598
+ * "DisplayName": "Bundled Item 1",
1599
+ * "Description": "Item which is added to the user inventory as part of a bundle",
1600
+ * "CanBecomeCharacter": false,
1601
+ * "IsStackable": false,
1602
+ * "IsTradable": false,
1603
+ * "IsLimitedEdition": false,
1604
+ * "InitialLimitedEditionCount": 0
1605
+ * },
1606
+ * {
1607
+ * "ItemId": "sub_bundle_item_2",
1608
+ * "ItemClass": "Bundles",
1609
+ * "DisplayName": "Bundled Item 2",
1610
+ * "Description": "Item which is added to the user inventory as part of a bundle",
1611
+ * "CanBecomeCharacter": false,
1612
+ * "IsStackable": false,
1613
+ * "IsTradable": false,
1614
+ * "IsLimitedEdition": false,
1615
+ * "InitialLimitedEditionCount": 0
1616
+ * },
1617
+ * {
1618
+ * "ItemId": "item_bundle_1",
1619
+ * "ItemClass": "Bundles",
1620
+ * "DisplayName": "Item bundle 1",
1621
+ * "Description": "Item which, when added to the user inventory, also adds other bundled items",
1622
+ * "VirtualCurrencyPrices": {
1623
+ * "RM": 599
1624
+ * },
1625
+ * "Bundle": {
1626
+ * "BundledItems": [
1627
+ * "sub_bundle_item_1",
1628
+ * "sub_bundle_item_2"
1629
+ * ],
1630
+ * "BundledResultTables": [
1631
+ * "random_result_1"
1632
+ * ],
1633
+ * "BundledVirtualCurrencies": {
1634
+ * "GV": 1000
1635
+ * }
1636
+ * },
1637
+ * "CanBecomeCharacter": false,
1638
+ * "IsStackable": false,
1639
+ * "IsTradable": false,
1640
+ * "IsLimitedEdition": false,
1641
+ * "InitialLimitedEditionCount": 0
1642
+ * },
1643
+ * {
1644
+ * "ItemId": "key_item_1",
1645
+ * "ItemClass": "Containers",
1646
+ * "DisplayName": "Key Item 1",
1647
+ * "Description": "Key used to unlock Container 1",
1648
+ * "VirtualCurrencyPrices": {
1649
+ * "RM": 199
1650
+ * },
1651
+ * "CanBecomeCharacter": false,
1652
+ * "IsStackable": false,
1653
+ * "IsTradable": false,
1654
+ * "IsLimitedEdition": false,
1655
+ * "InitialLimitedEditionCount": 0
1656
+ * },
1657
+ * {
1658
+ * "ItemId": "sub_container_item_1",
1659
+ * "ItemClass": "Containers",
1660
+ * "DisplayName": "Container Item 1",
1661
+ * "Description": "Item which is added to the user inventory as part of opening a container",
1662
+ * "CanBecomeCharacter": false,
1663
+ * "IsStackable": false,
1664
+ * "IsTradable": false,
1665
+ * "IsLimitedEdition": false,
1666
+ * "InitialLimitedEditionCount": 0
1667
+ * },
1668
+ * {
1669
+ * "ItemId": "sub_container_item_2",
1670
+ * "ItemClass": "Containers",
1671
+ * "DisplayName": "Container Item 2",
1672
+ * "Description": "Item which is added to the user inventory as part of opening a container",
1673
+ * "CanBecomeCharacter": false,
1674
+ * "IsStackable": false,
1675
+ * "IsTradable": false,
1676
+ * "IsLimitedEdition": false,
1677
+ * "InitialLimitedEditionCount": 0
1678
+ * },
1679
+ * {
1680
+ * "ItemId": "item_container_1",
1681
+ * "ItemClass": "Containers",
1682
+ * "DisplayName": "Item Container 1",
1683
+ * "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
1684
+ * "VirtualCurrencyPrices": {
1685
+ * "RM": 499
1686
+ * },
1687
+ * "Consumable": {
1688
+ * "UsageCount": 1
1689
+ * },
1690
+ * "Container": {
1691
+ * "KeyItemId": "key_item_1",
1692
+ * "ItemContents": [
1693
+ * "sub_container_item_1",
1694
+ * "sub_container_item_2"
1695
+ * ],
1696
+ * "ResultTableContents": [
1697
+ * "random_result_1"
1698
+ * ],
1699
+ * "VirtualCurrencyContents": {
1700
+ * "GV": 1000
1701
+ * }
1702
+ * },
1703
+ * "CanBecomeCharacter": false,
1704
+ * "IsStackable": false,
1705
+ * "IsTradable": false,
1706
+ * "IsLimitedEdition": false,
1707
+ * "InitialLimitedEditionCount": 0
1708
+ * },
1709
+ * {
1710
+ * "ItemId": "item_container_2",
1711
+ * "ItemClass": "Containers",
1712
+ * "DisplayName": "Item Container 2",
1713
+ * "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
1714
+ * "VirtualCurrencyPrices": {
1715
+ * "RM": 99
1716
+ * },
1717
+ * "Consumable": {
1718
+ * "UsageCount": 1
1719
+ * },
1720
+ * "Container": {
1721
+ * "VirtualCurrencyContents": {
1722
+ * "GV": 1000
1723
+ * }
1724
+ * },
1725
+ * "CanBecomeCharacter": false,
1726
+ * "IsStackable": false,
1727
+ * "IsTradable": false,
1728
+ * "IsLimitedEdition": false,
1729
+ * "InitialLimitedEditionCount": 0
1730
+ * },
1731
+ * {
1732
+ * "ItemId": "starterpack_1",
1733
+ * "ItemClass": "starterpacks",
1734
+ * "DisplayName": "Super Starter Pack",
1735
+ * "Description": "Everything you need to get started fast track at the right price",
1736
+ * "CanBecomeCharacter": false,
1737
+ * "IsStackable": false,
1738
+ * "IsTradable": false,
1739
+ * "IsLimitedEdition": false,
1740
+ * "InitialLimitedEditionCount": 0
1741
+ * }
1742
+ * ]
1743
+ * });
1744
+ */
1745
+ SetCatalogItems(request, extraHeaders) {
1746
+ return this.ExecuteRequestWrapper("/Admin/SetCatalogItems", request, "X-SecretKey", extraHeaders);
1747
+ }
1748
+ /**
1749
+ * Updates the sink to which to route PlayStream and Telemetry event data.
1750
+ *
1751
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/seteventsink Microsoft Documentation}
1752
+ * @example
1753
+ * await adminClient.SetEventSink({
1754
+ * "Sink": {
1755
+ * "Name": "MyStorage",
1756
+ * "DestinationType": "AzureBlobStorage",
1757
+ * "IsEnabled": true,
1758
+ * "SinkSettings": {
1759
+ * "AccountName": "mystorageaccount",
1760
+ * "ContainerName": "mycontainername",
1761
+ * "TenantId": null,
1762
+ * "Credentials": {
1763
+ * "Secret": ""
1764
+ * }
1765
+ * }
1766
+ * }
1767
+ * });
1768
+ */
1769
+ SetEventSink(request, extraHeaders) {
1770
+ return this.ExecuteRequestWrapper("/Admin/SetEventSink", request, "X-SecretKey", extraHeaders);
1771
+ }
1772
+ /**
1773
+ * Sets the override expiration for a membership subscription
1774
+ *
1775
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride Microsoft Documentation}
1776
+ * @example
1777
+ * await adminClient.SetMembershipOverride({
1778
+ * "ExpirationTime": "2014-04-06T00:00:00Z",
1779
+ * "MembershipId": "ShieldBonusMembership",
1780
+ * "PlayFabId": "204883457"
1781
+ * });
1782
+ */
1783
+ SetMembershipOverride(request, extraHeaders) {
1784
+ return this.ExecuteRequestWrapper("/Admin/SetMembershipOverride", request, "X-SecretKey", extraHeaders);
1785
+ }
1786
+ /**
1787
+ * Sets or resets the player's secret. Player secrets are used to sign API requests.
1788
+ *
1789
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret Microsoft Documentation}
1790
+ * @example
1791
+ * await adminClient.SetPlayerSecret({
1792
+ * "PlayerSecret": "ExampleSecret",
1793
+ * "PlayFabId": "ABCD1234"
1794
+ * });
1795
+ */
1796
+ SetPlayerSecret(request, extraHeaders) {
1797
+ return this.ExecuteRequestWrapper("/Admin/SetPlayerSecret", request, "X-SecretKey", extraHeaders);
1798
+ }
1799
+ /**
1800
+ * Sets the currently published revision of a title Cloud Script
1801
+ *
1802
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision Microsoft Documentation}
1803
+ * @example
1804
+ * await adminClient.SetPublishedRevision({
1805
+ * "Version": 1,
1806
+ * "Revision": 3
1807
+ * });
1808
+ */
1809
+ SetPublishedRevision(request, extraHeaders) {
1810
+ return this.ExecuteRequestWrapper("/Admin/SetPublishedRevision", request, "X-SecretKey", extraHeaders);
1811
+ }
1812
+ /**
1813
+ * Updates the key-value store of custom publisher settings
1814
+ *
1815
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata Microsoft Documentation}
1816
+ * @example
1817
+ * await adminClient.SetPublisherData({
1818
+ * "Key": "Running Speed",
1819
+ * "Value": "1.03"
1820
+ * });
1821
+ */
1822
+ SetPublisherData(request, extraHeaders) {
1823
+ return this.ExecuteRequestWrapper("/Admin/SetPublisherData", request, "X-SecretKey", extraHeaders);
1824
+ }
1825
+ /**
1826
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1827
+ * version 2._ Sets all the items in one virtual store
1828
+ *
1829
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems Microsoft Documentation}
1830
+ * @example
1831
+ * await adminClient.SetStoreItems({
1832
+ * "StoreId": "BonusStore",
1833
+ * "Store": [
1834
+ * {
1835
+ * "ItemId": "shield_level_5",
1836
+ * "VirtualCurrencyPrices": {
1837
+ * "RM": 180,
1838
+ * "GV": 20
1839
+ * },
1840
+ * "RealCurrencyPrices": {
1841
+ * "GBP": 100
1842
+ * }
1843
+ * },
1844
+ * {
1845
+ * "ItemId": "energy_boost_1",
1846
+ * "VirtualCurrencyPrices": {
1847
+ * "RM": 250,
1848
+ * "GV": 30
1849
+ * }
1850
+ * },
1851
+ * {
1852
+ * "ItemId": "starterpack_1",
1853
+ * "VirtualCurrencyPrices": {
1854
+ * "RM": 399
1855
+ * }
1856
+ * }
1857
+ * ]
1858
+ * });
1859
+ */
1860
+ SetStoreItems(request, extraHeaders) {
1861
+ return this.ExecuteRequestWrapper("/Admin/SetStoreItems", request, "X-SecretKey", extraHeaders);
1862
+ }
1863
+ /**
1864
+ * Creates and updates the key-value store of custom title settings which can be read by the client. For example, a
1865
+ * developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
1866
+ * movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
1867
+ * build.
1868
+ *
1869
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata Microsoft Documentation}
1870
+ * @example
1871
+ * await adminClient.SetTitleData({
1872
+ * "Key": "Running Speed",
1873
+ * "Value": "1.03"
1874
+ * });
1875
+ */
1876
+ SetTitleData(request, extraHeaders) {
1877
+ return this.ExecuteRequestWrapper("/Admin/SetTitleData", request, "X-SecretKey", extraHeaders);
1878
+ }
1879
+ /**
1880
+ * Set and delete key-value pairs in a title data override instance.
1881
+ *
1882
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides Microsoft Documentation}
1883
+ * @example
1884
+ * await adminClient.SetTitleDataAndOverrides({
1885
+ * "OverrideLabel": "Holiday title data",
1886
+ * "TitleId": "8FF3A797",
1887
+ * "KeyValues": [
1888
+ * {
1889
+ * "Key": "Running Speed",
1890
+ * "Value": "1.03"
1891
+ * },
1892
+ * {
1893
+ * "Key": "Walking Speed",
1894
+ * "Value": "0.05"
1895
+ * }
1896
+ * ]
1897
+ * });
1898
+ */
1899
+ SetTitleDataAndOverrides(request, extraHeaders) {
1900
+ return this.ExecuteRequestWrapper("/Admin/SetTitleDataAndOverrides", request, "X-SecretKey", extraHeaders);
1901
+ }
1902
+ /**
1903
+ * Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
1904
+ * tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
1905
+ *
1906
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata Microsoft Documentation}
1907
+ * @example
1908
+ * await adminClient.SetTitleInternalData({
1909
+ * "Key": "Running Speed",
1910
+ * "Value": "1.03"
1911
+ * });
1912
+ */
1913
+ SetTitleInternalData(request, extraHeaders) {
1914
+ return this.ExecuteRequestWrapper("/Admin/SetTitleInternalData", request, "X-SecretKey", extraHeaders);
1915
+ }
1916
+ /**
1917
+ * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can
1918
+ * be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device
1919
+ * Messaging is not supported.
1920
+ *
1921
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification Microsoft Documentation}
1922
+ * @example
1923
+ * await adminClient.SetupPushNotification({
1924
+ * "Platform": "APNS_SANDBOX",
1925
+ * "Key": "MyKey123",
1926
+ * "Credential": "MyCredentialsXYZ",
1927
+ * "OverwriteOldARN": false
1928
+ * });
1929
+ */
1930
+ SetupPushNotification(request, extraHeaders) {
1931
+ return this.ExecuteRequestWrapper("/Admin/SetupPushNotification", request, "X-SecretKey", extraHeaders);
1932
+ }
1933
+ /**
1934
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1935
+ * version 2._ Decrements the specified virtual currency by the stated amount
1936
+ *
1937
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
1938
+ * @example
1939
+ * await adminClient.SubtractUserVirtualCurrency({
1940
+ * "PlayFabId": "20394883",
1941
+ * "VirtualCurrency": "GC",
1942
+ * "Amount": 100
1943
+ * });
1944
+ */
1945
+ SubtractUserVirtualCurrency(request, extraHeaders) {
1946
+ return this.ExecuteRequestWrapper("/Admin/SubtractUserVirtualCurrency", request, "X-SecretKey", extraHeaders);
1947
+ }
1948
+ /**
1949
+ * Updates information of a list of existing bans specified with Ban Ids.
1950
+ *
1951
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans Microsoft Documentation}
1952
+ * @example
1953
+ * await adminClient.UpdateBans({
1954
+ * "Bans": [
1955
+ * {
1956
+ * "BanId": "E0B5FF89542D413C",
1957
+ * "Permanent": true,
1958
+ * "Active": true
1959
+ * },
1960
+ * {
1961
+ * "BanId": "EF43FF89542G1546",
1962
+ * "Reason": "Royal pardon",
1963
+ * "Expires": "2016-07-04T00:00:00Z"
1964
+ * }
1965
+ * ]
1966
+ * });
1967
+ */
1968
+ UpdateBans(request, extraHeaders) {
1969
+ return this.ExecuteRequestWrapper("/Admin/UpdateBans", request, "X-SecretKey", extraHeaders);
1970
+ }
1971
+ /**
1972
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1973
+ * version 2._ Updates the catalog configuration for virtual goods in the specified catalog version
1974
+ *
1975
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems Microsoft Documentation}
1976
+ * @example
1977
+ * await adminClient.UpdateCatalogItems({
1978
+ * "CatalogVersion": "5",
1979
+ * "Catalog": [
1980
+ * {
1981
+ * "ItemId": "shield_level_5",
1982
+ * "ItemClass": "shields",
1983
+ * "DisplayName": "Level 5 Shield",
1984
+ * "Description": "Strong defense against projectile attacks",
1985
+ * "VirtualCurrencyPrices": {
1986
+ * "RM": 199,
1987
+ * "GV": 25
1988
+ * },
1989
+ * "RealCurrencyPrices": {
1990
+ * "GBP": 149,
1991
+ * "EUR": 169
1992
+ * },
1993
+ * "CanBecomeCharacter": false,
1994
+ * "IsStackable": false,
1995
+ * "IsTradable": false,
1996
+ * "IsLimitedEdition": false,
1997
+ * "InitialLimitedEditionCount": 0
1998
+ * },
1999
+ * {
2000
+ * "ItemId": "energy_boost_1",
2001
+ * "ItemClass": "boosts",
2002
+ * "DisplayName": "Energy Drink Six-Pack",
2003
+ * "Description": "Get a quick burst of energy whenever you need it",
2004
+ * "VirtualCurrencyPrices": {
2005
+ * "RM": 199,
2006
+ * "GV": 25
2007
+ * },
2008
+ * "CanBecomeCharacter": false,
2009
+ * "IsStackable": false,
2010
+ * "IsTradable": false,
2011
+ * "IsLimitedEdition": false,
2012
+ * "InitialLimitedEditionCount": 0
2013
+ * },
2014
+ * {
2015
+ * "ItemId": "required_item_for_grant_a_1",
2016
+ * "ItemClass": "sets",
2017
+ * "DisplayName": "Grant Set Item 1",
2018
+ * "Description": "Item 1 from the set of items needed to get Granted Item A for free",
2019
+ * "VirtualCurrencyPrices": {
2020
+ * "RM": 249,
2021
+ * "GV": 1500
2022
+ * },
2023
+ * "CanBecomeCharacter": false,
2024
+ * "IsStackable": false,
2025
+ * "IsTradable": false,
2026
+ * "IsLimitedEdition": false,
2027
+ * "InitialLimitedEditionCount": 0
2028
+ * },
2029
+ * {
2030
+ * "ItemId": "required_item_for_grant_a_2",
2031
+ * "ItemClass": "sets",
2032
+ * "DisplayName": "Grant Set Item 2",
2033
+ * "Description": "Item 2 from the set of items needed to get Granted Item A for free",
2034
+ * "VirtualCurrencyPrices": {
2035
+ * "RM": 249,
2036
+ * "GV": 1500
2037
+ * },
2038
+ * "CanBecomeCharacter": false,
2039
+ * "IsStackable": false,
2040
+ * "IsTradable": false,
2041
+ * "IsLimitedEdition": false,
2042
+ * "InitialLimitedEditionCount": 0
2043
+ * },
2044
+ * {
2045
+ * "ItemId": "required_item_for_grant_a_3",
2046
+ * "ItemClass": "sets",
2047
+ * "DisplayName": "Grant Set Item 3",
2048
+ * "Description": "Item 3 from the set of items needed to get Granted Item A for free",
2049
+ * "VirtualCurrencyPrices": {
2050
+ * "RM": 249,
2051
+ * "GV": 1500
2052
+ * },
2053
+ * "CanBecomeCharacter": false,
2054
+ * "IsStackable": false,
2055
+ * "IsTradable": false,
2056
+ * "IsLimitedEdition": false,
2057
+ * "InitialLimitedEditionCount": 0
2058
+ * },
2059
+ * {
2060
+ * "ItemId": "required_item_for_grant_a_4",
2061
+ * "ItemClass": "sets",
2062
+ * "DisplayName": "Grant Set Item 4",
2063
+ * "Description": "Item 4 from the set of items needed to get Granted Item A for free",
2064
+ * "VirtualCurrencyPrices": {
2065
+ * "RM": 249,
2066
+ * "GV": 1500
2067
+ * },
2068
+ * "CanBecomeCharacter": false,
2069
+ * "IsStackable": false,
2070
+ * "IsTradable": false,
2071
+ * "IsLimitedEdition": false,
2072
+ * "InitialLimitedEditionCount": 0
2073
+ * },
2074
+ * {
2075
+ * "ItemId": "granted_item_a",
2076
+ * "ItemClass": "sets",
2077
+ * "DisplayName": "Granted Item A",
2078
+ * "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
2079
+ * "CanBecomeCharacter": false,
2080
+ * "IsStackable": false,
2081
+ * "IsTradable": false,
2082
+ * "IsLimitedEdition": false,
2083
+ * "InitialLimitedEditionCount": 0
2084
+ * },
2085
+ * {
2086
+ * "ItemId": "consumable_item_1",
2087
+ * "ItemClass": "Consumables",
2088
+ * "DisplayName": "Consumable Item 1",
2089
+ * "Description": "Item demonstrating usage-based consumables",
2090
+ * "VirtualCurrencyPrices": {
2091
+ * "GV": 500
2092
+ * },
2093
+ * "Consumable": {
2094
+ * "UsageCount": 3
2095
+ * },
2096
+ * "CanBecomeCharacter": false,
2097
+ * "IsStackable": false,
2098
+ * "IsTradable": false,
2099
+ * "IsLimitedEdition": false,
2100
+ * "InitialLimitedEditionCount": 0
2101
+ * },
2102
+ * {
2103
+ * "ItemId": "consumable_item_2",
2104
+ * "ItemClass": "Consumables",
2105
+ * "DisplayName": "Consumable Item 2",
2106
+ * "Description": "Item demonstrating time-based consumables",
2107
+ * "VirtualCurrencyPrices": {
2108
+ * "GV": 750
2109
+ * },
2110
+ * "Consumable": {
2111
+ * "UsagePeriod": 3600,
2112
+ * "UsagePeriodGroup": "usage_group_1"
2113
+ * },
2114
+ * "CanBecomeCharacter": false,
2115
+ * "IsStackable": false,
2116
+ * "IsTradable": false,
2117
+ * "IsLimitedEdition": false,
2118
+ * "InitialLimitedEditionCount": 0
2119
+ * },
2120
+ * {
2121
+ * "ItemId": "sub_bundle_item_1",
2122
+ * "ItemClass": "Bundles",
2123
+ * "DisplayName": "Bundled Item 1",
2124
+ * "Description": "Item which is added to the user inventory as part of a bundle",
2125
+ * "CanBecomeCharacter": false,
2126
+ * "IsStackable": false,
2127
+ * "IsTradable": false,
2128
+ * "IsLimitedEdition": false,
2129
+ * "InitialLimitedEditionCount": 0
2130
+ * },
2131
+ * {
2132
+ * "ItemId": "sub_bundle_item_2",
2133
+ * "ItemClass": "Bundles",
2134
+ * "DisplayName": "Bundled Item 2",
2135
+ * "Description": "Item which is added to the user inventory as part of a bundle",
2136
+ * "CanBecomeCharacter": false,
2137
+ * "IsStackable": false,
2138
+ * "IsTradable": false,
2139
+ * "IsLimitedEdition": false,
2140
+ * "InitialLimitedEditionCount": 0
2141
+ * },
2142
+ * {
2143
+ * "ItemId": "item_bundle_1",
2144
+ * "ItemClass": "Bundles",
2145
+ * "DisplayName": "Item bundle 1",
2146
+ * "Description": "Item which, when added to the user inventory, also adds other bundled items",
2147
+ * "VirtualCurrencyPrices": {
2148
+ * "RM": 599
2149
+ * },
2150
+ * "Bundle": {
2151
+ * "BundledItems": [
2152
+ * "sub_bundle_item_1",
2153
+ * "sub_bundle_item_2"
2154
+ * ],
2155
+ * "BundledResultTables": [
2156
+ * "random_result_1"
2157
+ * ],
2158
+ * "BundledVirtualCurrencies": {
2159
+ * "GV": 1000
2160
+ * }
2161
+ * },
2162
+ * "CanBecomeCharacter": false,
2163
+ * "IsStackable": false,
2164
+ * "IsTradable": false,
2165
+ * "IsLimitedEdition": false,
2166
+ * "InitialLimitedEditionCount": 0
2167
+ * },
2168
+ * {
2169
+ * "ItemId": "key_item_1",
2170
+ * "ItemClass": "Containers",
2171
+ * "DisplayName": "Key Item 1",
2172
+ * "Description": "Key used to unlock Container 1",
2173
+ * "VirtualCurrencyPrices": {
2174
+ * "RM": 199
2175
+ * },
2176
+ * "CanBecomeCharacter": false,
2177
+ * "IsStackable": false,
2178
+ * "IsTradable": false,
2179
+ * "IsLimitedEdition": false,
2180
+ * "InitialLimitedEditionCount": 0
2181
+ * },
2182
+ * {
2183
+ * "ItemId": "sub_container_item_1",
2184
+ * "ItemClass": "Containers",
2185
+ * "DisplayName": "Container Item 1",
2186
+ * "Description": "Item which is added to the user inventory as part of opening a container",
2187
+ * "CanBecomeCharacter": false,
2188
+ * "IsStackable": false,
2189
+ * "IsTradable": false,
2190
+ * "IsLimitedEdition": false,
2191
+ * "InitialLimitedEditionCount": 0
2192
+ * },
2193
+ * {
2194
+ * "ItemId": "sub_container_item_2",
2195
+ * "ItemClass": "Containers",
2196
+ * "DisplayName": "Container Item 2",
2197
+ * "Description": "Item which is added to the user inventory as part of opening a container",
2198
+ * "CanBecomeCharacter": false,
2199
+ * "IsStackable": false,
2200
+ * "IsTradable": false,
2201
+ * "IsLimitedEdition": false,
2202
+ * "InitialLimitedEditionCount": 0
2203
+ * },
2204
+ * {
2205
+ * "ItemId": "item_container_1",
2206
+ * "ItemClass": "Containers",
2207
+ * "DisplayName": "Item Container 1",
2208
+ * "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
2209
+ * "VirtualCurrencyPrices": {
2210
+ * "RM": 499
2211
+ * },
2212
+ * "Consumable": {
2213
+ * "UsageCount": 1
2214
+ * },
2215
+ * "Container": {
2216
+ * "KeyItemId": "key_item_1",
2217
+ * "ItemContents": [
2218
+ * "sub_container_item_1",
2219
+ * "sub_container_item_2"
2220
+ * ],
2221
+ * "ResultTableContents": [
2222
+ * "random_result_1"
2223
+ * ],
2224
+ * "VirtualCurrencyContents": {
2225
+ * "GV": 1000
2226
+ * }
2227
+ * },
2228
+ * "CanBecomeCharacter": false,
2229
+ * "IsStackable": false,
2230
+ * "IsTradable": false,
2231
+ * "IsLimitedEdition": false,
2232
+ * "InitialLimitedEditionCount": 0
2233
+ * },
2234
+ * {
2235
+ * "ItemId": "item_container_2",
2236
+ * "ItemClass": "Containers",
2237
+ * "DisplayName": "Item Container 2",
2238
+ * "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
2239
+ * "VirtualCurrencyPrices": {
2240
+ * "RM": 99
2241
+ * },
2242
+ * "Consumable": {
2243
+ * "UsageCount": 1
2244
+ * },
2245
+ * "Container": {
2246
+ * "VirtualCurrencyContents": {
2247
+ * "GV": 1000
2248
+ * }
2249
+ * },
2250
+ * "CanBecomeCharacter": false,
2251
+ * "IsStackable": false,
2252
+ * "IsTradable": false,
2253
+ * "IsLimitedEdition": false,
2254
+ * "InitialLimitedEditionCount": 0
2255
+ * },
2256
+ * {
2257
+ * "ItemId": "starterpack_1",
2258
+ * "ItemClass": "starterpacks",
2259
+ * "DisplayName": "Super Starter Pack",
2260
+ * "Description": "Everything you need to get started fast track at the right price",
2261
+ * "CanBecomeCharacter": false,
2262
+ * "IsStackable": false,
2263
+ * "IsTradable": false,
2264
+ * "IsLimitedEdition": false,
2265
+ * "InitialLimitedEditionCount": 0
2266
+ * }
2267
+ * ]
2268
+ * });
2269
+ */
2270
+ UpdateCatalogItems(request, extraHeaders) {
2271
+ return this.ExecuteRequestWrapper("/Admin/UpdateCatalogItems", request, "X-SecretKey", extraHeaders);
2272
+ }
2273
+ /**
2274
+ * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be
2275
+ * submitted in the revision.
2276
+ *
2277
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript Microsoft Documentation}
2278
+ * @example
2279
+ * await adminClient.UpdateCloudScript({
2280
+ * "Files": [
2281
+ * {
2282
+ * "Filename": "main.js",
2283
+ * "FileContents": "var LevelRewards =\r\n[\r\n\t[\"TestItem1\"],\r\n\t[\"TestItem2\"],\r\n\t[\"TestItem3\"],\r\n\t[\"TestItem1\", \"TestItem2\"],\r\n\t[\"TestItem2\", \"TestItem2\"],\r\n\t[\"TestItem3\", \"TestItem3\"]\r\n]\r\n\r\nhandlers.onLevelComplete = function(args)\r\n{\r\n\tvar levelNum = args.level;\r\n\t\r\n\t// Do some basic input validation\r\n\tif(levelNum < 0 || levelNum >= LevelRewards.length)\r\n\t{\r\n\t\tlog.info(\"Invalid level \"+levelNum+\" completed by \"+currentPlayerId);\r\n\t\treturn {};\r\n\t}\r\n\t\r\n\tvar levelCompleteKey = \"LevelCompleted\"+levelNum;\r\n\t\r\n\t// Get the user's internal data\r\n\tvar playerInternalData = server.GetUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tKeys: [levelCompleteKey]\r\n\t});\r\n\t\r\n\t// Did they already complete this level?\r\n\tif(playerInternalData.Data[levelCompleteKey])\r\n\t{\r\n\t\tlog.info(\"Player \"+currentPlayerId+\" already completed level \"+levelNum);\r\n\t\treturn {};\r\n\t}\r\n\t\r\n\tvar rewards = LevelRewards[levelNum];\r\n\t\r\n\tvar resultItems = null;\r\n\tif(rewards)\r\n\t{\r\n\t\t// Grant reward items to player for completing the level\r\n\t\tvar itemGrantResult = server.GrantItemsToUser(\r\n\t\t{\r\n\t\t\tPlayFabId: currentPlayerId,\r\n\t\t\tAnnotation: \"Given by completing level \"+levelNum,\r\n\t\t\tItemIds: rewards\r\n\t\t});\r\n\t\t\r\n\t\tresultItems = itemGrantResult.ItemGrantResults;\r\n\t}\r\n\t\r\n\t// Mark the level as being completed so they can't get the reward again\r\n\tvar saveData = {};\r\n\tsaveData[levelCompleteKey] = \"true\";\r\n\tserver.UpdateUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tData: saveData\r\n\t});\r\n\r\n\t// Return the results of the item grant so the client can see what they got\r\n\treturn {\r\n\t\trewards: resultItems\r\n\t};\r\n}\r\n\r\nvar monsterRewards =\r\n{\r\n\t\"skrill\" : { \"ChumpCoins\" : 100},\r\n\t\"lumpur\" : { \"ChumpCoins\" : 200}\r\n}\r\n\r\nvar killCoolDown = 60;\r\n\r\nfunction currTimeSeconds()\r\n{\r\n\tvar now = new Date();\r\n\treturn now.getTime() / 1000;\r\n}\r\n\r\nhandlers.monsterKilled = function(args)\r\n{\r\n\tvar monsterType = args.type;\r\n\t\r\n\tvar now = currTimeSeconds();\r\n\t\r\n\t// Get the user's internal data\r\n\tvar playerInternalData = server.GetUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tKeys: [\"lastKill\"]\r\n\t});\r\n\t\r\n\t// Check when the last time they killed a monster was \r\n\tvar lastKill = playerInternalData.Data[\"lastKill\"];\r\n\tif(lastKill)\r\n\t{\r\n\t\t// We have a value, see when it is\r\n\t\tvar lastKillTime = parseInt(lastKill.Value);\r\n\t\tif(now - lastKillTime < killCoolDown)\r\n\t\t{\r\n\t\t\t// In this particular game, it should not be possible to kill a monster more often than once a minute, so they might be cheating\r\n\t\t\tlog.info(\"Player \"+currentPlayerId+\" killed \"+monsterType+\" again too quickly!\");\r\n\t\t\treturn {};\r\n\t\t}\r\n\t}\r\n\t\r\n\tvar killReward = monsterRewards[monsterType];\r\n\t\r\n\tif(killReward)\r\n\t{\r\n\t\tfor(var currency in killReward)\r\n\t\t{\r\n\t\t\tvar amount = killReward[currency];\r\n\t\t\tserver.AddUserVirtualCurrency({ PlayFabId: currentPlayerId, VirtualCurrency: currency, Amount: amount });\r\n\t\t}\r\n\t}\r\n\t\r\n\t// Reset the kill timer\r\n\tserver.UpdateUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tData: {\r\n\t\t\t\"lastKill\" : String(now)\r\n\t\t}\r\n\t});\r\n\t\r\n\treturn {\r\n\t\trewards: killReward\r\n\t};\r\n}"
2284
+ * }
2285
+ * ],
2286
+ * "Publish": false
2287
+ * });
2288
+ */
2289
+ UpdateCloudScript(request, extraHeaders) {
2290
+ return this.ExecuteRequestWrapper("/Admin/UpdateCloudScript", request, "X-SecretKey", extraHeaders);
2291
+ }
2292
+ /**
2293
+ * Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider
2294
+ *
2295
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection Microsoft Documentation}
2296
+ * @example
2297
+ * await adminClient.UpdateOpenIdConnection({
2298
+ * "ConnectionId": "oidconnection1",
2299
+ * "ClientId": "example_id_1",
2300
+ * "ClientSecret": "new_example_secret",
2301
+ * "IssuerInformation": {
2302
+ * "Issuer": "https://issuer.example.com/",
2303
+ * "AuthorizationUrl": "https://issuer.example.com/authorize",
2304
+ * "TokenUrl": "https://issuer.example.com/oauth2/token",
2305
+ * "JsonWebKeySet": {
2306
+ * "keys": [
2307
+ * "..."
2308
+ * ]
2309
+ * }
2310
+ * },
2311
+ * "IssuerOverride": "https://issueroverride.example.com/"
2312
+ * });
2313
+ */
2314
+ UpdateOpenIdConnection(request, extraHeaders) {
2315
+ return this.ExecuteRequestWrapper("/Admin/UpdateOpenIdConnection", request, "X-SecretKey", extraHeaders);
2316
+ }
2317
+ /**
2318
+ * Updates the title-specific custom property values for a player
2319
+ *
2320
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties Microsoft Documentation}
2321
+ * @example
2322
+ * await adminClient.UpdatePlayerCustomProperties({
2323
+ * "PlayFabId": "2039475",
2324
+ * "Properties": [
2325
+ * {
2326
+ * "Name": "level",
2327
+ * "Value": 5
2328
+ * },
2329
+ * {
2330
+ * "Name": "created",
2331
+ * "Value": false
2332
+ * }
2333
+ * ],
2334
+ * "ExpectedPropertiesVersion": 12
2335
+ * });
2336
+ */
2337
+ UpdatePlayerCustomProperties(request, extraHeaders) {
2338
+ return this.ExecuteRequestWrapper("/Admin/UpdatePlayerCustomProperties", request, "X-SecretKey", extraHeaders);
2339
+ }
2340
+ /**
2341
+ * Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available
2342
+ * after this API returns.
2343
+ *
2344
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret Microsoft Documentation}
2345
+ * @example
2346
+ * await adminClient.UpdatePlayerSharedSecret({
2347
+ * "SecretKey": "keysaresecret",
2348
+ * "FriendlyName": "XBox Users",
2349
+ * "Disabled": false
2350
+ * });
2351
+ */
2352
+ UpdatePlayerSharedSecret(request, extraHeaders) {
2353
+ return this.ExecuteRequestWrapper("/Admin/UpdatePlayerSharedSecret", request, "X-SecretKey", extraHeaders);
2354
+ }
2355
+ /**
2356
+ * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
2357
+ *
2358
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition Microsoft Documentation}
2359
+ * @example
2360
+ * await adminClient.UpdatePlayerStatisticDefinition({
2361
+ * "StatisticName": "headshots",
2362
+ * "VersionChangeInterval": "Day",
2363
+ * "ShouldProvisionLeaderboard": false
2364
+ * });
2365
+ */
2366
+ UpdatePlayerStatisticDefinition(request, extraHeaders) {
2367
+ return this.ExecuteRequestWrapper("/Admin/UpdatePlayerStatisticDefinition", request, "X-SecretKey", extraHeaders);
2368
+ }
2369
+ /**
2370
+ * Changes a policy for a title
2371
+ *
2372
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy Microsoft Documentation}
2373
+ * @example
2374
+ * await adminClient.UpdatePolicy({
2375
+ * "PolicyName": "ApiPolicy",
2376
+ * "Statements": [
2377
+ * {
2378
+ * "Resource": "pfrn:api--*",
2379
+ * "Action": "*",
2380
+ * "Effect": "Allow",
2381
+ * "Principal": "*",
2382
+ * "Comment": "The default allow all policy"
2383
+ * },
2384
+ * {
2385
+ * "Resource": "pfrn:api--/Client/ConfirmPurchase",
2386
+ * "Action": "*",
2387
+ * "Effect": "Allow",
2388
+ * "Principal": "*",
2389
+ * "Comment": "This statement allows only request to ConfirmPurchase"
2390
+ * }
2391
+ * ],
2392
+ * "OverwritePolicy": false,
2393
+ * "PolicyVersion": 0
2394
+ * });
2395
+ */
2396
+ UpdatePolicy(request, extraHeaders) {
2397
+ return this.ExecuteRequestWrapper("/Admin/UpdatePolicy", request, "X-SecretKey", extraHeaders);
2398
+ }
2399
+ /**
2400
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2401
+ * version 2._ Updates the random drop table configuration for the title
2402
+ *
2403
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables Microsoft Documentation}
2404
+ * @example
2405
+ * await adminClient.UpdateRandomResultTables({
2406
+ * "Tables": [
2407
+ * {
2408
+ * "TableId": "DropTable 1",
2409
+ * "Nodes": [
2410
+ * {
2411
+ * "ResultItemType": "ItemId",
2412
+ * "ResultItem": "Gold Crown 1",
2413
+ * "Weight": 20
2414
+ * },
2415
+ * {
2416
+ * "ResultItemType": "ItemId",
2417
+ * "ResultItem": "Magic Sword 3",
2418
+ * "Weight": 50
2419
+ * },
2420
+ * {
2421
+ * "ResultItemType": "ItemId",
2422
+ * "ResultItem": "Clear Shield 3",
2423
+ * "Weight": 70
2424
+ * }
2425
+ * ]
2426
+ * }
2427
+ * ]
2428
+ * });
2429
+ */
2430
+ UpdateRandomResultTables(request, extraHeaders) {
2431
+ return this.ExecuteRequestWrapper("/Admin/UpdateRandomResultTables", request, "X-SecretKey", extraHeaders);
2432
+ }
2433
+ /**
2434
+ * Updates an existing player segment and its associated definition(s) and action(s) for a title.
2435
+ *
2436
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment Microsoft Documentation}
2437
+ * @example
2438
+ * await adminClient.UpdateSegment({
2439
+ * "SegmentModel": {
2440
+ * "SegmentId": "B05FC8CB558A6570",
2441
+ * "Name": "My user segment",
2442
+ * "LastUpdateTime": "0001-01-01T00:00:00Z",
2443
+ * "SegmentOrDefinitions": [
2444
+ * {
2445
+ * "SegmentAndDefinitions": [
2446
+ * {
2447
+ * "AllPlayersFilter": {}
2448
+ * }
2449
+ * ]
2450
+ * }
2451
+ * ],
2452
+ * "EnteredSegmentActions": [
2453
+ * {
2454
+ * "BanPlayerAction": {
2455
+ * "BanHours": 2,
2456
+ * "ReasonForBan": "Not played for a year"
2457
+ * }
2458
+ * }
2459
+ * ],
2460
+ * "LeftSegmentActions": [
2461
+ * {
2462
+ * "ExecuteAzureFunctionAction": {
2463
+ * "AzureFunction": "AzureFunction1",
2464
+ * "FunctionParameter": "{\"InputParam\": \"1\"}",
2465
+ * "GenerateFunctionExecutedEvents": false
2466
+ * }
2467
+ * }
2468
+ * ]
2469
+ * }
2470
+ * });
2471
+ */
2472
+ UpdateSegment(request, extraHeaders) {
2473
+ return this.ExecuteRequestWrapper("/Admin/UpdateSegment", request, "X-SecretKey", extraHeaders);
2474
+ }
2475
+ /**
2476
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2477
+ * version 2._ Updates an existing virtual item store with new or modified items
2478
+ *
2479
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems Microsoft Documentation}
2480
+ * @example
2481
+ * await adminClient.UpdateStoreItems({
2482
+ * "StoreId": "BonusStore",
2483
+ * "Store": [
2484
+ * {
2485
+ * "ItemId": "shield_level_5",
2486
+ * "VirtualCurrencyPrices": {
2487
+ * "RM": 180,
2488
+ * "GV": 20
2489
+ * },
2490
+ * "RealCurrencyPrices": {
2491
+ * "GBP": 100
2492
+ * }
2493
+ * },
2494
+ * {
2495
+ * "ItemId": "energy_boost_1",
2496
+ * "VirtualCurrencyPrices": {
2497
+ * "RM": 250,
2498
+ * "GV": 30
2499
+ * }
2500
+ * },
2501
+ * {
2502
+ * "ItemId": "starterpack_1",
2503
+ * "VirtualCurrencyPrices": {
2504
+ * "RM": 399
2505
+ * }
2506
+ * }
2507
+ * ]
2508
+ * });
2509
+ */
2510
+ UpdateStoreItems(request, extraHeaders) {
2511
+ return this.ExecuteRequestWrapper("/Admin/UpdateStoreItems", request, "X-SecretKey", extraHeaders);
2512
+ }
2513
+ /**
2514
+ * Update an existing task.
2515
+ *
2516
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask Microsoft Documentation}
2517
+ * @example
2518
+ * await adminClient.UpdateTask({
2519
+ * "Identifier": {
2520
+ * "Name": "PushEventNotificationVIP_Halloween"
2521
+ * },
2522
+ * "Name": "PushEventNotificationVIP_Thanksgiving",
2523
+ * "Description": "Send push notification to VIP about Thanksgiving event",
2524
+ * "IsActive": false,
2525
+ * "Type": "ActionsOnPlayerSegment",
2526
+ * "Parameter": {
2527
+ * "SegmentId": "E2B0F9C19B02D796",
2528
+ * "Actions": [
2529
+ * {
2530
+ * "GrantItemContent": {
2531
+ * "CatalogVersion": "foo",
2532
+ * "ItemId": "bar",
2533
+ * "ItemQuantity": 1
2534
+ * }
2535
+ * }
2536
+ * ]
2537
+ * }
2538
+ * });
2539
+ */
2540
+ UpdateTask(request, extraHeaders) {
2541
+ return this.ExecuteRequestWrapper("/Admin/UpdateTask", request, "X-SecretKey", extraHeaders);
2542
+ }
2543
+ /**
2544
+ * Updates the title-specific custom data for the user which is readable and writable by the client
2545
+ *
2546
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata Microsoft Documentation}
2547
+ * @example
2548
+ * await adminClient.UpdateUserData({
2549
+ * "PlayFabId": "2039475",
2550
+ * "Data": {
2551
+ * "Class": "Fighter",
2552
+ * "Gender": "Female",
2553
+ * "Icon": "Guard 3",
2554
+ * "Theme": "Colorful"
2555
+ * },
2556
+ * "Permission": "Public"
2557
+ * });
2558
+ */
2559
+ UpdateUserData(request, extraHeaders) {
2560
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserData", request, "X-SecretKey", extraHeaders);
2561
+ }
2562
+ /**
2563
+ * Updates the title-specific custom data for the user which cannot be accessed by the client
2564
+ *
2565
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserinternaldata Microsoft Documentation}
2566
+ * @example
2567
+ * await adminClient.UpdateUserInternalData({
2568
+ * "PlayFabId": "2039475",
2569
+ * "Data": {
2570
+ * "Class": "Fighter",
2571
+ * "Gender": "Female",
2572
+ * "Icon": "Guard 3",
2573
+ * "Theme": "Colorful"
2574
+ * }
2575
+ * });
2576
+ */
2577
+ UpdateUserInternalData(request, extraHeaders) {
2578
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserInternalData", request, "X-SecretKey", extraHeaders);
2579
+ }
2580
+ /**
2581
+ * Updates the publisher-specific custom data for the user which is readable and writable by the client
2582
+ *
2583
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata Microsoft Documentation}
2584
+ * @example
2585
+ * await adminClient.UpdateUserPublisherData({
2586
+ * "PlayFabId": "2039475",
2587
+ * "Data": {
2588
+ * "Class": "Fighter",
2589
+ * "Gender": "Female",
2590
+ * "Icon": "Guard 3",
2591
+ * "Theme": "Colorful"
2592
+ * },
2593
+ * "Permission": "Public"
2594
+ * });
2595
+ */
2596
+ UpdateUserPublisherData(request, extraHeaders) {
2597
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserPublisherData", request, "X-SecretKey", extraHeaders);
2598
+ }
2599
+ /**
2600
+ * Updates the publisher-specific custom data for the user which cannot be accessed by the client
2601
+ *
2602
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherinternaldata Microsoft Documentation}
2603
+ * @example
2604
+ * await adminClient.UpdateUserPublisherInternalData({
2605
+ * "PlayFabId": "2039475",
2606
+ * "Data": {
2607
+ * "Class": "Fighter",
2608
+ * "Gender": "Female",
2609
+ * "Icon": "Guard 3",
2610
+ * "Theme": "Colorful"
2611
+ * }
2612
+ * });
2613
+ */
2614
+ UpdateUserPublisherInternalData(request, extraHeaders) {
2615
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserPublisherInternalData", request, "X-SecretKey", extraHeaders);
2616
+ }
2617
+ /**
2618
+ * Updates the publisher-specific custom data for the user which can only be read by the client
2619
+ *
2620
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherreadonlydata Microsoft Documentation}
2621
+ * @example
2622
+ * await adminClient.UpdateUserPublisherReadOnlyData({
2623
+ * "PlayFabId": "2039475",
2624
+ * "Data": {
2625
+ * "Class": "Fighter",
2626
+ * "Gender": "Female",
2627
+ * "Icon": "Guard 3",
2628
+ * "Theme": "Colorful"
2629
+ * },
2630
+ * "Permission": "Public"
2631
+ * });
2632
+ */
2633
+ UpdateUserPublisherReadOnlyData(request, extraHeaders) {
2634
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserPublisherReadOnlyData", request, "X-SecretKey", extraHeaders);
2635
+ }
2636
+ /**
2637
+ * Updates the title-specific custom data for the user which can only be read by the client
2638
+ *
2639
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserreadonlydata Microsoft Documentation}
2640
+ * @example
2641
+ * await adminClient.UpdateUserReadOnlyData({
2642
+ * "PlayFabId": "2039475",
2643
+ * "Data": {
2644
+ * "Class": "Fighter",
2645
+ * "Gender": "Female",
2646
+ * "Icon": "Guard 3",
2647
+ * "Theme": "Colorful"
2648
+ * },
2649
+ * "Permission": "Public"
2650
+ * });
2651
+ */
2652
+ UpdateUserReadOnlyData(request, extraHeaders) {
2653
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserReadOnlyData", request, "X-SecretKey", extraHeaders);
2654
+ }
2655
+ /**
2656
+ * Updates the title specific display name for a user
2657
+ *
2658
+ * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname Microsoft Documentation}
2659
+ * @example
2660
+ * await adminClient.UpdateUserTitleDisplayName({
2661
+ * "PlayFabId": "293438",
2662
+ * "DisplayName": "New Display Name"
2663
+ * });
2664
+ */
2665
+ UpdateUserTitleDisplayName(request, extraHeaders) {
2666
+ return this.ExecuteRequestWrapper("/Admin/UpdateUserTitleDisplayName", request, "X-SecretKey", extraHeaders);
2667
+ }
2668
+ };
2669
+
2670
+ export {
2671
+ PlayFabAdminApi
2672
+ };
2673
+ //# sourceMappingURL=chunk-3OBHYLBF.js.map