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,2477 @@
1
+ import {
2
+ PlayFabCommon
3
+ } from "./chunk-XVDYM74A.js";
4
+
5
+ // src/apis/PlayFabServerApi.ts
6
+ var PlayFabServerApi = class extends PlayFabCommon {
7
+ /**
8
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
9
+ * version 2._ Increments the character's balance of the specified virtual currency by the stated amount
10
+ *
11
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency Microsoft Documentation}
12
+ * @example
13
+ * await serverClient.AddCharacterVirtualCurrency({
14
+ * "PlayFabId": "20394883",
15
+ * "CharacterId": "23424524523",
16
+ * "VirtualCurrency": "GC",
17
+ * "Amount": 100
18
+ * });
19
+ */
20
+ AddCharacterVirtualCurrency(request, extraHeaders) {
21
+ return this.ExecuteRequestWrapper("/Server/AddCharacterVirtualCurrency", request, "X-SecretKey", extraHeaders);
22
+ }
23
+ /**
24
+ * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
25
+ * FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
26
+ *
27
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend Microsoft Documentation}
28
+ * @example
29
+ * await serverClient.AddFriend({
30
+ * "PlayFabId": "10931252888739651331",
31
+ * "FriendPlayFabId": "20394883"
32
+ * });
33
+ */
34
+ AddFriend(request, extraHeaders) {
35
+ return this.ExecuteRequestWrapper("/Server/AddFriend", request, "X-SecretKey", extraHeaders);
36
+ }
37
+ /**
38
+ * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
39
+ * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
40
+ * authentication credentials, as the intent is that it is easily accessible by other players.
41
+ *
42
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid Microsoft Documentation}
43
+ * @example
44
+ * await serverClient.AddGenericID({
45
+ * "GenericId": {
46
+ * "ServiceName": "BigBizSocial",
47
+ * "UserId": "1234567890"
48
+ * }
49
+ * });
50
+ */
51
+ AddGenericID(request, extraHeaders) {
52
+ return this.ExecuteRequestWrapper("/Server/AddGenericID", request, "X-SecretKey", extraHeaders);
53
+ }
54
+ /**
55
+ * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
56
+ *
57
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag Microsoft Documentation}
58
+ * @example
59
+ * await serverClient.AddPlayerTag({
60
+ * "PlayFabId": "10931252888739651331",
61
+ * "TagName": "MostKilled"
62
+ * });
63
+ */
64
+ AddPlayerTag(request, extraHeaders) {
65
+ return this.ExecuteRequestWrapper("/Server/AddPlayerTag", request, "X-SecretKey", extraHeaders);
66
+ }
67
+ /**
68
+ * Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users
69
+ * in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small
70
+ * number of players, please see our guide:
71
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
72
+ *
73
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers Microsoft Documentation}
74
+ * @example
75
+ * await serverClient.AddSharedGroupMembers({
76
+ * "SharedGroupId": "Clan Data",
77
+ * "PlayFabIds": [
78
+ * "D984A64B832",
79
+ * "F74A523E1562"
80
+ * ]
81
+ * });
82
+ */
83
+ AddSharedGroupMembers(request, extraHeaders) {
84
+ return this.ExecuteRequestWrapper("/Server/AddSharedGroupMembers", 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._ Increments the user's balance of the specified virtual currency by the stated amount
89
+ *
90
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency Microsoft Documentation}
91
+ * @example
92
+ * await serverClient.AddUserVirtualCurrency({
93
+ * "PlayFabId": "20394883",
94
+ * "VirtualCurrency": "GC",
95
+ * "Amount": 100
96
+ * });
97
+ */
98
+ AddUserVirtualCurrency(request, extraHeaders) {
99
+ return this.ExecuteRequestWrapper("/Server/AddUserVirtualCurrency", request, "X-SecretKey", extraHeaders);
100
+ }
101
+ /**
102
+ * Validated a client's session ticket, and if successful, returns details for that user
103
+ *
104
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket Microsoft Documentation}
105
+ * @example
106
+ * await serverClient.AuthenticateSessionTicket({
107
+ * "SessionTicket": "4D2----8D11F4249A80000-7C64AB0A9F1D8D1A.CD803BF233CE76CC"
108
+ * });
109
+ */
110
+ AuthenticateSessionTicket(request, extraHeaders) {
111
+ return this.ExecuteRequestWrapper("/Server/AuthenticateSessionTicket", request, "X-SecretKey", extraHeaders);
112
+ }
113
+ /**
114
+ * Awards the specified users the specified Steam achievements
115
+ *
116
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement Microsoft Documentation}
117
+ * @example
118
+ * await serverClient.AwardSteamAchievement({
119
+ * "Achievements": [
120
+ * {
121
+ * "PlayFabId": "234974573892",
122
+ * "AchievementName": "FinishLevel1",
123
+ * "Result": false
124
+ * },
125
+ * {
126
+ * "PlayFabId": "334353433",
127
+ * "AchievementName": "FinishLevel1",
128
+ * "Result": false
129
+ * }
130
+ * ]
131
+ * });
132
+ */
133
+ AwardSteamAchievement(request, extraHeaders) {
134
+ return this.ExecuteRequestWrapper("/Server/AwardSteamAchievement", request, "X-SecretKey", extraHeaders);
135
+ }
136
+ /**
137
+ * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
138
+ *
139
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers Microsoft Documentation}
140
+ * @example
141
+ * await serverClient.BanUsers({
142
+ * "Bans": [
143
+ * {
144
+ * "PlayFabId": "1679AF5CD04BD838",
145
+ * "IPAddress": "192.168.1.1",
146
+ * "Reason": "You cheated!",
147
+ * "DurationInHours": 7
148
+ * },
149
+ * {
150
+ * "PlayFabId": "2329AF5CD04BF513",
151
+ * "Reason": "Caught you using speed hack!"
152
+ * }
153
+ * ]
154
+ * });
155
+ */
156
+ BanUsers(request, extraHeaders) {
157
+ return this.ExecuteRequestWrapper("/Server/BanUsers", request, "X-SecretKey", extraHeaders);
158
+ }
159
+ /**
160
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
161
+ * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
162
+ * inventory.
163
+ *
164
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem Microsoft Documentation}
165
+ * @example
166
+ * await serverClient.ConsumeItem({
167
+ * "ItemInstanceId": "94585729",
168
+ * "ConsumeCount": 1
169
+ * });
170
+ */
171
+ ConsumeItem(request, extraHeaders) {
172
+ return this.ExecuteRequestWrapper("/Server/ConsumeItem", request, "X-SecretKey", extraHeaders);
173
+ }
174
+ /**
175
+ * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
176
+ * group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data
177
+ * between a very small number of players, please see our guide:
178
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
179
+ *
180
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup Microsoft Documentation}
181
+ * @example
182
+ * await serverClient.CreateSharedGroup({
183
+ * "SharedGroupId": "Clan Data"
184
+ * });
185
+ */
186
+ CreateSharedGroup(request, extraHeaders) {
187
+ return this.ExecuteRequestWrapper("/Server/CreateSharedGroup", request, "X-SecretKey", extraHeaders);
188
+ }
189
+ /**
190
+ * Deletes the specific character ID from the specified user.
191
+ *
192
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser Microsoft Documentation}
193
+ * @example
194
+ * await serverClient.DeleteCharacterFromUser({
195
+ * "PlayFabId": "12345",
196
+ * "CharacterId": "98765432",
197
+ * "SaveCharacterInventory": false
198
+ * });
199
+ */
200
+ DeleteCharacterFromUser(request, extraHeaders) {
201
+ return this.ExecuteRequestWrapper("/Server/DeleteCharacterFromUser", request, "X-SecretKey", extraHeaders);
202
+ }
203
+ /**
204
+ * Removes a user's player account from a title and deletes all associated data
205
+ *
206
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer Microsoft Documentation}
207
+ * @example
208
+ * await serverClient.DeletePlayer({
209
+ * "PlayFabId": "A68C908B66C23C5"
210
+ * });
211
+ */
212
+ DeletePlayer(request, extraHeaders) {
213
+ return this.ExecuteRequestWrapper("/Server/DeletePlayer", request, "X-SecretKey", extraHeaders);
214
+ }
215
+ /**
216
+ * Deletes title-specific custom properties for a player
217
+ *
218
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties Microsoft Documentation}
219
+ * @example
220
+ * await serverClient.DeletePlayerCustomProperties({
221
+ * "PlayFabId": "2039475",
222
+ * "PropertyNames": [
223
+ * "level",
224
+ * "created"
225
+ * ],
226
+ * "ExpectedPropertiesVersion": 12
227
+ * });
228
+ */
229
+ DeletePlayerCustomProperties(request, extraHeaders) {
230
+ return this.ExecuteRequestWrapper("/Server/DeletePlayerCustomProperties", request, "X-SecretKey", extraHeaders);
231
+ }
232
+ /**
233
+ * Deletes push notification template for title
234
+ *
235
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate Microsoft Documentation}
236
+ * @example
237
+ * await serverClient.DeletePushNotificationTemplate({
238
+ * "PushNotificationTemplateId": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4"
239
+ * });
240
+ */
241
+ DeletePushNotificationTemplate(request, extraHeaders) {
242
+ return this.ExecuteRequestWrapper("/Server/DeletePushNotificationTemplate", request, "X-SecretKey", extraHeaders);
243
+ }
244
+ /**
245
+ * Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for
246
+ * sharing data between a very small number of players, please see our guide:
247
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
248
+ *
249
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup Microsoft Documentation}
250
+ * @example
251
+ * await serverClient.DeleteSharedGroup({
252
+ * "SharedGroupId": "Clan Data"
253
+ * });
254
+ */
255
+ DeleteSharedGroup(request, extraHeaders) {
256
+ return this.ExecuteRequestWrapper("/Server/DeleteSharedGroup", request, "X-SecretKey", extraHeaders);
257
+ }
258
+ /**
259
+ * Deletes custom data, all account linkages, and statistics.
260
+ *
261
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteusers Microsoft Documentation}
262
+ * @deprecated Please use DeletePlayer instead.
263
+ */
264
+ DeleteUsers(request, extraHeaders) {
265
+ return this.ExecuteRequestWrapper("/Server/DeleteUsers", request, "X-SecretKey", extraHeaders);
266
+ }
267
+ /**
268
+ * Inform the matchmaker that a Game Server Instance is removed.
269
+ *
270
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/deregistergame Microsoft Documentation}
271
+ * @deprecated Do not use
272
+ */
273
+ DeregisterGame(request, extraHeaders) {
274
+ return this.ExecuteRequestWrapper("/Server/DeregisterGame", request, "X-SecretKey", extraHeaders);
275
+ }
276
+ /**
277
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
278
+ * version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
279
+ * have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to
280
+ * UnlockContainer.
281
+ *
282
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable Microsoft Documentation}
283
+ * @example
284
+ * await serverClient.EvaluateRandomResultTable({
285
+ * "TableId": "RareElementCard",
286
+ * "CatalogVersion": "1"
287
+ * });
288
+ */
289
+ EvaluateRandomResultTable(request, extraHeaders) {
290
+ return this.ExecuteRequestWrapper("/Server/EvaluateRandomResultTable", request, "X-SecretKey", extraHeaders);
291
+ }
292
+ /**
293
+ * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
294
+ * PlayFab ID is the entity ID of the player's master_player_account entity.
295
+ *
296
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript Microsoft Documentation}
297
+ * @example
298
+ * await serverClient.ExecuteCloudScript({
299
+ * "PlayFabId": "1337D00D",
300
+ * "FunctionName": "levelCompleted",
301
+ * "FunctionParameter": {
302
+ * "level": 3,
303
+ * "points": 400
304
+ * },
305
+ * "RevisionSelection": "Live",
306
+ * "GeneratePlayStreamEvent": true
307
+ * });
308
+ */
309
+ ExecuteCloudScript(request, extraHeaders) {
310
+ return this.ExecuteRequestWrapper("/Server/ExecuteCloudScript", request, "X-SecretKey", extraHeaders);
311
+ }
312
+ /**
313
+ * Retrieve a list of all PlayStream actions groups.
314
+ *
315
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getallactiongroups Microsoft Documentation}
316
+ * @deprecated Please use GetAllSegments instead.
317
+ */
318
+ GetAllActionGroups(request, extraHeaders) {
319
+ return this.ExecuteRequestWrapper("/Server/GetAllActionGroups", request, "X-SecretKey", extraHeaders);
320
+ }
321
+ /**
322
+ * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
323
+ * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
324
+ *
325
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments Microsoft Documentation}
326
+ * @example
327
+ * await serverClient.GetAllSegments({});
328
+ */
329
+ GetAllSegments(request, extraHeaders) {
330
+ return this.ExecuteRequestWrapper("/Server/GetAllSegments", request, "X-SecretKey", extraHeaders);
331
+ }
332
+ /**
333
+ * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
334
+ * evaluated with the parent PlayFabId to guarantee uniqueness.
335
+ *
336
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters Microsoft Documentation}
337
+ * @example
338
+ * await serverClient.GetAllUsersCharacters({
339
+ * "PlayFabId": "98333765432"
340
+ * });
341
+ */
342
+ GetAllUsersCharacters(request, extraHeaders) {
343
+ return this.ExecuteRequestWrapper("/Server/GetAllUsersCharacters", request, "X-SecretKey", extraHeaders);
344
+ }
345
+ /**
346
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
347
+ * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
348
+ *
349
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems Microsoft Documentation}
350
+ * @example
351
+ * await serverClient.GetCatalogItems({
352
+ * "CatalogVersion": "1"
353
+ * });
354
+ */
355
+ GetCatalogItems(request, extraHeaders) {
356
+ return this.ExecuteRequestWrapper("/Server/GetCatalogItems", request, "X-SecretKey", extraHeaders);
357
+ }
358
+ /**
359
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
360
+ *
361
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata Microsoft Documentation}
362
+ * @example
363
+ * await serverClient.GetCharacterData({
364
+ * "PlayFabId": "2039475",
365
+ * "CharacterId": "98342357",
366
+ * "Keys": [
367
+ * "preferences",
368
+ * "progress"
369
+ * ],
370
+ * "IfChangedFromDataVersion": 1
371
+ * });
372
+ */
373
+ GetCharacterData(request, extraHeaders) {
374
+ return this.ExecuteRequestWrapper("/Server/GetCharacterData", request, "X-SecretKey", extraHeaders);
375
+ }
376
+ /**
377
+ * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
378
+ *
379
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata Microsoft Documentation}
380
+ * @example
381
+ * await serverClient.GetCharacterInternalData({
382
+ * "PlayFabId": "2039475",
383
+ * "CharacterId": "98342357",
384
+ * "Keys": [
385
+ * "preferences",
386
+ * "progress"
387
+ * ],
388
+ * "IfChangedFromDataVersion": 1
389
+ * });
390
+ */
391
+ GetCharacterInternalData(request, extraHeaders) {
392
+ return this.ExecuteRequestWrapper("/Server/GetCharacterInternalData", request, "X-SecretKey", extraHeaders);
393
+ }
394
+ /**
395
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
396
+ * version 2._ Retrieves the specified character's current inventory of virtual goods
397
+ *
398
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory Microsoft Documentation}
399
+ * @example
400
+ * await serverClient.GetCharacterInventory({
401
+ * "PlayFabId": "204883457",
402
+ * "CharacterId": "9890723423",
403
+ * "CatalogVersion": "5"
404
+ * });
405
+ */
406
+ GetCharacterInventory(request, extraHeaders) {
407
+ return this.ExecuteRequestWrapper("/Server/GetCharacterInventory", request, "X-SecretKey", extraHeaders);
408
+ }
409
+ /**
410
+ * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
411
+ *
412
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard Microsoft Documentation}
413
+ * @example
414
+ * await serverClient.GetCharacterLeaderboard({
415
+ * "StatisticName": "Kills",
416
+ * "StartPosition": 0,
417
+ * "MaxResultsCount": 20
418
+ * });
419
+ */
420
+ GetCharacterLeaderboard(request, extraHeaders) {
421
+ return this.ExecuteRequestWrapper("/Server/GetCharacterLeaderboard", request, "X-SecretKey", extraHeaders);
422
+ }
423
+ /**
424
+ * Retrieves the title-specific custom data for the user's character which can only be read by the client
425
+ *
426
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata Microsoft Documentation}
427
+ * @example
428
+ * await serverClient.GetCharacterReadOnlyData({
429
+ * "PlayFabId": "2039475",
430
+ * "CharacterId": "98342357",
431
+ * "Keys": [
432
+ * "preferences",
433
+ * "progress"
434
+ * ],
435
+ * "IfChangedFromDataVersion": 1
436
+ * });
437
+ */
438
+ GetCharacterReadOnlyData(request, extraHeaders) {
439
+ return this.ExecuteRequestWrapper("/Server/GetCharacterReadOnlyData", request, "X-SecretKey", extraHeaders);
440
+ }
441
+ /**
442
+ * Retrieves the details of all title-specific statistics for the specific character
443
+ *
444
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics Microsoft Documentation}
445
+ * @example
446
+ * await serverClient.GetCharacterStatistics({
447
+ * "PlayFabId": "10931252888739651331",
448
+ * "CharacterId": "98765432"
449
+ * });
450
+ */
451
+ GetCharacterStatistics(request, extraHeaders) {
452
+ return this.ExecuteRequestWrapper("/Server/GetCharacterStatistics", request, "X-SecretKey", extraHeaders);
453
+ }
454
+ /**
455
+ * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
456
+ * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
457
+ * content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
458
+ * the query to retrieve the data will fail. See this post for more information:
459
+ * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
460
+ * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
461
+ *
462
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl Microsoft Documentation}
463
+ * @example
464
+ * await serverClient.GetContentDownloadUrl({
465
+ * "Key": "images/sword_icon.png"
466
+ * });
467
+ */
468
+ GetContentDownloadUrl(request, extraHeaders) {
469
+ return this.ExecuteRequestWrapper("/Server/GetContentDownloadUrl", request, "X-SecretKey", extraHeaders);
470
+ }
471
+ /**
472
+ * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
473
+ * leaderboard
474
+ *
475
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard Microsoft Documentation}
476
+ * @example
477
+ * await serverClient.GetFriendLeaderboard({
478
+ * "PlayFabId": "98092347523",
479
+ * "StatisticName": "Kills",
480
+ * "StartPosition": 1258,
481
+ * "MaxResultsCount": 20,
482
+ * "ExternalPlatformFriends": "None"
483
+ * });
484
+ */
485
+ GetFriendLeaderboard(request, extraHeaders) {
486
+ return this.ExecuteRequestWrapper("/Server/GetFriendLeaderboard", request, "X-SecretKey", extraHeaders);
487
+ }
488
+ /**
489
+ * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from
490
+ * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
491
+ *
492
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist Microsoft Documentation}
493
+ * @example
494
+ * await serverClient.GetFriendsList({
495
+ * "PlayFabId": "93798903892789754",
496
+ * "ExternalPlatformFriends": "All"
497
+ * });
498
+ */
499
+ GetFriendsList(request, extraHeaders) {
500
+ return this.ExecuteRequestWrapper("/Server/GetFriendsList", request, "X-SecretKey", extraHeaders);
501
+ }
502
+ /**
503
+ * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
504
+ *
505
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard Microsoft Documentation}
506
+ * @example
507
+ * await serverClient.GetLeaderboard({
508
+ * "StatisticName": "Kills",
509
+ * "StartPosition": 0,
510
+ * "MaxResultsCount": 20
511
+ * });
512
+ */
513
+ GetLeaderboard(request, extraHeaders) {
514
+ return this.ExecuteRequestWrapper("/Server/GetLeaderboard", request, "X-SecretKey", extraHeaders);
515
+ }
516
+ /**
517
+ * Retrieves a list of ranked characters for the given statistic, centered on the requested user
518
+ *
519
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter Microsoft Documentation}
520
+ * @example
521
+ * await serverClient.GetLeaderboardAroundCharacter({
522
+ * "StatisticName": "Kills",
523
+ * "PlayFabId": "10931252888739651331",
524
+ * "CharacterId": "987343220",
525
+ * "MaxResultsCount": 20
526
+ * });
527
+ */
528
+ GetLeaderboardAroundCharacter(request, extraHeaders) {
529
+ return this.ExecuteRequestWrapper("/Server/GetLeaderboardAroundCharacter", request, "X-SecretKey", extraHeaders);
530
+ }
531
+ /**
532
+ * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
533
+ *
534
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser Microsoft Documentation}
535
+ * @example
536
+ * await serverClient.GetLeaderboardAroundUser({
537
+ * "StatisticName": "Kills",
538
+ * "PlayFabId": "10931252888739651331",
539
+ * "MaxResultsCount": 20
540
+ * });
541
+ */
542
+ GetLeaderboardAroundUser(request, extraHeaders) {
543
+ return this.ExecuteRequestWrapper("/Server/GetLeaderboardAroundUser", request, "X-SecretKey", extraHeaders);
544
+ }
545
+ /**
546
+ * Retrieves a list of all of the user's characters for the given statistic.
547
+ *
548
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters Microsoft Documentation}
549
+ * @example
550
+ * await serverClient.GetLeaderboardForUserCharacters({
551
+ * "StatisticName": "Kills",
552
+ * "PlayFabId": "10931252888739651331"
553
+ * });
554
+ */
555
+ GetLeaderboardForUserCharacters(request, extraHeaders) {
556
+ return this.ExecuteRequestWrapper("/Server/GetLeaderboardForUserCharacters", request, "X-SecretKey", extraHeaders);
557
+ }
558
+ /**
559
+ * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
560
+ * returned. All parameters default to false.
561
+ *
562
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo Microsoft Documentation}
563
+ * @example
564
+ * await serverClient.GetPlayerCombinedInfo({
565
+ * "PlayFabId": "4027527BF22653D1",
566
+ * "InfoRequestParameters": {
567
+ * "GetUserAccountInfo": true,
568
+ * "GetUserInventory": false,
569
+ * "GetUserVirtualCurrency": true,
570
+ * "GetUserData": true,
571
+ * "UserDataKeys": [
572
+ * "preferences",
573
+ * "progress"
574
+ * ],
575
+ * "GetUserReadOnlyData": false,
576
+ * "GetCharacterInventories": false,
577
+ * "GetCharacterList": false,
578
+ * "GetTitleData": false,
579
+ * "GetPlayerStatistics": false,
580
+ * "GetPlayerProfile": false,
581
+ * "GetEntityLineage": false
582
+ * }
583
+ * });
584
+ */
585
+ GetPlayerCombinedInfo(request, extraHeaders) {
586
+ return this.ExecuteRequestWrapper("/Server/GetPlayerCombinedInfo", request, "X-SecretKey", extraHeaders);
587
+ }
588
+ /**
589
+ * Retrieves a title-specific custom property value for a player.
590
+ *
591
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty Microsoft Documentation}
592
+ * @example
593
+ * await serverClient.GetPlayerCustomProperty({
594
+ * "PlayFabId": "2039475",
595
+ * "PropertyName": "level"
596
+ * });
597
+ */
598
+ GetPlayerCustomProperty(request, extraHeaders) {
599
+ return this.ExecuteRequestWrapper("/Server/GetPlayerCustomProperty", request, "X-SecretKey", extraHeaders);
600
+ }
601
+ /**
602
+ * Retrieves the player's profile
603
+ *
604
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile Microsoft Documentation}
605
+ * @example
606
+ * await serverClient.GetPlayerProfile({
607
+ * "PlayFabId": "621EF20237534A44"
608
+ * });
609
+ */
610
+ GetPlayerProfile(request, extraHeaders) {
611
+ return this.ExecuteRequestWrapper("/Server/GetPlayerProfile", request, "X-SecretKey", extraHeaders);
612
+ }
613
+ /**
614
+ * List all segments that a player currently belongs to at this moment in time.
615
+ *
616
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments Microsoft Documentation}
617
+ * @example
618
+ * await serverClient.GetPlayerSegments({
619
+ * "PlayFabId": "1337AA00"
620
+ * });
621
+ */
622
+ GetPlayerSegments(request, extraHeaders) {
623
+ return this.ExecuteRequestWrapper("/Server/GetPlayerSegments", request, "X-SecretKey", extraHeaders);
624
+ }
625
+ /**
626
+ * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
627
+ * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
628
+ * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
629
+ * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
630
+ * called 30 times in one minute. You will be returned an error if you exceed this threshold.
631
+ *
632
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment Microsoft Documentation}
633
+ * @example
634
+ * await serverClient.GetPlayersInSegment({
635
+ * "SegmentId": "1337AA00",
636
+ * "SecondsToLive": 5,
637
+ * "MaxBatchSize": 500
638
+ * });
639
+ */
640
+ GetPlayersInSegment(request, extraHeaders) {
641
+ return this.ExecuteRequestWrapper("/Server/GetPlayersInSegment", request, "X-SecretKey", extraHeaders);
642
+ }
643
+ /**
644
+ * Retrieves the current version and values for the indicated statistics, for the local player.
645
+ *
646
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics Microsoft Documentation}
647
+ * @example
648
+ * await serverClient.GetPlayerStatistics({
649
+ * "PlayFabId": "621EF2023753444",
650
+ * "StatisticNames": [
651
+ * "Points",
652
+ * "Wins"
653
+ * ]
654
+ * });
655
+ */
656
+ GetPlayerStatistics(request, extraHeaders) {
657
+ return this.ExecuteRequestWrapper("/Server/GetPlayerStatistics", request, "X-SecretKey", extraHeaders);
658
+ }
659
+ /**
660
+ * Retrieves the information on the available versions of the specified statistic.
661
+ *
662
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions Microsoft Documentation}
663
+ * @example
664
+ * await serverClient.GetPlayerStatisticVersions({
665
+ * "StatisticName": "headshots"
666
+ * });
667
+ */
668
+ GetPlayerStatisticVersions(request, extraHeaders) {
669
+ return this.ExecuteRequestWrapper("/Server/GetPlayerStatisticVersions", request, "X-SecretKey", extraHeaders);
670
+ }
671
+ /**
672
+ * Get all tags with a given Namespace (optional) from a player profile.
673
+ *
674
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags Microsoft Documentation}
675
+ * @example
676
+ * await serverClient.GetPlayerTags({
677
+ * "PlayFabId": "10931252888739651331",
678
+ * "Namespace": "title.AAA"
679
+ * });
680
+ */
681
+ GetPlayerTags(request, extraHeaders) {
682
+ return this.ExecuteRequestWrapper("/Server/GetPlayerTags", request, "X-SecretKey", extraHeaders);
683
+ }
684
+ /**
685
+ * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
686
+ *
687
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids Microsoft Documentation}
688
+ * @example
689
+ * await serverClient.GetPlayFabIDsFromBattleNetAccountIds({
690
+ * "BattleNetAccountIds": [
691
+ * "526f79204261747478",
692
+ * "526f79204261747479"
693
+ * ]
694
+ * });
695
+ */
696
+ GetPlayFabIDsFromBattleNetAccountIds(request, extraHeaders) {
697
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromBattleNetAccountIds", request, "X-SecretKey", extraHeaders);
698
+ }
699
+ /**
700
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
701
+ *
702
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids Microsoft Documentation}
703
+ * @example
704
+ * await serverClient.GetPlayFabIDsFromFacebookIDs({
705
+ * "FacebookIDs": [
706
+ * "857498576495",
707
+ * "759374651209"
708
+ * ]
709
+ * });
710
+ */
711
+ GetPlayFabIDsFromFacebookIDs(request, extraHeaders) {
712
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromFacebookIDs", request, "X-SecretKey", extraHeaders);
713
+ }
714
+ /**
715
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.
716
+ *
717
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids Microsoft Documentation}
718
+ * @example
719
+ * await serverClient.GetPlayFabIDsFromFacebookInstantGamesIds({
720
+ * "FacebookInstantGamesIds": [
721
+ * "1114685845316172",
722
+ * "1114685845316173"
723
+ * ]
724
+ * });
725
+ */
726
+ GetPlayFabIDsFromFacebookInstantGamesIds(request, extraHeaders) {
727
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromFacebookInstantGamesIds", request, "X-SecretKey", extraHeaders);
728
+ }
729
+ /**
730
+ * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
731
+ * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
732
+ * added to the player account.
733
+ *
734
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids Microsoft Documentation}
735
+ * @example
736
+ * await serverClient.GetPlayFabIDsFromGenericIDs({
737
+ * "GenericIDs": [
738
+ * {
739
+ * "ServiceName": "BigBizSocial",
740
+ * "UserId": "1234567890"
741
+ * },
742
+ * {
743
+ * "ServiceName": "VeeCeeMe",
744
+ * "UserId": "og5igh85gf43gf"
745
+ * }
746
+ * ]
747
+ * });
748
+ */
749
+ GetPlayFabIDsFromGenericIDs(request, extraHeaders) {
750
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromGenericIDs", request, "X-SecretKey", extraHeaders);
751
+ }
752
+ /**
753
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
754
+ *
755
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids Microsoft Documentation}
756
+ * @example
757
+ * await serverClient.GetPlayFabIDsFromNintendoServiceAccountIds({
758
+ * "NintendoAccountIds": [
759
+ * "526f79204261747478",
760
+ * "526f79204261747479"
761
+ * ]
762
+ * });
763
+ */
764
+ GetPlayFabIDsFromNintendoServiceAccountIds(request, extraHeaders) {
765
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromNintendoServiceAccountIds", request, "X-SecretKey", extraHeaders);
766
+ }
767
+ /**
768
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
769
+ *
770
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids Microsoft Documentation}
771
+ * @example
772
+ * await serverClient.GetPlayFabIDsFromNintendoSwitchDeviceIds({
773
+ * "NintendoSwitchDeviceIds": [
774
+ * "526f79204261747478",
775
+ * "526f79204261747479"
776
+ * ]
777
+ * });
778
+ */
779
+ GetPlayFabIDsFromNintendoSwitchDeviceIds(request, extraHeaders) {
780
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-SecretKey", extraHeaders);
781
+ }
782
+ /**
783
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
784
+ *
785
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids Microsoft Documentation}
786
+ * @example
787
+ * await serverClient.GetPlayFabIDsFromPSNAccountIDs({
788
+ * "PSNAccountIDs": [
789
+ * "857498576495",
790
+ * "759374651209"
791
+ * ]
792
+ * });
793
+ */
794
+ GetPlayFabIDsFromPSNAccountIDs(request, extraHeaders) {
795
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNAccountIDs", request, "X-SecretKey", extraHeaders);
796
+ }
797
+ /**
798
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
799
+ *
800
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids Microsoft Documentation}
801
+ * @example
802
+ * await serverClient.GetPlayFabIDsFromPSNOnlineIDs({
803
+ * "PSNOnlineIDs": [
804
+ * "857555576495",
805
+ * "759345551209"
806
+ * ]
807
+ * });
808
+ */
809
+ GetPlayFabIDsFromPSNOnlineIDs(request, extraHeaders) {
810
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNOnlineIDs", request, "X-SecretKey", extraHeaders);
811
+ }
812
+ /**
813
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
814
+ * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
815
+ *
816
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids Microsoft Documentation}
817
+ * @example
818
+ * await serverClient.GetPlayFabIDsFromSteamIDs({
819
+ * "SteamStringIDs": [
820
+ * "857498576495",
821
+ * "759374651209"
822
+ * ]
823
+ * });
824
+ */
825
+ GetPlayFabIDsFromSteamIDs(request, extraHeaders) {
826
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamIDs", request, "X-SecretKey", extraHeaders);
827
+ }
828
+ /**
829
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
830
+ * names.
831
+ *
832
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames Microsoft Documentation}
833
+ * @example
834
+ * await serverClient.GetPlayFabIDsFromSteamNames({
835
+ * "SteamNames": [
836
+ * "steamPersonaName1",
837
+ * "steamPersonaName2"
838
+ * ]
839
+ * });
840
+ */
841
+ GetPlayFabIDsFromSteamNames(request, extraHeaders) {
842
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamNames", request, "X-SecretKey", extraHeaders);
843
+ }
844
+ /**
845
+ * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
846
+ * the user accounts, available as "_id" from the Twitch API methods (ex:
847
+ * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
848
+ *
849
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids Microsoft Documentation}
850
+ * @example
851
+ * await serverClient.GetPlayFabIDsFromTwitchIDs({
852
+ * "TwitchIds": [
853
+ * "127168541",
854
+ * "88315720"
855
+ * ]
856
+ * });
857
+ */
858
+ GetPlayFabIDsFromTwitchIDs(request, extraHeaders) {
859
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromTwitchIDs", request, "X-SecretKey", extraHeaders);
860
+ }
861
+ /**
862
+ * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
863
+ *
864
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids Microsoft Documentation}
865
+ * @example
866
+ * await serverClient.GetPlayFabIDsFromXboxLiveIDs({
867
+ * "XboxLiveAccountIDs": [
868
+ * "857498576495",
869
+ * "759374651209"
870
+ * ],
871
+ * "Sandbox": "RETAIL"
872
+ * });
873
+ */
874
+ GetPlayFabIDsFromXboxLiveIDs(request, extraHeaders) {
875
+ return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromXboxLiveIDs", request, "X-SecretKey", extraHeaders);
876
+ }
877
+ /**
878
+ * Retrieves the key-value store of custom publisher settings
879
+ *
880
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata Microsoft Documentation}
881
+ * @example
882
+ * await serverClient.GetPublisherData({
883
+ * "Keys": [
884
+ * "color",
885
+ * "propertyA"
886
+ * ]
887
+ * });
888
+ */
889
+ GetPublisherData(request, extraHeaders) {
890
+ return this.ExecuteRequestWrapper("/Server/GetPublisherData", request, "X-SecretKey", extraHeaders);
891
+ }
892
+ /**
893
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
894
+ * version 2._ Retrieves the configuration information for the specified random results tables for the title, including all
895
+ * ItemId values and weights
896
+ *
897
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables Microsoft Documentation}
898
+ * @example
899
+ * await serverClient.GetRandomResultTables({
900
+ * "CatalogVersion": "1",
901
+ * "TableIDs": [
902
+ * "CommonElementCard",
903
+ * "UncommonElementCard",
904
+ * "RareElementCard"
905
+ * ]
906
+ * });
907
+ */
908
+ GetRandomResultTables(request, extraHeaders) {
909
+ return this.ExecuteRequestWrapper("/Server/GetRandomResultTables", request, "X-SecretKey", extraHeaders);
910
+ }
911
+ /**
912
+ * Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
913
+ *
914
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids Microsoft Documentation}
915
+ * @example
916
+ * await serverClient.GetServerCustomIDsFromPlayFabIDs({
917
+ * "PlayFabIDs": [
918
+ * "1232421311"
919
+ * ]
920
+ * });
921
+ */
922
+ GetServerCustomIDsFromPlayFabIDs(request, extraHeaders) {
923
+ return this.ExecuteRequestWrapper("/Server/GetServerCustomIDsFromPlayFabIDs", request, "X-SecretKey", extraHeaders);
924
+ }
925
+ /**
926
+ * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
927
+ * public and private group data. Shared Groups are designed for sharing data between a very small number of players,
928
+ * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
929
+ *
930
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata Microsoft Documentation}
931
+ * @example
932
+ * await serverClient.GetSharedGroupData({
933
+ * "SharedGroupId": "Clan Data",
934
+ * "Keys": [
935
+ * "ClanKills",
936
+ * "LastClanUpdate"
937
+ * ],
938
+ * "GetMembers": true
939
+ * });
940
+ */
941
+ GetSharedGroupData(request, extraHeaders) {
942
+ return this.ExecuteRequestWrapper("/Server/GetSharedGroupData", request, "X-SecretKey", extraHeaders);
943
+ }
944
+ /**
945
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
946
+ * version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified
947
+ * player
948
+ *
949
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems Microsoft Documentation}
950
+ * @example
951
+ * await serverClient.GetStoreItems({
952
+ * "StoreId": "BonusStore",
953
+ * "PlayFabId": "20394883"
954
+ * });
955
+ */
956
+ GetStoreItems(request, extraHeaders) {
957
+ return this.ExecuteRequestWrapper("/Server/GetStoreItems", request, "X-SecretKey", extraHeaders);
958
+ }
959
+ /**
960
+ * Retrieves the current server time
961
+ *
962
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime Microsoft Documentation}
963
+ * @example
964
+ * await serverClient.GetTime({});
965
+ */
966
+ GetTime(request, extraHeaders) {
967
+ return this.ExecuteRequestWrapper("/Server/GetTime", request, "X-SecretKey", extraHeaders);
968
+ }
969
+ /**
970
+ * Retrieves the key-value store of custom title settings
971
+ *
972
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata Microsoft Documentation}
973
+ * @example
974
+ * await serverClient.GetTitleData({
975
+ * "Keys": [
976
+ * "color",
977
+ * "propertyA"
978
+ * ]
979
+ * });
980
+ */
981
+ GetTitleData(request, extraHeaders) {
982
+ return this.ExecuteRequestWrapper("/Server/GetTitleData", request, "X-SecretKey", extraHeaders);
983
+ }
984
+ /**
985
+ * Retrieves the key-value store of custom internal title settings
986
+ *
987
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata Microsoft Documentation}
988
+ * @example
989
+ * await serverClient.GetTitleInternalData({
990
+ * "Keys": [
991
+ * "color",
992
+ * "propertyA"
993
+ * ]
994
+ * });
995
+ */
996
+ GetTitleInternalData(request, extraHeaders) {
997
+ return this.ExecuteRequestWrapper("/Server/GetTitleInternalData", request, "X-SecretKey", extraHeaders);
998
+ }
999
+ /**
1000
+ * Retrieves the title news feed, as configured in the developer portal
1001
+ *
1002
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews Microsoft Documentation}
1003
+ * @example
1004
+ * await serverClient.GetTitleNews({
1005
+ * "Count": 25
1006
+ * });
1007
+ */
1008
+ GetTitleNews(request, extraHeaders) {
1009
+ return this.ExecuteRequestWrapper("/Server/GetTitleNews", request, "X-SecretKey", extraHeaders);
1010
+ }
1011
+ /**
1012
+ * Retrieves the relevant details for a specified user
1013
+ *
1014
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo Microsoft Documentation}
1015
+ * @example
1016
+ * await serverClient.GetUserAccountInfo({
1017
+ * "PlayFabId": "10931252888739651331"
1018
+ * });
1019
+ */
1020
+ GetUserAccountInfo(request, extraHeaders) {
1021
+ return this.ExecuteRequestWrapper("/Server/GetUserAccountInfo", request, "X-SecretKey", extraHeaders);
1022
+ }
1023
+ /**
1024
+ * Gets all bans for a user.
1025
+ *
1026
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans Microsoft Documentation}
1027
+ * @example
1028
+ * await serverClient.GetUserBans({
1029
+ * "PlayFabId": "1679AF5CD04BD838"
1030
+ * });
1031
+ */
1032
+ GetUserBans(request, extraHeaders) {
1033
+ return this.ExecuteRequestWrapper("/Server/GetUserBans", request, "X-SecretKey", extraHeaders);
1034
+ }
1035
+ /**
1036
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
1037
+ *
1038
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata Microsoft Documentation}
1039
+ * @example
1040
+ * await serverClient.GetUserData({
1041
+ * "PlayFabId": "2039475",
1042
+ * "Keys": [
1043
+ * "preferences",
1044
+ * "progress"
1045
+ * ],
1046
+ * "IfChangedFromDataVersion": 13
1047
+ * });
1048
+ */
1049
+ GetUserData(request, extraHeaders) {
1050
+ return this.ExecuteRequestWrapper("/Server/GetUserData", request, "X-SecretKey", extraHeaders);
1051
+ }
1052
+ /**
1053
+ * Retrieves the title-specific custom data for the user which cannot be accessed by the client
1054
+ *
1055
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata Microsoft Documentation}
1056
+ * @example
1057
+ * await serverClient.GetUserInternalData({
1058
+ * "PlayFabId": "2039475",
1059
+ * "Keys": [
1060
+ * "preferences",
1061
+ * "progress"
1062
+ * ],
1063
+ * "IfChangedFromDataVersion": 13
1064
+ * });
1065
+ */
1066
+ GetUserInternalData(request, extraHeaders) {
1067
+ return this.ExecuteRequestWrapper("/Server/GetUserInternalData", request, "X-SecretKey", extraHeaders);
1068
+ }
1069
+ /**
1070
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1071
+ * version 2._ Retrieves the specified user's current inventory of virtual goods
1072
+ *
1073
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory Microsoft Documentation}
1074
+ * @example
1075
+ * await serverClient.GetUserInventory({
1076
+ * "PlayFabId": "204883457"
1077
+ * });
1078
+ */
1079
+ GetUserInventory(request, extraHeaders) {
1080
+ return this.ExecuteRequestWrapper("/Server/GetUserInventory", request, "X-SecretKey", extraHeaders);
1081
+ }
1082
+ /**
1083
+ * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
1084
+ *
1085
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata Microsoft Documentation}
1086
+ * @example
1087
+ * await serverClient.GetUserPublisherData({
1088
+ * "PlayFabId": "2039475",
1089
+ * "Keys": [
1090
+ * "preferences",
1091
+ * "progress"
1092
+ * ],
1093
+ * "IfChangedFromDataVersion": 13
1094
+ * });
1095
+ */
1096
+ GetUserPublisherData(request, extraHeaders) {
1097
+ return this.ExecuteRequestWrapper("/Server/GetUserPublisherData", request, "X-SecretKey", extraHeaders);
1098
+ }
1099
+ /**
1100
+ * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
1101
+ *
1102
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata Microsoft Documentation}
1103
+ * @example
1104
+ * await serverClient.GetUserPublisherInternalData({
1105
+ * "PlayFabId": "2039475",
1106
+ * "Keys": [
1107
+ * "preferences",
1108
+ * "progress"
1109
+ * ],
1110
+ * "IfChangedFromDataVersion": 13
1111
+ * });
1112
+ */
1113
+ GetUserPublisherInternalData(request, extraHeaders) {
1114
+ return this.ExecuteRequestWrapper("/Server/GetUserPublisherInternalData", request, "X-SecretKey", extraHeaders);
1115
+ }
1116
+ /**
1117
+ * Retrieves the publisher-specific custom data for the user which can only be read by the client
1118
+ *
1119
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
1120
+ * @example
1121
+ * await serverClient.GetUserPublisherReadOnlyData({
1122
+ * "PlayFabId": "2039475",
1123
+ * "Keys": [
1124
+ * "preferences",
1125
+ * "progress"
1126
+ * ],
1127
+ * "IfChangedFromDataVersion": 13
1128
+ * });
1129
+ */
1130
+ GetUserPublisherReadOnlyData(request, extraHeaders) {
1131
+ return this.ExecuteRequestWrapper("/Server/GetUserPublisherReadOnlyData", request, "X-SecretKey", extraHeaders);
1132
+ }
1133
+ /**
1134
+ * Retrieves the title-specific custom data for the user which can only be read by the client
1135
+ *
1136
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata Microsoft Documentation}
1137
+ * @example
1138
+ * await serverClient.GetUserReadOnlyData({
1139
+ * "PlayFabId": "2039475",
1140
+ * "Keys": [
1141
+ * "preferences",
1142
+ * "progress"
1143
+ * ],
1144
+ * "IfChangedFromDataVersion": 13
1145
+ * });
1146
+ */
1147
+ GetUserReadOnlyData(request, extraHeaders) {
1148
+ return this.ExecuteRequestWrapper("/Server/GetUserReadOnlyData", request, "X-SecretKey", extraHeaders);
1149
+ }
1150
+ /**
1151
+ * Retrieves the details of all title-specific statistics for the user
1152
+ *
1153
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserstatistics Microsoft Documentation}
1154
+ * @deprecated Please use GetPlayerStatistics instead.
1155
+ */
1156
+ GetUserStatistics(request, extraHeaders) {
1157
+ return this.ExecuteRequestWrapper("/Server/GetUserStatistics", request, "X-SecretKey", extraHeaders);
1158
+ }
1159
+ /**
1160
+ * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
1161
+ * with the parent PlayFabId to guarantee uniqueness.
1162
+ *
1163
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser Microsoft Documentation}
1164
+ * @example
1165
+ * await serverClient.GrantCharacterToUser({
1166
+ * "PlayFabId": "20394883567",
1167
+ * "CharacterName": "FighterDude",
1168
+ * "CharacterType": "Blue Warrior"
1169
+ * });
1170
+ */
1171
+ GrantCharacterToUser(request, extraHeaders) {
1172
+ return this.ExecuteRequestWrapper("/Server/GrantCharacterToUser", request, "X-SecretKey", extraHeaders);
1173
+ }
1174
+ /**
1175
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1176
+ * version 2._ Adds the specified items to the specified character's inventory
1177
+ *
1178
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter Microsoft Documentation}
1179
+ * @example
1180
+ * await serverClient.GrantItemsToCharacter({
1181
+ * "CharacterId": "9876543268",
1182
+ * "PlayFabId": "20394883",
1183
+ * "Annotation": "Entered Level 2",
1184
+ * "ItemIds": [
1185
+ * "shield_level_5",
1186
+ * "shield_level_6"
1187
+ * ]
1188
+ * });
1189
+ */
1190
+ GrantItemsToCharacter(request, extraHeaders) {
1191
+ return this.ExecuteRequestWrapper("/Server/GrantItemsToCharacter", request, "X-SecretKey", extraHeaders);
1192
+ }
1193
+ /**
1194
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1195
+ * version 2._ Adds the specified items to the specified user's inventory
1196
+ *
1197
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser Microsoft Documentation}
1198
+ * @example
1199
+ * await serverClient.GrantItemsToUser({
1200
+ * "PlayFabId": "20394883",
1201
+ * "Annotation": "Entered Level 2",
1202
+ * "ItemIds": [
1203
+ * "shield_level_3",
1204
+ * "shield_level_4"
1205
+ * ]
1206
+ * });
1207
+ */
1208
+ GrantItemsToUser(request, extraHeaders) {
1209
+ return this.ExecuteRequestWrapper("/Server/GrantItemsToUser", request, "X-SecretKey", extraHeaders);
1210
+ }
1211
+ /**
1212
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1213
+ * version 2._ Adds the specified items to the specified user inventories
1214
+ *
1215
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers Microsoft Documentation}
1216
+ * @example
1217
+ * await serverClient.GrantItemsToUsers({
1218
+ * "CatalogVersion": "5",
1219
+ * "ItemGrants": [
1220
+ * {
1221
+ * "PlayFabId": "20394883",
1222
+ * "ItemId": "shield_level_1",
1223
+ * "Annotation": "Entered Level 2"
1224
+ * },
1225
+ * {
1226
+ * "PlayFabId": "20394883",
1227
+ * "ItemId": "shield_level_2",
1228
+ * "Annotation": "Entered Level 2",
1229
+ * "Data": {
1230
+ * "Equipped": "True",
1231
+ * "Slot": "Head"
1232
+ * }
1233
+ * }
1234
+ * ]
1235
+ * });
1236
+ */
1237
+ GrantItemsToUsers(request, extraHeaders) {
1238
+ return this.ExecuteRequestWrapper("/Server/GrantItemsToUsers", request, "X-SecretKey", extraHeaders);
1239
+ }
1240
+ /**
1241
+ * Links the Battle.net account associated with the token to the user's PlayFab account.
1242
+ *
1243
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount Microsoft Documentation}
1244
+ * @example
1245
+ * await serverClient.LinkBattleNetAccount({
1246
+ * "PlayFabId": "1234FA342",
1247
+ * "IdentityToken": "eyJraWQi..."
1248
+ * });
1249
+ */
1250
+ LinkBattleNetAccount(request, extraHeaders) {
1251
+ return this.ExecuteRequestWrapper("/Server/LinkBattleNetAccount", request, "X-SecretKey", extraHeaders);
1252
+ }
1253
+ /**
1254
+ * Links the Nintendo account associated with the token to the user's PlayFab account
1255
+ *
1256
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount Microsoft Documentation}
1257
+ * @example
1258
+ * await serverClient.LinkNintendoServiceAccount({
1259
+ * "PlayFabId": "1234FA342",
1260
+ * "IdentityToken": "eyJraWQi..."
1261
+ * });
1262
+ */
1263
+ LinkNintendoServiceAccount(request, extraHeaders) {
1264
+ return this.ExecuteRequestWrapper("/Server/LinkNintendoServiceAccount", request, "X-SecretKey", extraHeaders);
1265
+ }
1266
+ /**
1267
+ * Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
1268
+ *
1269
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject Microsoft Documentation}
1270
+ * @example
1271
+ * await serverClient.LinkNintendoServiceAccountSubject({
1272
+ * "PlayFabId": "1234FA342",
1273
+ * "Subject": "8e7Eju4j9"
1274
+ * });
1275
+ */
1276
+ LinkNintendoServiceAccountSubject(request, extraHeaders) {
1277
+ return this.ExecuteRequestWrapper("/Server/LinkNintendoServiceAccountSubject", request, "X-SecretKey", extraHeaders);
1278
+ }
1279
+ /**
1280
+ * Links the NintendoSwitchDeviceId to the user's PlayFab account
1281
+ *
1282
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid Microsoft Documentation}
1283
+ * @example
1284
+ * await serverClient.LinkNintendoSwitchDeviceId({
1285
+ * "PlayFabId": "1234FA342",
1286
+ * "NintendoSwitchDeviceId": "526f79204261747479"
1287
+ * });
1288
+ */
1289
+ LinkNintendoSwitchDeviceId(request, extraHeaders) {
1290
+ return this.ExecuteRequestWrapper("/Server/LinkNintendoSwitchDeviceId", request, "X-SecretKey", extraHeaders);
1291
+ }
1292
+ /**
1293
+ * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
1294
+ *
1295
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount Microsoft Documentation}
1296
+ * @example
1297
+ * await serverClient.LinkPSNAccount({
1298
+ * "PlayFabId": "1234FA342",
1299
+ * "AuthCode": "LKJDG7DDE",
1300
+ * "RedirectUri": "orbis://games"
1301
+ * });
1302
+ */
1303
+ LinkPSNAccount(request, extraHeaders) {
1304
+ return this.ExecuteRequestWrapper("/Server/LinkPSNAccount", request, "X-SecretKey", extraHeaders);
1305
+ }
1306
+ /**
1307
+ * Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
1308
+ *
1309
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid Microsoft Documentation}
1310
+ * @example
1311
+ * await serverClient.LinkPSNId({
1312
+ * "PlayFabId": "1234FA342",
1313
+ * "PSNUserId": "LKJDG7DDE"
1314
+ * });
1315
+ */
1316
+ LinkPSNId(request, extraHeaders) {
1317
+ return this.ExecuteRequestWrapper("/Server/LinkPSNId", request, "X-SecretKey", extraHeaders);
1318
+ }
1319
+ /**
1320
+ * Links the custom server identifier, generated by the title, to the user's PlayFab account.
1321
+ *
1322
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid Microsoft Documentation}
1323
+ * @example
1324
+ * await serverClient.LinkServerCustomId({
1325
+ * "PlayFabId": "123412341234",
1326
+ * "ServerCustomId": "67AB-5397-CC54-EA31"
1327
+ * });
1328
+ */
1329
+ LinkServerCustomId(request, extraHeaders) {
1330
+ return this.ExecuteRequestWrapper("/Server/LinkServerCustomId", request, "X-SecretKey", extraHeaders);
1331
+ }
1332
+ /**
1333
+ * Links the Steam account associated with the provided Steam ID to the user's PlayFab account
1334
+ *
1335
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid Microsoft Documentation}
1336
+ * @example
1337
+ * await serverClient.LinkSteamId({
1338
+ * "SteamId": "22223333",
1339
+ * "PlayFabId": "5a446c83645201"
1340
+ * });
1341
+ */
1342
+ LinkSteamId(request, extraHeaders) {
1343
+ return this.ExecuteRequestWrapper("/Server/LinkSteamId", request, "X-SecretKey", extraHeaders);
1344
+ }
1345
+ /**
1346
+ * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
1347
+ *
1348
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount Microsoft Documentation}
1349
+ * @example
1350
+ * await serverClient.LinkXboxAccount({
1351
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
1352
+ * "PlayFabId": "5a446c83645201"
1353
+ * });
1354
+ */
1355
+ LinkXboxAccount(request, extraHeaders) {
1356
+ return this.ExecuteRequestWrapper("/Server/LinkXboxAccount", request, "X-SecretKey", extraHeaders);
1357
+ }
1358
+ /**
1359
+ * Retrieves title-specific custom property values for a player.
1360
+ *
1361
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties Microsoft Documentation}
1362
+ * @example
1363
+ * await serverClient.ListPlayerCustomProperties({
1364
+ * "PlayFabId": "2039475"
1365
+ * });
1366
+ */
1367
+ ListPlayerCustomProperties(request, extraHeaders) {
1368
+ return this.ExecuteRequestWrapper("/Server/ListPlayerCustomProperties", request, "X-SecretKey", extraHeaders);
1369
+ }
1370
+ /**
1371
+ * Logs a custom analytics event
1372
+ *
1373
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/logevent Microsoft Documentation}
1374
+ * @deprecated Please use WritePlayerEvent instead.
1375
+ */
1376
+ LogEvent(request, extraHeaders) {
1377
+ return this.ExecuteRequestWrapper("/Server/LogEvent", request, "X-SecretKey", extraHeaders);
1378
+ }
1379
+ /**
1380
+ * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
1381
+ * API calls which require an authenticated user
1382
+ *
1383
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid Microsoft Documentation}
1384
+ * @example
1385
+ * await serverClient.LoginWithAndroidDeviceID({
1386
+ * "AndroidDeviceId": "526f79204261747479",
1387
+ * "OS": "5.0",
1388
+ * "AndroidDevice": "Nexus 6",
1389
+ * "CreateAccount": false
1390
+ * });
1391
+ */
1392
+ LoginWithAndroidDeviceID(request, extraHeaders) {
1393
+ return this.ExecuteRequestWrapper("/Server/LoginWithAndroidDeviceID", request, "X-SecretKey", extraHeaders);
1394
+ }
1395
+ /**
1396
+ * Sign in the user with a Battle.net identity token
1397
+ *
1398
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet Microsoft Documentation}
1399
+ * @example
1400
+ * await serverClient.LoginWithBattleNet({
1401
+ * "IdentityToken": "eyJraWQi..."
1402
+ * });
1403
+ */
1404
+ LoginWithBattleNet(request, extraHeaders) {
1405
+ return this.ExecuteRequestWrapper("/Server/LoginWithBattleNet", request, "X-SecretKey", extraHeaders);
1406
+ }
1407
+ /**
1408
+ * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
1409
+ * subsequently be used for API calls which require an authenticated user
1410
+ *
1411
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid Microsoft Documentation}
1412
+ * @example
1413
+ * await serverClient.LoginWithCustomID({
1414
+ * "CustomId": "67AB-5397-CC54-EA31",
1415
+ * "CreateAccount": false
1416
+ * });
1417
+ */
1418
+ LoginWithCustomID(request, extraHeaders) {
1419
+ return this.ExecuteRequestWrapper("/Server/LoginWithCustomID", request, "X-SecretKey", extraHeaders);
1420
+ }
1421
+ /**
1422
+ * Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API
1423
+ * calls which require an authenticated user
1424
+ *
1425
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid Microsoft Documentation}
1426
+ * @example
1427
+ * await serverClient.LoginWithIOSDeviceID({
1428
+ * "DeviceId": "29848d9bh8900a0b003",
1429
+ * "OS": "7.11",
1430
+ * "DeviceModel": "Iphone 5s",
1431
+ * "CreateAccount": false
1432
+ * });
1433
+ */
1434
+ LoginWithIOSDeviceID(request, extraHeaders) {
1435
+ return this.ExecuteRequestWrapper("/Server/LoginWithIOSDeviceID", request, "X-SecretKey", extraHeaders);
1436
+ }
1437
+ /**
1438
+ * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
1439
+ * subsequently be used for API calls which require an authenticated user
1440
+ *
1441
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn Microsoft Documentation}
1442
+ * @example
1443
+ * await serverClient.LoginWithPSN({
1444
+ * "AuthCode": "LKJ6D896D",
1445
+ * "RedirectUri": "orbis://games",
1446
+ * "CreateAccount": false
1447
+ * });
1448
+ */
1449
+ LoginWithPSN(request, extraHeaders) {
1450
+ return this.ExecuteRequestWrapper("/Server/LoginWithPSN", request, "X-SecretKey", extraHeaders);
1451
+ }
1452
+ /**
1453
+ * Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
1454
+ * and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
1455
+ *
1456
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid Microsoft Documentation}
1457
+ * @example
1458
+ * await serverClient.LoginWithServerCustomId({
1459
+ * "ServerCustomId": "asdalsdkjar09u23ijf",
1460
+ * "CreateAccount": true
1461
+ * });
1462
+ */
1463
+ LoginWithServerCustomId(request, extraHeaders) {
1464
+ return this.ExecuteRequestWrapper("/Server/LoginWithServerCustomId", request, "X-SecretKey", extraHeaders);
1465
+ }
1466
+ /**
1467
+ * Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which
1468
+ * require an authenticated user
1469
+ *
1470
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid Microsoft Documentation}
1471
+ * @example
1472
+ * await serverClient.LoginWithSteamId({
1473
+ * "SteamId": "12344553",
1474
+ * "CreateAccount": false
1475
+ * });
1476
+ */
1477
+ LoginWithSteamId(request, extraHeaders) {
1478
+ return this.ExecuteRequestWrapper("/Server/LoginWithSteamId", request, "X-SecretKey", extraHeaders);
1479
+ }
1480
+ /**
1481
+ * Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
1482
+ * subsequently be used for API calls which require an authenticated user
1483
+ *
1484
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox Microsoft Documentation}
1485
+ * @example
1486
+ * await serverClient.LoginWithXbox({
1487
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
1488
+ * "CreateAccount": false
1489
+ * });
1490
+ */
1491
+ LoginWithXbox(request, extraHeaders) {
1492
+ return this.ExecuteRequestWrapper("/Server/LoginWithXbox", request, "X-SecretKey", extraHeaders);
1493
+ }
1494
+ /**
1495
+ * Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API
1496
+ * calls which require an authenticated user
1497
+ *
1498
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid Microsoft Documentation}
1499
+ * @example
1500
+ * await serverClient.LoginWithXboxId({
1501
+ * "XboxId": "12344553",
1502
+ * "Sandbox": "RETAIL",
1503
+ * "CreateAccount": false
1504
+ * });
1505
+ */
1506
+ LoginWithXboxId(request, extraHeaders) {
1507
+ return this.ExecuteRequestWrapper("/Server/LoginWithXboxId", request, "X-SecretKey", extraHeaders);
1508
+ }
1509
+ /**
1510
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1511
+ * version 2._ Modifies the number of remaining uses of a player's inventory item
1512
+ *
1513
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses Microsoft Documentation}
1514
+ * @example
1515
+ * await serverClient.ModifyItemUses({
1516
+ * "PlayFabId": "20394883",
1517
+ * "ItemInstanceId": "94585729",
1518
+ * "UsesToAdd": 1
1519
+ * });
1520
+ */
1521
+ ModifyItemUses(request, extraHeaders) {
1522
+ return this.ExecuteRequestWrapper("/Server/ModifyItemUses", request, "X-SecretKey", extraHeaders);
1523
+ }
1524
+ /**
1525
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1526
+ * version 2._ Moves an item from a character's inventory into another of the users's character's inventory.
1527
+ *
1528
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter Microsoft Documentation}
1529
+ * @example
1530
+ * await serverClient.MoveItemToCharacterFromCharacter({
1531
+ * "PlayFabId": "234234897234",
1532
+ * "GivingCharacterId": "98092347523",
1533
+ * "ReceivingCharacterId": "6323489712",
1534
+ * "ItemInstanceId": "701231299999"
1535
+ * });
1536
+ */
1537
+ MoveItemToCharacterFromCharacter(request, extraHeaders) {
1538
+ return this.ExecuteRequestWrapper("/Server/MoveItemToCharacterFromCharacter", request, "X-SecretKey", extraHeaders);
1539
+ }
1540
+ /**
1541
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1542
+ * version 2._ Moves an item from a user's inventory into their character's inventory.
1543
+ *
1544
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser Microsoft Documentation}
1545
+ * @example
1546
+ * await serverClient.MoveItemToCharacterFromUser({
1547
+ * "PlayFabId": "234234897234",
1548
+ * "CharacterId": "98092347523",
1549
+ * "ItemInstanceId": "701231299999"
1550
+ * });
1551
+ */
1552
+ MoveItemToCharacterFromUser(request, extraHeaders) {
1553
+ return this.ExecuteRequestWrapper("/Server/MoveItemToCharacterFromUser", request, "X-SecretKey", extraHeaders);
1554
+ }
1555
+ /**
1556
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1557
+ * version 2._ Moves an item from a character's inventory into the owning user's inventory.
1558
+ *
1559
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter Microsoft Documentation}
1560
+ * @example
1561
+ * await serverClient.MoveItemToUserFromCharacter({
1562
+ * "PlayFabId": "234234897234",
1563
+ * "CharacterId": "98092347523",
1564
+ * "ItemInstanceId": "701231299999"
1565
+ * });
1566
+ */
1567
+ MoveItemToUserFromCharacter(request, extraHeaders) {
1568
+ return this.ExecuteRequestWrapper("/Server/MoveItemToUserFromCharacter", request, "X-SecretKey", extraHeaders);
1569
+ }
1570
+ /**
1571
+ * Informs the PlayFab match-making service that the user specified has left the Game Server Instance
1572
+ *
1573
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/notifymatchmakerplayerleft Microsoft Documentation}
1574
+ * @deprecated Do not use
1575
+ */
1576
+ NotifyMatchmakerPlayerLeft(request, extraHeaders) {
1577
+ return this.ExecuteRequestWrapper("/Server/NotifyMatchmakerPlayerLeft", request, "X-SecretKey", extraHeaders);
1578
+ }
1579
+ /**
1580
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1581
+ * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
1582
+ * Economy->Catalogs tab in the PlayFab Game Manager.
1583
+ *
1584
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon Microsoft Documentation}
1585
+ * @example
1586
+ * await serverClient.RedeemCoupon({
1587
+ * "CouponCode": "123-1234-123",
1588
+ * "CatalogVersion": "5"
1589
+ * });
1590
+ */
1591
+ RedeemCoupon(request, extraHeaders) {
1592
+ return this.ExecuteRequestWrapper("/Server/RedeemCoupon", request, "X-SecretKey", extraHeaders);
1593
+ }
1594
+ /**
1595
+ * Validates a Game Server session ticket and returns details about the user
1596
+ *
1597
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/redeemmatchmakerticket Microsoft Documentation}
1598
+ * @deprecated Do not use
1599
+ */
1600
+ RedeemMatchmakerTicket(request, extraHeaders) {
1601
+ return this.ExecuteRequestWrapper("/Server/RedeemMatchmakerTicket", request, "X-SecretKey", extraHeaders);
1602
+ }
1603
+ /**
1604
+ * Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance.
1605
+ *
1606
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/refreshgameserverinstanceheartbeat Microsoft Documentation}
1607
+ * @deprecated Do not use
1608
+ */
1609
+ RefreshGameServerInstanceHeartbeat(request, extraHeaders) {
1610
+ return this.ExecuteRequestWrapper("/Server/RefreshGameServerInstanceHeartbeat", request, "X-SecretKey", extraHeaders);
1611
+ }
1612
+ /**
1613
+ * Inform the matchmaker that a new Game Server Instance is added.
1614
+ *
1615
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/registergame Microsoft Documentation}
1616
+ * @deprecated Do not use
1617
+ */
1618
+ RegisterGame(request, extraHeaders) {
1619
+ return this.ExecuteRequestWrapper("/Server/RegisterGame", request, "X-SecretKey", extraHeaders);
1620
+ }
1621
+ /**
1622
+ * Removes the specified friend from the the user's friend list
1623
+ *
1624
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend Microsoft Documentation}
1625
+ * @example
1626
+ * await serverClient.RemoveFriend({
1627
+ * "FriendPlayFabId": "29837799",
1628
+ * "PlayFabId": "1a46086aed40f142"
1629
+ * });
1630
+ */
1631
+ RemoveFriend(request, extraHeaders) {
1632
+ return this.ExecuteRequestWrapper("/Server/RemoveFriend", request, "X-SecretKey", extraHeaders);
1633
+ }
1634
+ /**
1635
+ * Removes the specified generic service identifier from the player's PlayFab account.
1636
+ *
1637
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid Microsoft Documentation}
1638
+ * @example
1639
+ * await serverClient.RemoveGenericID({
1640
+ * "GenericId": {
1641
+ * "ServiceName": "BigBizSocial",
1642
+ * "UserId": "1234567890"
1643
+ * }
1644
+ * });
1645
+ */
1646
+ RemoveGenericID(request, extraHeaders) {
1647
+ return this.ExecuteRequestWrapper("/Server/RemoveGenericID", request, "X-SecretKey", extraHeaders);
1648
+ }
1649
+ /**
1650
+ * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
1651
+ *
1652
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag Microsoft Documentation}
1653
+ * @example
1654
+ * await serverClient.RemovePlayerTag({
1655
+ * "PlayFabId": "10931252888739651331",
1656
+ * "TagName": "MostKilled"
1657
+ * });
1658
+ */
1659
+ RemovePlayerTag(request, extraHeaders) {
1660
+ return this.ExecuteRequestWrapper("/Server/RemovePlayerTag", request, "X-SecretKey", extraHeaders);
1661
+ }
1662
+ /**
1663
+ * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the
1664
+ * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
1665
+ * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
1666
+ * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1667
+ *
1668
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers Microsoft Documentation}
1669
+ * @example
1670
+ * await serverClient.RemoveSharedGroupMembers({
1671
+ * "SharedGroupId": "Clan Data",
1672
+ * "PlayFabIds": [
1673
+ * "D984A64B832",
1674
+ * "F74A523E1562"
1675
+ * ]
1676
+ * });
1677
+ */
1678
+ RemoveSharedGroupMembers(request, extraHeaders) {
1679
+ return this.ExecuteRequestWrapper("/Server/RemoveSharedGroupMembers", request, "X-SecretKey", extraHeaders);
1680
+ }
1681
+ /**
1682
+ * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service
1683
+ * representatives for the title can take action concerning potentially toxic players.
1684
+ *
1685
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer Microsoft Documentation}
1686
+ * @example
1687
+ * await serverClient.ReportPlayer({
1688
+ * "ReporterId": "9ddafe27d6d445da",
1689
+ * "ReporteeId": "1a46086aed40f142",
1690
+ * "Comment": "cheating"
1691
+ * });
1692
+ */
1693
+ ReportPlayer(request, extraHeaders) {
1694
+ return this.ExecuteRequestWrapper("/Server/ReportPlayer", request, "X-SecretKey", extraHeaders);
1695
+ }
1696
+ /**
1697
+ * Revoke all active bans for a user.
1698
+ *
1699
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser Microsoft Documentation}
1700
+ * @example
1701
+ * await serverClient.RevokeAllBansForUser({
1702
+ * "PlayFabId": "1679AF5CD04BD838"
1703
+ * });
1704
+ */
1705
+ RevokeAllBansForUser(request, extraHeaders) {
1706
+ return this.ExecuteRequestWrapper("/Server/RevokeAllBansForUser", request, "X-SecretKey", extraHeaders);
1707
+ }
1708
+ /**
1709
+ * Revoke all active bans specified with BanId.
1710
+ *
1711
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans Microsoft Documentation}
1712
+ * @example
1713
+ * await serverClient.RevokeBans({
1714
+ * "BanIds": [
1715
+ * "E0B5FF89542D413C",
1716
+ * "EF43FF89542G1546"
1717
+ * ]
1718
+ * });
1719
+ */
1720
+ RevokeBans(request, extraHeaders) {
1721
+ return this.ExecuteRequestWrapper("/Server/RevokeBans", request, "X-SecretKey", extraHeaders);
1722
+ }
1723
+ /**
1724
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1725
+ * version 2._ Revokes access to an item in a user's inventory
1726
+ *
1727
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem Microsoft Documentation}
1728
+ * @example
1729
+ * await serverClient.RevokeInventoryItem({
1730
+ * "PlayFabId": "203945882",
1731
+ * "ItemInstanceId": "2048583045"
1732
+ * });
1733
+ */
1734
+ RevokeInventoryItem(request, extraHeaders) {
1735
+ return this.ExecuteRequestWrapper("/Server/RevokeInventoryItem", request, "X-SecretKey", extraHeaders);
1736
+ }
1737
+ /**
1738
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1739
+ * version 2._ Revokes access for up to 25 items across multiple users and characters.
1740
+ *
1741
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems Microsoft Documentation}
1742
+ * @example
1743
+ * await serverClient.RevokeInventoryItems({
1744
+ * "Items": [
1745
+ * {
1746
+ * "PlayFabId": "203945882",
1747
+ * "ItemInstanceId": "2048583045"
1748
+ * }
1749
+ * ]
1750
+ * });
1751
+ */
1752
+ RevokeInventoryItems(request, extraHeaders) {
1753
+ return this.ExecuteRequestWrapper("/Server/RevokeInventoryItems", request, "X-SecretKey", extraHeaders);
1754
+ }
1755
+ /**
1756
+ * Saves push notification template for title
1757
+ *
1758
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate Microsoft Documentation}
1759
+ * @example
1760
+ * await serverClient.SavePushNotificationTemplate({
1761
+ * "Id": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4",
1762
+ * "Name": "F8763A987E",
1763
+ * "AndroidPayload": "{ notification: { body: \"Some Message\", title: \"Subject\", body_loc_key: \"someLocKey\" } }",
1764
+ * "IOSPayload": "{ aps: { alert: { body: \"Some Message\", title: \"Subject\", \"loc-key\": \"someLocKey\" } } }",
1765
+ * "LocalizedPushNotificationTemplates": {
1766
+ * "en": {
1767
+ * "Subject": "Recent Attack",
1768
+ * "Message": "You have been attacked! Go defend your base!"
1769
+ * },
1770
+ * "fr": {
1771
+ * "Subject": "Attaque récente",
1772
+ * "Message": "Vous avez été attaqué! Va défendre ta base!"
1773
+ * }
1774
+ * }
1775
+ * });
1776
+ */
1777
+ SavePushNotificationTemplate(request, extraHeaders) {
1778
+ return this.ExecuteRequestWrapper("/Server/SavePushNotificationTemplate", request, "X-SecretKey", extraHeaders);
1779
+ }
1780
+ /**
1781
+ * Forces an email to be sent to the registered contact email address for the user's account based on an account recovery
1782
+ * email template
1783
+ *
1784
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail Microsoft Documentation}
1785
+ * @example
1786
+ * await serverClient.SendCustomAccountRecoveryEmail({
1787
+ * "EmailTemplateId": "D53AB15D8F12E330",
1788
+ * "Email": "Me@here.com"
1789
+ * });
1790
+ */
1791
+ SendCustomAccountRecoveryEmail(request, extraHeaders) {
1792
+ return this.ExecuteRequestWrapper("/Server/SendCustomAccountRecoveryEmail", request, "X-SecretKey", extraHeaders);
1793
+ }
1794
+ /**
1795
+ * Sends an email based on an email template to a player's contact email
1796
+ *
1797
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate Microsoft Documentation}
1798
+ * @example
1799
+ * await serverClient.SendEmailFromTemplate({
1800
+ * "EmailTemplateId": "B53CA15D92D2E331",
1801
+ * "PlayFabId": "A01DC15D8E12E230"
1802
+ * });
1803
+ */
1804
+ SendEmailFromTemplate(request, extraHeaders) {
1805
+ return this.ExecuteRequestWrapper("/Server/SendEmailFromTemplate", request, "X-SecretKey", extraHeaders);
1806
+ }
1807
+ /**
1808
+ * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push
1809
+ * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
1810
+ *
1811
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification Microsoft Documentation}
1812
+ * @example
1813
+ * await serverClient.SendPushNotification({
1814
+ * "Recipient": "F8763A987E",
1815
+ * "Message": "You have been attacked! Go defend your base!"
1816
+ * });
1817
+ */
1818
+ SendPushNotification(request, extraHeaders) {
1819
+ return this.ExecuteRequestWrapper("/Server/SendPushNotification", request, "X-SecretKey", extraHeaders);
1820
+ }
1821
+ /**
1822
+ * Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push
1823
+ * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
1824
+ *
1825
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate Microsoft Documentation}
1826
+ * @example
1827
+ * await serverClient.SendPushNotificationFromTemplate({
1828
+ * "Recipient": "F8763A987E",
1829
+ * "PushNotificationTemplateId": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4"
1830
+ * });
1831
+ */
1832
+ SendPushNotificationFromTemplate(request, extraHeaders) {
1833
+ return this.ExecuteRequestWrapper("/Server/SendPushNotificationFromTemplate", request, "X-SecretKey", extraHeaders);
1834
+ }
1835
+ /**
1836
+ * Updates the tag list for a specified user in the friend list of another user
1837
+ *
1838
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags Microsoft Documentation}
1839
+ * @example
1840
+ * await serverClient.SetFriendTags({
1841
+ * "PlayFabId": "ABCDEF123456",
1842
+ * "FriendPlayFabId": "298ABC37799",
1843
+ * "Tags": [
1844
+ * "sniper",
1845
+ * "melee"
1846
+ * ]
1847
+ * });
1848
+ */
1849
+ SetFriendTags(request, extraHeaders) {
1850
+ return this.ExecuteRequestWrapper("/Server/SetFriendTags", request, "X-SecretKey", extraHeaders);
1851
+ }
1852
+ /**
1853
+ * Sets the custom data of the indicated Game Server Instance
1854
+ *
1855
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancedata Microsoft Documentation}
1856
+ * @deprecated Do not use
1857
+ */
1858
+ SetGameServerInstanceData(request, extraHeaders) {
1859
+ return this.ExecuteRequestWrapper("/Server/SetGameServerInstanceData", request, "X-SecretKey", extraHeaders);
1860
+ }
1861
+ /**
1862
+ * Set the state of the indicated Game Server Instance.
1863
+ *
1864
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancestate Microsoft Documentation}
1865
+ * @deprecated Do not use
1866
+ */
1867
+ SetGameServerInstanceState(request, extraHeaders) {
1868
+ return this.ExecuteRequestWrapper("/Server/SetGameServerInstanceState", request, "X-SecretKey", extraHeaders);
1869
+ }
1870
+ /**
1871
+ * Set custom tags for the specified Game Server Instance
1872
+ *
1873
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancetags Microsoft Documentation}
1874
+ * @deprecated Do not use
1875
+ */
1876
+ SetGameServerInstanceTags(request, extraHeaders) {
1877
+ return this.ExecuteRequestWrapper("/Server/SetGameServerInstanceTags", request, "X-SecretKey", extraHeaders);
1878
+ }
1879
+ /**
1880
+ * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
1881
+ * secret use the Admin or Server API method SetPlayerSecret.
1882
+ *
1883
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret Microsoft Documentation}
1884
+ * @example
1885
+ * await serverClient.SetPlayerSecret({
1886
+ * "PlayerSecret": "ExampleSecret",
1887
+ * "PlayFabId": "ABCD1234"
1888
+ * });
1889
+ */
1890
+ SetPlayerSecret(request, extraHeaders) {
1891
+ return this.ExecuteRequestWrapper("/Server/SetPlayerSecret", request, "X-SecretKey", extraHeaders);
1892
+ }
1893
+ /**
1894
+ * Updates the key-value store of custom publisher settings
1895
+ *
1896
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata Microsoft Documentation}
1897
+ * @example
1898
+ * await serverClient.SetPublisherData({
1899
+ * "Key": "Running Speed",
1900
+ * "Value": "1.03"
1901
+ * });
1902
+ */
1903
+ SetPublisherData(request, extraHeaders) {
1904
+ return this.ExecuteRequestWrapper("/Server/SetPublisherData", request, "X-SecretKey", extraHeaders);
1905
+ }
1906
+ /**
1907
+ * Updates the key-value store of custom title settings
1908
+ *
1909
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata Microsoft Documentation}
1910
+ * @example
1911
+ * await serverClient.SetTitleData({
1912
+ * "Key": "Running Speed",
1913
+ * "Value": "1.03"
1914
+ * });
1915
+ */
1916
+ SetTitleData(request, extraHeaders) {
1917
+ return this.ExecuteRequestWrapper("/Server/SetTitleData", request, "X-SecretKey", extraHeaders);
1918
+ }
1919
+ /**
1920
+ * Updates the key-value store of custom title settings
1921
+ *
1922
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata Microsoft Documentation}
1923
+ * @example
1924
+ * await serverClient.SetTitleInternalData({
1925
+ * "Key": "Running Speed",
1926
+ * "Value": "1.03"
1927
+ * });
1928
+ */
1929
+ SetTitleInternalData(request, extraHeaders) {
1930
+ return this.ExecuteRequestWrapper("/Server/SetTitleInternalData", request, "X-SecretKey", extraHeaders);
1931
+ }
1932
+ /**
1933
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1934
+ * version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to
1935
+ * make a VC balance negative with this API.
1936
+ *
1937
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency Microsoft Documentation}
1938
+ * @example
1939
+ * await serverClient.SubtractCharacterVirtualCurrency({
1940
+ * "PlayFabId": "20394883",
1941
+ * "CharacterId": "23424524523",
1942
+ * "VirtualCurrency": "GC",
1943
+ * "Amount": 100
1944
+ * });
1945
+ */
1946
+ SubtractCharacterVirtualCurrency(request, extraHeaders) {
1947
+ return this.ExecuteRequestWrapper("/Server/SubtractCharacterVirtualCurrency", request, "X-SecretKey", extraHeaders);
1948
+ }
1949
+ /**
1950
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1951
+ * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
1952
+ * a VC balance negative with this API.
1953
+ *
1954
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
1955
+ * @example
1956
+ * await serverClient.SubtractUserVirtualCurrency({
1957
+ * "PlayFabId": "20394883",
1958
+ * "VirtualCurrency": "GC",
1959
+ * "Amount": 100
1960
+ * });
1961
+ */
1962
+ SubtractUserVirtualCurrency(request, extraHeaders) {
1963
+ return this.ExecuteRequestWrapper("/Server/SubtractUserVirtualCurrency", request, "X-SecretKey", extraHeaders);
1964
+ }
1965
+ /**
1966
+ * Unlinks the related Battle.net account from the user's PlayFab account.
1967
+ *
1968
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount Microsoft Documentation}
1969
+ * @example
1970
+ * await serverClient.UnlinkBattleNetAccount({
1971
+ * "PlayFabId": "1234FA342"
1972
+ * });
1973
+ */
1974
+ UnlinkBattleNetAccount(request, extraHeaders) {
1975
+ return this.ExecuteRequestWrapper("/Server/UnlinkBattleNetAccount", request, "X-SecretKey", extraHeaders);
1976
+ }
1977
+ /**
1978
+ * Unlinks the related Nintendo account from the user's PlayFab account
1979
+ *
1980
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount Microsoft Documentation}
1981
+ * @example
1982
+ * await serverClient.UnlinkNintendoServiceAccount({
1983
+ * "PlayFabId": "1234FA342"
1984
+ * });
1985
+ */
1986
+ UnlinkNintendoServiceAccount(request, extraHeaders) {
1987
+ return this.ExecuteRequestWrapper("/Server/UnlinkNintendoServiceAccount", request, "X-SecretKey", extraHeaders);
1988
+ }
1989
+ /**
1990
+ * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
1991
+ *
1992
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid Microsoft Documentation}
1993
+ * @example
1994
+ * await serverClient.UnlinkNintendoSwitchDeviceId({
1995
+ * "PlayFabId": "1234FA342",
1996
+ * "NintendoSwitchDeviceId": "526f79204261747479"
1997
+ * });
1998
+ */
1999
+ UnlinkNintendoSwitchDeviceId(request, extraHeaders) {
2000
+ return this.ExecuteRequestWrapper("/Server/UnlinkNintendoSwitchDeviceId", request, "X-SecretKey", extraHeaders);
2001
+ }
2002
+ /**
2003
+ * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
2004
+ *
2005
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount Microsoft Documentation}
2006
+ * @example
2007
+ * await serverClient.UnlinkPSNAccount({
2008
+ * "PlayFabId": "1234FA342"
2009
+ * });
2010
+ */
2011
+ UnlinkPSNAccount(request, extraHeaders) {
2012
+ return this.ExecuteRequestWrapper("/Server/UnlinkPSNAccount", request, "X-SecretKey", extraHeaders);
2013
+ }
2014
+ /**
2015
+ * Unlinks the custom server identifier from the user's PlayFab account.
2016
+ *
2017
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid Microsoft Documentation}
2018
+ * @example
2019
+ * await serverClient.UnlinkServerCustomId({
2020
+ * "PlayFabId": "123412341234",
2021
+ * "ServerCustomId": "67AB-5397-CC54-EA31"
2022
+ * });
2023
+ */
2024
+ UnlinkServerCustomId(request, extraHeaders) {
2025
+ return this.ExecuteRequestWrapper("/Server/UnlinkServerCustomId", request, "X-SecretKey", extraHeaders);
2026
+ }
2027
+ /**
2028
+ * Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account
2029
+ *
2030
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid Microsoft Documentation}
2031
+ * @example
2032
+ * await serverClient.UnlinkSteamId({
2033
+ * "PlayFabId": "5a446c83645201"
2034
+ * });
2035
+ */
2036
+ UnlinkSteamId(request, extraHeaders) {
2037
+ return this.ExecuteRequestWrapper("/Server/UnlinkSteamId", request, "X-SecretKey", extraHeaders);
2038
+ }
2039
+ /**
2040
+ * Unlinks the related Xbox Live account from the user's PlayFab account
2041
+ *
2042
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount Microsoft Documentation}
2043
+ * @example
2044
+ * await serverClient.UnlinkXboxAccount({
2045
+ * "PlayFabId": "5a446c83645201"
2046
+ * });
2047
+ */
2048
+ UnlinkXboxAccount(request, extraHeaders) {
2049
+ return this.ExecuteRequestWrapper("/Server/UnlinkXboxAccount", request, "X-SecretKey", extraHeaders);
2050
+ }
2051
+ /**
2052
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2053
+ * version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when
2054
+ * required), and returns the contents of the opened container. If the container (and key when relevant) are consumable
2055
+ * (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
2056
+ *
2057
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance Microsoft Documentation}
2058
+ * @example
2059
+ * await serverClient.UnlockContainerInstance({
2060
+ * "PlayFabId": "20394883",
2061
+ * "ContainerItemInstanceId": "123456788",
2062
+ * "KeyItemInstanceId": "123456789"
2063
+ * });
2064
+ */
2065
+ UnlockContainerInstance(request, extraHeaders) {
2066
+ return this.ExecuteRequestWrapper("/Server/UnlockContainerInstance", request, "X-SecretKey", extraHeaders);
2067
+ }
2068
+ /**
2069
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2070
+ * version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary
2071
+ * unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when
2072
+ * relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of
2073
+ * ConsumeItem.
2074
+ *
2075
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem Microsoft Documentation}
2076
+ * @example
2077
+ * await serverClient.UnlockContainerItem({
2078
+ * "PlayFabId": "20394883",
2079
+ * "ContainerItemId": "crate block 1"
2080
+ * });
2081
+ */
2082
+ UnlockContainerItem(request, extraHeaders) {
2083
+ return this.ExecuteRequestWrapper("/Server/UnlockContainerItem", request, "X-SecretKey", extraHeaders);
2084
+ }
2085
+ /**
2086
+ * Update the avatar URL of the specified player
2087
+ *
2088
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl Microsoft Documentation}
2089
+ * @example
2090
+ * await serverClient.UpdateAvatarUrl({
2091
+ * "PlayFabId": "22ca65837b158fab",
2092
+ * "ImageUrl": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
2093
+ * });
2094
+ */
2095
+ UpdateAvatarUrl(request, extraHeaders) {
2096
+ return this.ExecuteRequestWrapper("/Server/UpdateAvatarUrl", request, "X-SecretKey", extraHeaders);
2097
+ }
2098
+ /**
2099
+ * Updates information of a list of existing bans specified with Ban Ids.
2100
+ *
2101
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans Microsoft Documentation}
2102
+ * @example
2103
+ * await serverClient.UpdateBans({
2104
+ * "Bans": [
2105
+ * {
2106
+ * "BanId": "E0B5FF89542D413C",
2107
+ * "Permanent": true,
2108
+ * "Active": true
2109
+ * },
2110
+ * {
2111
+ * "BanId": "EF43FF89542G1546",
2112
+ * "Reason": "Royal pardon",
2113
+ * "Expires": "2016-07-04T00:00:00Z"
2114
+ * }
2115
+ * ]
2116
+ * });
2117
+ */
2118
+ UpdateBans(request, extraHeaders) {
2119
+ return this.ExecuteRequestWrapper("/Server/UpdateBans", request, "X-SecretKey", extraHeaders);
2120
+ }
2121
+ /**
2122
+ * Updates the title-specific custom data for the user's character which is readable and writable by the client
2123
+ *
2124
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata Microsoft Documentation}
2125
+ * @example
2126
+ * await serverClient.UpdateCharacterData({
2127
+ * "PlayFabId": "2039475",
2128
+ * "CharacterId": "98342357",
2129
+ * "Data": {
2130
+ * "Class": "Fighter",
2131
+ * "Gender": "Female",
2132
+ * "Icon": "Guard 3",
2133
+ * "Theme": "Colorful"
2134
+ * },
2135
+ * "Permission": "Public"
2136
+ * });
2137
+ */
2138
+ UpdateCharacterData(request, extraHeaders) {
2139
+ return this.ExecuteRequestWrapper("/Server/UpdateCharacterData", request, "X-SecretKey", extraHeaders);
2140
+ }
2141
+ /**
2142
+ * Updates the title-specific custom data for the user's character which cannot be accessed by the client
2143
+ *
2144
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata Microsoft Documentation}
2145
+ * @example
2146
+ * await serverClient.UpdateCharacterInternalData({
2147
+ * "PlayFabId": "2039475",
2148
+ * "CharacterId": "98342357",
2149
+ * "Data": {
2150
+ * "Class": "Fighter",
2151
+ * "Gender": "Female",
2152
+ * "Icon": "Guard 3",
2153
+ * "Theme": "Colorful"
2154
+ * },
2155
+ * "Permission": "Public"
2156
+ * });
2157
+ */
2158
+ UpdateCharacterInternalData(request, extraHeaders) {
2159
+ return this.ExecuteRequestWrapper("/Server/UpdateCharacterInternalData", request, "X-SecretKey", extraHeaders);
2160
+ }
2161
+ /**
2162
+ * Updates the title-specific custom data for the user's character which can only be read by the client
2163
+ *
2164
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata Microsoft Documentation}
2165
+ * @example
2166
+ * await serverClient.UpdateCharacterReadOnlyData({
2167
+ * "PlayFabId": "2039475",
2168
+ * "CharacterId": "98342357",
2169
+ * "Data": {
2170
+ * "Class": "Fighter",
2171
+ * "Gender": "Female",
2172
+ * "Icon": "Guard 3",
2173
+ * "Theme": "Colorful"
2174
+ * },
2175
+ * "Permission": "Public"
2176
+ * });
2177
+ */
2178
+ UpdateCharacterReadOnlyData(request, extraHeaders) {
2179
+ return this.ExecuteRequestWrapper("/Server/UpdateCharacterReadOnlyData", request, "X-SecretKey", extraHeaders);
2180
+ }
2181
+ /**
2182
+ * Updates the values of the specified title-specific statistics for the specific character
2183
+ *
2184
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics Microsoft Documentation}
2185
+ * @example
2186
+ * await serverClient.UpdateCharacterStatistics({
2187
+ * "PlayFabId": "10931252888739651331",
2188
+ * "CharacterId": "98765432",
2189
+ * "CharacterStatistics": {
2190
+ * "Headshots": 18,
2191
+ * "Kills": 47
2192
+ * }
2193
+ * });
2194
+ */
2195
+ UpdateCharacterStatistics(request, extraHeaders) {
2196
+ return this.ExecuteRequestWrapper("/Server/UpdateCharacterStatistics", request, "X-SecretKey", extraHeaders);
2197
+ }
2198
+ /**
2199
+ * Updates the title-specific custom property values for a player
2200
+ *
2201
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties Microsoft Documentation}
2202
+ * @example
2203
+ * await serverClient.UpdatePlayerCustomProperties({
2204
+ * "PlayFabId": "2039475",
2205
+ * "Properties": [
2206
+ * {
2207
+ * "Name": "level",
2208
+ * "Value": 5
2209
+ * },
2210
+ * {
2211
+ * "Name": "created",
2212
+ * "Value": false
2213
+ * }
2214
+ * ],
2215
+ * "ExpectedPropertiesVersion": 12
2216
+ * });
2217
+ */
2218
+ UpdatePlayerCustomProperties(request, extraHeaders) {
2219
+ return this.ExecuteRequestWrapper("/Server/UpdatePlayerCustomProperties", request, "X-SecretKey", extraHeaders);
2220
+ }
2221
+ /**
2222
+ * Updates the values of the specified title-specific statistics for the user
2223
+ *
2224
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics Microsoft Documentation}
2225
+ * @example
2226
+ * await serverClient.UpdatePlayerStatistics({
2227
+ * "PlayFabId": "10931252888739651331",
2228
+ * "Statistics": [
2229
+ * {
2230
+ * "StatisticName": "Points",
2231
+ * "Version": 1,
2232
+ * "Value": 600
2233
+ * },
2234
+ * {
2235
+ * "StatisticName": "Wins",
2236
+ * "Version": 2,
2237
+ * "Value": 16
2238
+ * },
2239
+ * {
2240
+ * "StatisticName": "Stars",
2241
+ * "Value": 7
2242
+ * }
2243
+ * ]
2244
+ * });
2245
+ */
2246
+ UpdatePlayerStatistics(request, extraHeaders) {
2247
+ return this.ExecuteRequestWrapper("/Server/UpdatePlayerStatistics", request, "X-SecretKey", extraHeaders);
2248
+ }
2249
+ /**
2250
+ * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
2251
+ * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
2252
+ * Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are
2253
+ * designed for sharing data between a very small number of players, please see our guide:
2254
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
2255
+ *
2256
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata Microsoft Documentation}
2257
+ * @example
2258
+ * await serverClient.UpdateSharedGroupData({
2259
+ * "SharedGroupId": "Clan Data",
2260
+ * "Data": {
2261
+ * "ClanKills": "34",
2262
+ * "LastClanUpdate": "2014-10-03T09:21:14Z"
2263
+ * },
2264
+ * "Permission": "Public"
2265
+ * });
2266
+ */
2267
+ UpdateSharedGroupData(request, extraHeaders) {
2268
+ return this.ExecuteRequestWrapper("/Server/UpdateSharedGroupData", request, "X-SecretKey", extraHeaders);
2269
+ }
2270
+ /**
2271
+ * Updates the title-specific custom data for the user which is readable and writable by the client
2272
+ *
2273
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata Microsoft Documentation}
2274
+ * @example
2275
+ * await serverClient.UpdateUserData({
2276
+ * "PlayFabId": "2039475",
2277
+ * "Data": {
2278
+ * "Class": "Fighter",
2279
+ * "Gender": "Female",
2280
+ * "Icon": "Guard 3",
2281
+ * "Theme": "Colorful"
2282
+ * },
2283
+ * "Permission": "Public"
2284
+ * });
2285
+ */
2286
+ UpdateUserData(request, extraHeaders) {
2287
+ return this.ExecuteRequestWrapper("/Server/UpdateUserData", request, "X-SecretKey", extraHeaders);
2288
+ }
2289
+ /**
2290
+ * Updates the title-specific custom data for the user which cannot be accessed by the client
2291
+ *
2292
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata Microsoft Documentation}
2293
+ * @example
2294
+ * await serverClient.UpdateUserInternalData({
2295
+ * "PlayFabId": "2039475",
2296
+ * "Data": {
2297
+ * "Class": "Fighter",
2298
+ * "Gender": "Female",
2299
+ * "Icon": "Guard 3",
2300
+ * "Theme": "Colorful"
2301
+ * }
2302
+ * });
2303
+ */
2304
+ UpdateUserInternalData(request, extraHeaders) {
2305
+ return this.ExecuteRequestWrapper("/Server/UpdateUserInternalData", request, "X-SecretKey", extraHeaders);
2306
+ }
2307
+ /**
2308
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2309
+ * version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.
2310
+ *
2311
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata Microsoft Documentation}
2312
+ * @example
2313
+ * await serverClient.UpdateUserInventoryItemCustomData({
2314
+ * "PlayFabId": "204883457",
2315
+ * "CharacterId": "9890723423",
2316
+ * "ItemInstanceId": "88331144",
2317
+ * "Data": {
2318
+ * "Equipped": "True",
2319
+ * "Slot": "Head"
2320
+ * }
2321
+ * });
2322
+ */
2323
+ UpdateUserInventoryItemCustomData(request, extraHeaders) {
2324
+ return this.ExecuteRequestWrapper("/Server/UpdateUserInventoryItemCustomData", request, "X-SecretKey", extraHeaders);
2325
+ }
2326
+ /**
2327
+ * Updates the publisher-specific custom data for the user which is readable and writable by the client
2328
+ *
2329
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata Microsoft Documentation}
2330
+ * @example
2331
+ * await serverClient.UpdateUserPublisherData({
2332
+ * "PlayFabId": "2039475",
2333
+ * "Data": {
2334
+ * "Class": "Fighter",
2335
+ * "Gender": "Female",
2336
+ * "Icon": "Guard 3",
2337
+ * "Theme": "Colorful"
2338
+ * },
2339
+ * "Permission": "Public"
2340
+ * });
2341
+ */
2342
+ UpdateUserPublisherData(request, extraHeaders) {
2343
+ return this.ExecuteRequestWrapper("/Server/UpdateUserPublisherData", request, "X-SecretKey", extraHeaders);
2344
+ }
2345
+ /**
2346
+ * Updates the publisher-specific custom data for the user which cannot be accessed by the client
2347
+ *
2348
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata Microsoft Documentation}
2349
+ * @example
2350
+ * await serverClient.UpdateUserPublisherInternalData({
2351
+ * "PlayFabId": "2039475",
2352
+ * "Data": {
2353
+ * "Class": "Fighter",
2354
+ * "Gender": "Female",
2355
+ * "Icon": "Guard 3",
2356
+ * "Theme": "Colorful"
2357
+ * }
2358
+ * });
2359
+ */
2360
+ UpdateUserPublisherInternalData(request, extraHeaders) {
2361
+ return this.ExecuteRequestWrapper("/Server/UpdateUserPublisherInternalData", request, "X-SecretKey", extraHeaders);
2362
+ }
2363
+ /**
2364
+ * Updates the publisher-specific custom data for the user which can only be read by the client
2365
+ *
2366
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata Microsoft Documentation}
2367
+ * @example
2368
+ * await serverClient.UpdateUserPublisherReadOnlyData({
2369
+ * "PlayFabId": "2039475",
2370
+ * "Data": {
2371
+ * "Class": "Fighter",
2372
+ * "Gender": "Female",
2373
+ * "Icon": "Guard 3",
2374
+ * "Theme": "Colorful"
2375
+ * },
2376
+ * "Permission": "Public"
2377
+ * });
2378
+ */
2379
+ UpdateUserPublisherReadOnlyData(request, extraHeaders) {
2380
+ return this.ExecuteRequestWrapper("/Server/UpdateUserPublisherReadOnlyData", request, "X-SecretKey", extraHeaders);
2381
+ }
2382
+ /**
2383
+ * Updates the title-specific custom data for the user which can only be read by the client
2384
+ *
2385
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata Microsoft Documentation}
2386
+ * @example
2387
+ * await serverClient.UpdateUserReadOnlyData({
2388
+ * "PlayFabId": "2039475",
2389
+ * "Data": {
2390
+ * "Class": "Fighter",
2391
+ * "Gender": "Female",
2392
+ * "Icon": "Guard 3",
2393
+ * "Theme": "Colorful"
2394
+ * },
2395
+ * "Permission": "Public"
2396
+ * });
2397
+ */
2398
+ UpdateUserReadOnlyData(request, extraHeaders) {
2399
+ return this.ExecuteRequestWrapper("/Server/UpdateUserReadOnlyData", request, "X-SecretKey", extraHeaders);
2400
+ }
2401
+ /**
2402
+ * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
2403
+ * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
2404
+ *
2405
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserstatistics Microsoft Documentation}
2406
+ * @deprecated Please use UpdatePlayerStatistics instead.
2407
+ */
2408
+ UpdateUserStatistics(request, extraHeaders) {
2409
+ return this.ExecuteRequestWrapper("/Server/UpdateUserStatistics", request, "X-SecretKey", extraHeaders);
2410
+ }
2411
+ /**
2412
+ * Writes a character-based event into PlayStream.
2413
+ *
2414
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent Microsoft Documentation}
2415
+ * @example
2416
+ * await serverClient.WriteCharacterEvent({
2417
+ * "PlayFabId": "3947655299CB786",
2418
+ * "CharacterId": "E161CB4B7F6C34B",
2419
+ * "EventName": "character_defeated_enemy",
2420
+ * "Timestamp": "2016-03-07T00:00:00Z",
2421
+ * "Body": {
2422
+ * "Enemy": "guardian",
2423
+ * "Damage": 5,
2424
+ * "Coordinates": {
2425
+ * "X": 123.4,
2426
+ * "Y": 543.2
2427
+ * }
2428
+ * }
2429
+ * });
2430
+ */
2431
+ WriteCharacterEvent(request, extraHeaders) {
2432
+ return this.ExecuteRequestWrapper("/Server/WriteCharacterEvent", request, "X-SecretKey", extraHeaders);
2433
+ }
2434
+ /**
2435
+ * Writes a player-based event into PlayStream.
2436
+ *
2437
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent Microsoft Documentation}
2438
+ * @example
2439
+ * await serverClient.WritePlayerEvent({
2440
+ * "PlayFabId": "3947655299CB786",
2441
+ * "EventName": "player_defeated_enemy",
2442
+ * "Timestamp": "2016-03-07T00:00:00Z",
2443
+ * "Body": {
2444
+ * "Enemy": "guardian",
2445
+ * "Damage": 5,
2446
+ * "Coordinates": {
2447
+ * "X": 123.4,
2448
+ * "Y": 543.2
2449
+ * }
2450
+ * }
2451
+ * });
2452
+ */
2453
+ WritePlayerEvent(request, extraHeaders) {
2454
+ return this.ExecuteRequestWrapper("/Server/WritePlayerEvent", request, "X-SecretKey", extraHeaders);
2455
+ }
2456
+ /**
2457
+ * Writes a title-based event into PlayStream.
2458
+ *
2459
+ * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent Microsoft Documentation}
2460
+ * @example
2461
+ * await serverClient.WriteTitleEvent({
2462
+ * "EventName": "client_update_submitted",
2463
+ * "Timestamp": "2016-03-07T00:00:00Z",
2464
+ * "Body": {
2465
+ * "Version": "1.4.50"
2466
+ * }
2467
+ * });
2468
+ */
2469
+ WriteTitleEvent(request, extraHeaders) {
2470
+ return this.ExecuteRequestWrapper("/Server/WriteTitleEvent", request, "X-SecretKey", extraHeaders);
2471
+ }
2472
+ };
2473
+
2474
+ export {
2475
+ PlayFabServerApi
2476
+ };
2477
+ //# sourceMappingURL=chunk-3O5QT4SL.js.map