async-playfab-web-sdk 1.192.250526 → 1.193.250606

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 (126) hide show
  1. package/dist/{Addon.d.mts → Addon.d.ts} +213 -73
  2. package/dist/Addon.js +8 -0
  3. package/dist/Addon.js.map +1 -1
  4. package/dist/{Admin.d.mts → Admin.d.ts} +2547 -356
  5. package/dist/Admin.js +8 -0
  6. package/dist/Admin.js.map +1 -1
  7. package/dist/{Authentication.d.mts → Authentication.d.ts} +36 -9
  8. package/dist/Authentication.js +8 -0
  9. package/dist/Authentication.js.map +1 -1
  10. package/dist/{Client.d.mts → Client.d.ts} +2473 -557
  11. package/dist/Client.js +8 -0
  12. package/dist/Client.js.map +1 -1
  13. package/dist/{CloudScript.d.mts → CloudScript.d.ts} +214 -46
  14. package/dist/CloudScript.js +8 -0
  15. package/dist/CloudScript.js.map +1 -1
  16. package/dist/{Data.d.mts → Data.d.ts} +144 -25
  17. package/dist/Data.js +8 -0
  18. package/dist/Data.js.map +1 -1
  19. package/dist/{Economy.d.mts → Economy.d.ts} +1218 -173
  20. package/dist/Economy.js +8 -0
  21. package/dist/Economy.js.map +1 -1
  22. package/dist/{Events.d.mts → Events.d.ts} +212 -25
  23. package/dist/Events.js +8 -0
  24. package/dist/Events.js.map +1 -1
  25. package/dist/{Experimentation.d.mts → Experimentation.d.ts} +177 -30
  26. package/dist/Experimentation.js +8 -0
  27. package/dist/Experimentation.js.map +1 -1
  28. package/dist/{Groups.d.mts → Groups.d.ts} +306 -67
  29. package/dist/Groups.js +8 -0
  30. package/dist/Groups.js.map +1 -1
  31. package/dist/{Insights.d.mts → Insights.d.ts} +39 -13
  32. package/dist/Insights.js +8 -0
  33. package/dist/Insights.js.map +1 -1
  34. package/dist/{Localization.d.mts → Localization.d.ts} +6 -3
  35. package/dist/Localization.js +8 -0
  36. package/dist/Localization.js.map +1 -1
  37. package/dist/Matchmaker.d.ts +271 -0
  38. package/dist/Matchmaker.js +8 -0
  39. package/dist/Matchmaker.js.map +1 -0
  40. package/dist/{Multiplayer.d.mts → Multiplayer.d.ts} +2829 -301
  41. package/dist/Multiplayer.js +8 -0
  42. package/dist/Multiplayer.js.map +1 -1
  43. package/dist/{PlayFabCommon-BUv4zqXf.d.mts → PlayFabCommon-Dnp_xHg5.d.ts} +6 -10
  44. package/dist/{Profiles.d.mts → Profiles.d.ts} +172 -28
  45. package/dist/Profiles.js +8 -0
  46. package/dist/Profiles.js.map +1 -1
  47. package/dist/{Progression.d.mts → Progression.d.ts} +337 -73
  48. package/dist/Progression.js +8 -0
  49. package/dist/Progression.js.map +1 -1
  50. package/dist/{Server.d.mts → Server.d.ts} +2120 -458
  51. package/dist/Server.js +8 -0
  52. package/dist/Server.js.map +1 -1
  53. package/dist/chunk-5LPKBU65.js +2970 -0
  54. package/dist/chunk-5LPKBU65.js.map +1 -0
  55. package/dist/chunk-ABEEDFKP.js +175 -0
  56. package/dist/chunk-ABEEDFKP.js.map +1 -0
  57. package/dist/chunk-AGNOI6QW.js +2477 -0
  58. package/dist/chunk-AGNOI6QW.js.map +1 -0
  59. package/dist/chunk-B4NQUOWG.js +1048 -0
  60. package/dist/chunk-B4NQUOWG.js.map +1 -0
  61. package/dist/chunk-GERGPHQM.js +76 -0
  62. package/dist/chunk-GERGPHQM.js.map +1 -0
  63. package/dist/chunk-GOZV2MOC.js +2673 -0
  64. package/dist/chunk-GOZV2MOC.js.map +1 -0
  65. package/dist/chunk-GXP64DCJ.js +82 -0
  66. package/dist/chunk-GXP64DCJ.js.map +1 -0
  67. package/dist/chunk-HUS6GF7X.js +270 -0
  68. package/dist/chunk-HUS6GF7X.js.map +1 -0
  69. package/dist/chunk-JIEFHAFU.js +197 -0
  70. package/dist/chunk-JIEFHAFU.js.map +1 -0
  71. package/dist/chunk-LCCANUCE.js +2387 -0
  72. package/dist/chunk-LCCANUCE.js.map +1 -0
  73. package/dist/chunk-MNQCGRC6.js +357 -0
  74. package/dist/chunk-MNQCGRC6.js.map +1 -0
  75. package/dist/chunk-N4R6Y2MM.js +225 -0
  76. package/dist/chunk-N4R6Y2MM.js.map +1 -0
  77. package/dist/{Localization.mjs → chunk-N7LC7KNB.js} +43 -94
  78. package/dist/chunk-N7LC7KNB.js.map +1 -0
  79. package/dist/chunk-NPTN4F4Z.js +22 -0
  80. package/dist/chunk-NPTN4F4Z.js.map +1 -0
  81. package/dist/chunk-QHGWL3NW.js +237 -0
  82. package/dist/chunk-QHGWL3NW.js.map +1 -0
  83. package/dist/chunk-RKXM4KV5.js +421 -0
  84. package/dist/chunk-RKXM4KV5.js.map +1 -0
  85. package/dist/chunk-UDM2ZVXN.js +421 -0
  86. package/dist/chunk-UDM2ZVXN.js.map +1 -0
  87. package/dist/chunk-ZEBSOOZG.js +82 -0
  88. package/dist/chunk-ZEBSOOZG.js.map +1 -0
  89. package/dist/index.d.ts +18 -0
  90. package/dist/index.js +72 -0
  91. package/dist/index.js.map +1 -1
  92. package/package.json +2 -1
  93. package/dist/Addon.mjs +0 -452
  94. package/dist/Addon.mjs.map +0 -1
  95. package/dist/Admin.mjs +0 -1112
  96. package/dist/Admin.mjs.map +0 -1
  97. package/dist/Authentication.mjs +0 -290
  98. package/dist/Authentication.mjs.map +0 -1
  99. package/dist/Client.mjs +0 -1893
  100. package/dist/Client.mjs.map +0 -1
  101. package/dist/CloudScript.mjs +0 -349
  102. package/dist/CloudScript.mjs.map +0 -1
  103. package/dist/Data.mjs +0 -291
  104. package/dist/Data.mjs.map +0 -1
  105. package/dist/Economy.mjs +0 -614
  106. package/dist/Economy.mjs.map +0 -1
  107. package/dist/Events.mjs +0 -327
  108. package/dist/Events.mjs.map +0 -1
  109. package/dist/Experimentation.mjs +0 -333
  110. package/dist/Experimentation.mjs.map +0 -1
  111. package/dist/Groups.mjs +0 -417
  112. package/dist/Groups.mjs.map +0 -1
  113. package/dist/Insights.mjs +0 -286
  114. package/dist/Insights.mjs.map +0 -1
  115. package/dist/Localization.mjs.map +0 -1
  116. package/dist/Multiplayer.mjs +0 -862
  117. package/dist/Multiplayer.mjs.map +0 -1
  118. package/dist/Profiles.mjs +0 -306
  119. package/dist/Profiles.mjs.map +0 -1
  120. package/dist/Progression.mjs +0 -404
  121. package/dist/Progression.mjs.map +0 -1
  122. package/dist/Server.mjs +0 -1377
  123. package/dist/Server.mjs.map +0 -1
  124. package/dist/index.d.mts +0 -17
  125. package/dist/index.mjs +0 -6007
  126. package/dist/index.mjs.map +0 -1
@@ -0,0 +1,2970 @@
1
+ import {
2
+ PlayFabCommon
3
+ } from "./chunk-N7LC7KNB.js";
4
+
5
+ // src/apis/PlayFabClientApi.ts
6
+ var PlayFabClientApi = class extends PlayFabCommon {
7
+ IsClientLoggedIn() {
8
+ return this.sessionTicket != null && this.sessionTicket.length > 0;
9
+ }
10
+ /**
11
+ * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
12
+ * allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
13
+ * items will be swapped between the two players' inventories.
14
+ *
15
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade Microsoft Documentation}
16
+ * @example
17
+ * await clientClient.AcceptTrade({
18
+ * "OfferingPlayerId": "CD803BF233CE76CC",
19
+ * "TradeId": "D819CEC225EA9948C351",
20
+ * "AcceptedInventoryInstanceIds": [
21
+ * "95C1797ADDAC24DC0383",
22
+ * "0F7793DF55CCEAF21B84"
23
+ * ]
24
+ * });
25
+ */
26
+ AcceptTrade(request, extraHeaders) {
27
+ return this.ExecuteRequestWrapper("/Client/AcceptTrade", request, "X-Authorization", extraHeaders);
28
+ }
29
+ /**
30
+ * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
31
+ * least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
32
+ *
33
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend Microsoft Documentation}
34
+ * @example
35
+ * await clientClient.AddFriend({
36
+ * "FriendPlayFabId": "29837799"
37
+ * });
38
+ */
39
+ AddFriend(request, extraHeaders) {
40
+ return this.ExecuteRequestWrapper("/Client/AddFriend", request, "X-Authorization", extraHeaders);
41
+ }
42
+ /**
43
+ * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
44
+ * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
45
+ * authentication credentials, as the intent is that it is easily accessible by other players.
46
+ *
47
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid Microsoft Documentation}
48
+ * @example
49
+ * await clientClient.AddGenericID({
50
+ * "GenericId": {
51
+ * "ServiceName": "BigBizSocial",
52
+ * "UserId": "1234567890"
53
+ * }
54
+ * });
55
+ */
56
+ AddGenericID(request, extraHeaders) {
57
+ return this.ExecuteRequestWrapper("/Client/AddGenericID", request, "X-Authorization", extraHeaders);
58
+ }
59
+ /**
60
+ * Adds or updates a contact email to the player's profile.
61
+ *
62
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail Microsoft Documentation}
63
+ * @example
64
+ * await clientClient.AddOrUpdateContactEmail({
65
+ * "EmailAddress": "theuser@domain.com"
66
+ * });
67
+ */
68
+ AddOrUpdateContactEmail(request, extraHeaders) {
69
+ return this.ExecuteRequestWrapper("/Client/AddOrUpdateContactEmail", request, "X-Authorization", extraHeaders);
70
+ }
71
+ /**
72
+ * 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
73
+ * in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
74
+ * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
75
+ *
76
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers Microsoft Documentation}
77
+ * @example
78
+ * await clientClient.AddSharedGroupMembers({
79
+ * "SharedGroupId": "Clan Data",
80
+ * "PlayFabIds": [
81
+ * "D984A64B832",
82
+ * "F74A523E1562"
83
+ * ]
84
+ * });
85
+ */
86
+ AddSharedGroupMembers(request, extraHeaders) {
87
+ return this.ExecuteRequestWrapper("/Client/AddSharedGroupMembers", request, "X-Authorization", extraHeaders);
88
+ }
89
+ /**
90
+ * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
91
+ * ID login.
92
+ *
93
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword Microsoft Documentation}
94
+ * @example
95
+ * await clientClient.AddUsernamePassword({
96
+ * "Username": "theuser",
97
+ * "Email": "me@here.com",
98
+ * "Password": "ExampleSecret"
99
+ * });
100
+ */
101
+ AddUsernamePassword(request, extraHeaders) {
102
+ return this.ExecuteRequestWrapper("/Client/AddUsernamePassword", request, "X-Authorization", extraHeaders);
103
+ }
104
+ /**
105
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
106
+ * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
107
+ *
108
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency Microsoft Documentation}
109
+ * @example
110
+ * await clientClient.AddUserVirtualCurrency({
111
+ * "VirtualCurrency": "GC",
112
+ * "Amount": 100
113
+ * });
114
+ */
115
+ AddUserVirtualCurrency(request, extraHeaders) {
116
+ return this.ExecuteRequestWrapper("/Client/AddUserVirtualCurrency", request, "X-Authorization", extraHeaders);
117
+ }
118
+ /**
119
+ * Registers the Android device to receive push notifications
120
+ *
121
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration Microsoft Documentation}
122
+ * @example
123
+ * await clientClient.AndroidDevicePushNotificationRegistration({
124
+ * "DeviceToken": "59872d98fa632brn8hg3770",
125
+ * "SendPushNotificationConfirmation": true,
126
+ * "ConfirmationMessage": "Welcome to PlayFab!"
127
+ * });
128
+ */
129
+ AndroidDevicePushNotificationRegistration(request, extraHeaders) {
130
+ return this.ExecuteRequestWrapper("/Client/AndroidDevicePushNotificationRegistration", request, "X-Authorization", extraHeaders);
131
+ }
132
+ /**
133
+ * Attributes an install for advertisment.
134
+ *
135
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall Microsoft Documentation}
136
+ * @example
137
+ * await clientClient.AttributeInstall({
138
+ * "Idfa": "11098810"
139
+ * });
140
+ */
141
+ AttributeInstall(request, extraHeaders) {
142
+ return this.ExecuteRequestWrapper("/Client/AttributeInstall", request, "X-Authorization", extraHeaders);
143
+ }
144
+ /**
145
+ * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
146
+ * can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
147
+ * players from accepting them, for trades that can be claimed by more than one player).
148
+ *
149
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade Microsoft Documentation}
150
+ * @example
151
+ * await clientClient.CancelTrade({
152
+ * "TradeId": "D819CEC225EA9948C351"
153
+ * });
154
+ */
155
+ CancelTrade(request, extraHeaders) {
156
+ return this.ExecuteRequestWrapper("/Client/CancelTrade", request, "X-Authorization", extraHeaders);
157
+ }
158
+ /**
159
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
160
+ * version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
161
+ * virtual currency balances as appropriate
162
+ *
163
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase Microsoft Documentation}
164
+ * @example
165
+ * await clientClient.ConfirmPurchase({
166
+ * "OrderId": "8853591446005860822"
167
+ * });
168
+ */
169
+ ConfirmPurchase(request, extraHeaders) {
170
+ return this.ExecuteRequestWrapper("/Client/ConfirmPurchase", request, "X-Authorization", extraHeaders);
171
+ }
172
+ /**
173
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
174
+ * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
175
+ * inventory.
176
+ *
177
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem Microsoft Documentation}
178
+ * @example
179
+ * await clientClient.ConsumeItem({
180
+ * "ItemInstanceId": "94585729",
181
+ * "ConsumeCount": 1
182
+ * });
183
+ */
184
+ ConsumeItem(request, extraHeaders) {
185
+ return this.ExecuteRequestWrapper("/Client/ConsumeItem", request, "X-Authorization", extraHeaders);
186
+ }
187
+ /**
188
+ * Grants the player's current entitlements from Microsoft Store's Collection API
189
+ *
190
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements Microsoft Documentation}
191
+ * @example
192
+ * await clientClient.ConsumeMicrosoftStoreEntitlements({
193
+ * "MarketplaceSpecificData": {
194
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
195
+ * "userId": "46239871",
196
+ * "collectionsMsIdKey": "MicrosoftStoreIdKey"
197
+ * },
198
+ * "CatalogVersion": "MainCatalog"
199
+ * });
200
+ */
201
+ ConsumeMicrosoftStoreEntitlements(request, extraHeaders) {
202
+ return this.ExecuteRequestWrapper("/Client/ConsumeMicrosoftStoreEntitlements", request, "X-Authorization", extraHeaders);
203
+ }
204
+ /**
205
+ * Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
206
+ * PlayFab items
207
+ *
208
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements Microsoft Documentation}
209
+ * @example
210
+ * await clientClient.ConsumePS5Entitlements({
211
+ * "MarketplaceSpecificData": {
212
+ * "ServiceLabel": "1"
213
+ * },
214
+ * "CatalogVersion": "MainCatalog"
215
+ * });
216
+ */
217
+ ConsumePS5Entitlements(request, extraHeaders) {
218
+ return this.ExecuteRequestWrapper("/Client/ConsumePS5Entitlements", request, "X-Authorization", extraHeaders);
219
+ }
220
+ /**
221
+ * Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
222
+ *
223
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements Microsoft Documentation}
224
+ * @example
225
+ * await clientClient.ConsumePSNEntitlements({
226
+ * "ServiceLabel": 1
227
+ * });
228
+ */
229
+ ConsumePSNEntitlements(request, extraHeaders) {
230
+ return this.ExecuteRequestWrapper("/Client/ConsumePSNEntitlements", request, "X-Authorization", extraHeaders);
231
+ }
232
+ /**
233
+ * Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
234
+ * player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
235
+ *
236
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements Microsoft Documentation}
237
+ * @example
238
+ * await clientClient.ConsumeXboxEntitlements({
239
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
240
+ * "CatalogVersion": "XboxItems"
241
+ * });
242
+ */
243
+ ConsumeXboxEntitlements(request, extraHeaders) {
244
+ return this.ExecuteRequestWrapper("/Client/ConsumeXboxEntitlements", request, "X-Authorization", extraHeaders);
245
+ }
246
+ /**
247
+ * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
248
+ * group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
249
+ * between a very small number of players, please see our guide:
250
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
251
+ *
252
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup Microsoft Documentation}
253
+ * @example
254
+ * await clientClient.CreateSharedGroup({
255
+ * "SharedGroupId": "Clan Data"
256
+ * });
257
+ */
258
+ CreateSharedGroup(request, extraHeaders) {
259
+ return this.ExecuteRequestWrapper("/Client/CreateSharedGroup", request, "X-Authorization", extraHeaders);
260
+ }
261
+ /**
262
+ * Deletes title-specific custom properties for a player
263
+ *
264
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties Microsoft Documentation}
265
+ * @example
266
+ * await clientClient.DeletePlayerCustomProperties({
267
+ * "PropertyNames": [
268
+ * "level",
269
+ * "created"
270
+ * ],
271
+ * "ExpectedPropertiesVersion": 12
272
+ * });
273
+ */
274
+ DeletePlayerCustomProperties(request, extraHeaders) {
275
+ return this.ExecuteRequestWrapper("/Client/DeletePlayerCustomProperties", request, "X-Authorization", extraHeaders);
276
+ }
277
+ /**
278
+ * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
279
+ * PlayFab ID is the entity ID of the player's master_player_account entity.
280
+ *
281
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript Microsoft Documentation}
282
+ * @example
283
+ * await clientClient.ExecuteCloudScript({
284
+ * "FunctionName": "levelCompleted",
285
+ * "FunctionParameter": {
286
+ * "level": 3,
287
+ * "points": 400
288
+ * },
289
+ * "RevisionSelection": "Live",
290
+ * "GeneratePlayStreamEvent": true
291
+ * });
292
+ */
293
+ ExecuteCloudScript(request, extraHeaders) {
294
+ return this.ExecuteRequestWrapper("/Client/ExecuteCloudScript", request, "X-Authorization", extraHeaders);
295
+ }
296
+ /**
297
+ * Retrieves the user's PlayFab account details
298
+ *
299
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo Microsoft Documentation}
300
+ * @example
301
+ * await clientClient.GetAccountInfo({
302
+ * "PlayFabId": "10931252888739651331"
303
+ * });
304
+ */
305
+ GetAccountInfo(request, extraHeaders) {
306
+ return this.ExecuteRequestWrapper("/Client/GetAccountInfo", request, "X-Authorization", extraHeaders);
307
+ }
308
+ /**
309
+ * Returns a list of ad placements and a reward for each
310
+ *
311
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements Microsoft Documentation}
312
+ * @example
313
+ * await clientClient.GetAdPlacements({
314
+ * "AppId": "A12784B",
315
+ * "Identifier": {
316
+ * "Name": "PowerBonusInterstitial"
317
+ * }
318
+ * });
319
+ */
320
+ GetAdPlacements(request, extraHeaders) {
321
+ return this.ExecuteRequestWrapper("/Client/GetAdPlacements", request, "X-Authorization", extraHeaders);
322
+ }
323
+ /**
324
+ * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
325
+ * evaluated with the parent PlayFabId to guarantee uniqueness.
326
+ *
327
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters Microsoft Documentation}
328
+ * @example
329
+ * await clientClient.GetAllUsersCharacters({
330
+ * "PlayFabId": "98333765432"
331
+ * });
332
+ */
333
+ GetAllUsersCharacters(request, extraHeaders) {
334
+ return this.ExecuteRequestWrapper("/Client/GetAllUsersCharacters", request, "X-Authorization", extraHeaders);
335
+ }
336
+ /**
337
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
338
+ * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
339
+ *
340
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems Microsoft Documentation}
341
+ * @example
342
+ * await clientClient.GetCatalogItems({
343
+ * "CatalogVersion": "1"
344
+ * });
345
+ */
346
+ GetCatalogItems(request, extraHeaders) {
347
+ return this.ExecuteRequestWrapper("/Client/GetCatalogItems", request, "X-Authorization", extraHeaders);
348
+ }
349
+ /**
350
+ * Retrieves the title-specific custom data for the character which is readable and writable by the client
351
+ *
352
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata Microsoft Documentation}
353
+ * @example
354
+ * await clientClient.GetCharacterData({
355
+ * "PlayFabId": "2039475",
356
+ * "CharacterId": "98342357",
357
+ * "Keys": [
358
+ * "preferences",
359
+ * "progress"
360
+ * ]
361
+ * });
362
+ */
363
+ GetCharacterData(request, extraHeaders) {
364
+ return this.ExecuteRequestWrapper("/Client/GetCharacterData", request, "X-Authorization", extraHeaders);
365
+ }
366
+ /**
367
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
368
+ * version 2._ Retrieves the specified character's current inventory of virtual goods
369
+ *
370
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory Microsoft Documentation}
371
+ * @example
372
+ * await clientClient.GetCharacterInventory({
373
+ * "CharacterId": "9890723423",
374
+ * "CatalogVersion": "5"
375
+ * });
376
+ */
377
+ GetCharacterInventory(request, extraHeaders) {
378
+ return this.ExecuteRequestWrapper("/Client/GetCharacterInventory", request, "X-Authorization", extraHeaders);
379
+ }
380
+ /**
381
+ * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
382
+ *
383
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard Microsoft Documentation}
384
+ * @example
385
+ * await clientClient.GetCharacterLeaderboard({
386
+ * "CharacterType": "blue_warrior",
387
+ * "StatisticName": "Kills",
388
+ * "StartPosition": 0,
389
+ * "MaxResultsCount": 20
390
+ * });
391
+ */
392
+ GetCharacterLeaderboard(request, extraHeaders) {
393
+ return this.ExecuteRequestWrapper("/Client/GetCharacterLeaderboard", request, "X-Authorization", extraHeaders);
394
+ }
395
+ /**
396
+ * Retrieves the title-specific custom data for the character which can only be read by the client
397
+ *
398
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata Microsoft Documentation}
399
+ * @example
400
+ * await clientClient.GetCharacterReadOnlyData({
401
+ * "PlayFabId": "2039475",
402
+ * "CharacterId": "98342357",
403
+ * "Keys": [
404
+ * "preferences",
405
+ * "progress"
406
+ * ]
407
+ * });
408
+ */
409
+ GetCharacterReadOnlyData(request, extraHeaders) {
410
+ return this.ExecuteRequestWrapper("/Client/GetCharacterReadOnlyData", request, "X-Authorization", extraHeaders);
411
+ }
412
+ /**
413
+ * Retrieves the details of all title-specific statistics for the user
414
+ *
415
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics Microsoft Documentation}
416
+ * @example
417
+ * await clientClient.GetCharacterStatistics({
418
+ * "CharacterId": "98765432"
419
+ * });
420
+ */
421
+ GetCharacterStatistics(request, extraHeaders) {
422
+ return this.ExecuteRequestWrapper("/Client/GetCharacterStatistics", request, "X-Authorization", extraHeaders);
423
+ }
424
+ /**
425
+ * Retrieves the title-specific URL for Cloud Script servers. This must be queried once, prior to making any calls to
426
+ * RunCloudScript.
427
+ *
428
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/getcloudscripturl Microsoft Documentation}
429
+ * @deprecated Please use ExecuteCloudScript instead.
430
+ */
431
+ GetCloudScriptUrl(request, extraHeaders) {
432
+ return this.ExecuteRequestWrapper("/Client/GetCloudScriptUrl", request, "X-Authorization", extraHeaders);
433
+ }
434
+ /**
435
+ * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
436
+ * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
437
+ * content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
438
+ * the query to retrieve the data will fail. See this post for more information:
439
+ * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
440
+ * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
441
+ *
442
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl Microsoft Documentation}
443
+ * @example
444
+ * await clientClient.GetContentDownloadUrl({
445
+ * "Key": "images/sword_icon.png"
446
+ * });
447
+ */
448
+ GetContentDownloadUrl(request, extraHeaders) {
449
+ return this.ExecuteRequestWrapper("/Client/GetContentDownloadUrl", request, "X-Authorization", extraHeaders);
450
+ }
451
+ /**
452
+ * Get details about all current running game servers matching the given parameters.
453
+ *
454
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/getcurrentgames Microsoft Documentation}
455
+ * @deprecated Please use MultiplayerServer/ListMultiplayerServers instead.
456
+ */
457
+ GetCurrentGames(request, extraHeaders) {
458
+ return this.ExecuteRequestWrapper("/Client/GetCurrentGames", request, "X-Authorization", extraHeaders);
459
+ }
460
+ /**
461
+ * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
462
+ * the leaderboard
463
+ *
464
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard Microsoft Documentation}
465
+ * @example
466
+ * await clientClient.GetFriendLeaderboard({
467
+ * "StatisticName": "Kills",
468
+ * "StartPosition": 1258,
469
+ * "MaxResultsCount": 20,
470
+ * "ExternalPlatformFriends": "Facebook, Xbox, Psn"
471
+ * });
472
+ */
473
+ GetFriendLeaderboard(request, extraHeaders) {
474
+ return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboard", request, "X-Authorization", extraHeaders);
475
+ }
476
+ /**
477
+ * Retrieves a list of ranked friends of the current player for the given statistic, centered on the currently signed-in
478
+ * user
479
+ *
480
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundcurrentuser Microsoft Documentation}
481
+ * @deprecated Please use GetFriendLeaderboardAroundPlayer instead.
482
+ */
483
+ GetFriendLeaderboardAroundCurrentUser(request, extraHeaders) {
484
+ return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboardAroundCurrentUser", request, "X-Authorization", extraHeaders);
485
+ }
486
+ /**
487
+ * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
488
+ * user. If PlayFabId is empty or null will return currently logged in user.
489
+ *
490
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer Microsoft Documentation}
491
+ * @example
492
+ * await clientClient.GetFriendLeaderboardAroundPlayer({
493
+ * "StatisticName": "Kills",
494
+ * "MaxResultsCount": 20,
495
+ * "ExternalPlatformFriends": "None"
496
+ * });
497
+ */
498
+ GetFriendLeaderboardAroundPlayer(request, extraHeaders) {
499
+ return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboardAroundPlayer", request, "X-Authorization", extraHeaders);
500
+ }
501
+ /**
502
+ * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
503
+ * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
504
+ *
505
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist Microsoft Documentation}
506
+ * @example
507
+ * await clientClient.GetFriendsList({
508
+ * "ExternalPlatformFriends": "Steam"
509
+ * });
510
+ */
511
+ GetFriendsList(request, extraHeaders) {
512
+ return this.ExecuteRequestWrapper("/Client/GetFriendsList", request, "X-Authorization", extraHeaders);
513
+ }
514
+ /**
515
+ * Get details about the regions hosting game servers matching the given parameters.
516
+ *
517
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/getgameserverregions Microsoft Documentation}
518
+ * @deprecated Please use MultiplayerServer/ListMultiplayerServers instead.
519
+ */
520
+ GetGameServerRegions(request, extraHeaders) {
521
+ return this.ExecuteRequestWrapper("/Client/GetGameServerRegions", request, "X-Authorization", extraHeaders);
522
+ }
523
+ /**
524
+ * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
525
+ *
526
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard Microsoft Documentation}
527
+ * @example
528
+ * await clientClient.GetLeaderboard({
529
+ * "StatisticName": "Kills",
530
+ * "StartPosition": 0,
531
+ * "MaxResultsCount": 20
532
+ * });
533
+ */
534
+ GetLeaderboard(request, extraHeaders) {
535
+ return this.ExecuteRequestWrapper("/Client/GetLeaderboard", request, "X-Authorization", extraHeaders);
536
+ }
537
+ /**
538
+ * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
539
+ *
540
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter Microsoft Documentation}
541
+ * @example
542
+ * await clientClient.GetLeaderboardAroundCharacter({
543
+ * "StatisticName": "Kills",
544
+ * "CharacterId": "987343220",
545
+ * "MaxResultsCount": 20
546
+ * });
547
+ */
548
+ GetLeaderboardAroundCharacter(request, extraHeaders) {
549
+ return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundCharacter", request, "X-Authorization", extraHeaders);
550
+ }
551
+ /**
552
+ * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
553
+ *
554
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundcurrentuser Microsoft Documentation}
555
+ * @deprecated Please use GetLeaderboardAroundPlayer instead.
556
+ */
557
+ GetLeaderboardAroundCurrentUser(request, extraHeaders) {
558
+ return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundCurrentUser", request, "X-Authorization", extraHeaders);
559
+ }
560
+ /**
561
+ * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
562
+ * null will return currently logged in user.
563
+ *
564
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer Microsoft Documentation}
565
+ * @example
566
+ * await clientClient.GetLeaderboardAroundPlayer({
567
+ * "StatisticName": "Kills",
568
+ * "MaxResultsCount": 20
569
+ * });
570
+ */
571
+ GetLeaderboardAroundPlayer(request, extraHeaders) {
572
+ return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundPlayer", request, "X-Authorization", extraHeaders);
573
+ }
574
+ /**
575
+ * Retrieves a list of all of the user's characters for the given statistic.
576
+ *
577
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters Microsoft Documentation}
578
+ * @example
579
+ * await clientClient.GetLeaderboardForUserCharacters({
580
+ * "StatisticName": "Kills"
581
+ * });
582
+ */
583
+ GetLeaderboardForUserCharacters(request, extraHeaders) {
584
+ return this.ExecuteRequestWrapper("/Client/GetLeaderboardForUserCharacters", request, "X-Authorization", extraHeaders);
585
+ }
586
+ /**
587
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
588
+ * version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
589
+ * client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
590
+ * client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
591
+ *
592
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken Microsoft Documentation}
593
+ * @example
594
+ * await clientClient.GetPaymentToken({
595
+ * "TokenProvider": "xsolla"
596
+ * });
597
+ */
598
+ GetPaymentToken(request, extraHeaders) {
599
+ return this.ExecuteRequestWrapper("/Client/GetPaymentToken", request, "X-Authorization", extraHeaders);
600
+ }
601
+ /**
602
+ * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
603
+ * https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
604
+ *
605
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken Microsoft Documentation}
606
+ * @example
607
+ * await clientClient.GetPhotonAuthenticationToken({
608
+ * "PhotonApplicationId": "acaa26f3-fcdb-4af4-8c76-3a3d4dd3066f"
609
+ * });
610
+ */
611
+ GetPhotonAuthenticationToken(request, extraHeaders) {
612
+ return this.ExecuteRequestWrapper("/Client/GetPhotonAuthenticationToken", request, "X-Authorization", extraHeaders);
613
+ }
614
+ /**
615
+ * Retrieves all of the user's different kinds of info.
616
+ *
617
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo Microsoft Documentation}
618
+ * @example
619
+ * await clientClient.GetPlayerCombinedInfo({
620
+ * "PlayFabId": "4027527BF22653D1",
621
+ * "InfoRequestParameters": {
622
+ * "GetUserAccountInfo": true,
623
+ * "GetUserInventory": false,
624
+ * "GetUserVirtualCurrency": true,
625
+ * "GetUserData": true,
626
+ * "UserDataKeys": [
627
+ * "preferences",
628
+ * "progress"
629
+ * ],
630
+ * "GetUserReadOnlyData": false,
631
+ * "GetCharacterInventories": false,
632
+ * "GetCharacterList": false,
633
+ * "GetTitleData": false,
634
+ * "GetPlayerStatistics": false,
635
+ * "GetPlayerProfile": false,
636
+ * "GetEntityLineage": false
637
+ * }
638
+ * });
639
+ */
640
+ GetPlayerCombinedInfo(request, extraHeaders) {
641
+ return this.ExecuteRequestWrapper("/Client/GetPlayerCombinedInfo", request, "X-Authorization", extraHeaders);
642
+ }
643
+ /**
644
+ * Retrieves a title-specific custom property value for a player.
645
+ *
646
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty Microsoft Documentation}
647
+ * @example
648
+ * await clientClient.GetPlayerCustomProperty({
649
+ * "PropertyName": "level"
650
+ * });
651
+ */
652
+ GetPlayerCustomProperty(request, extraHeaders) {
653
+ return this.ExecuteRequestWrapper("/Client/GetPlayerCustomProperty", request, "X-Authorization", extraHeaders);
654
+ }
655
+ /**
656
+ * Retrieves the player's profile
657
+ *
658
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile Microsoft Documentation}
659
+ * @example
660
+ * await clientClient.GetPlayerProfile({
661
+ * "PlayFabId": "621EF20237534A44"
662
+ * });
663
+ */
664
+ GetPlayerProfile(request, extraHeaders) {
665
+ return this.ExecuteRequestWrapper("/Client/GetPlayerProfile", request, "X-Authorization", extraHeaders);
666
+ }
667
+ /**
668
+ * List all segments that a player currently belongs to at this moment in time.
669
+ *
670
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments Microsoft Documentation}
671
+ * @example
672
+ * await clientClient.GetPlayerSegments({});
673
+ */
674
+ GetPlayerSegments(request, extraHeaders) {
675
+ return this.ExecuteRequestWrapper("/Client/GetPlayerSegments", request, "X-Authorization", extraHeaders);
676
+ }
677
+ /**
678
+ * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
679
+ * player.
680
+ *
681
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics Microsoft Documentation}
682
+ * @example
683
+ * await clientClient.GetPlayerStatistics({
684
+ * "StatisticNames": [
685
+ * "Points",
686
+ * "Wins"
687
+ * ]
688
+ * });
689
+ */
690
+ GetPlayerStatistics(request, extraHeaders) {
691
+ return this.ExecuteRequestWrapper("/Client/GetPlayerStatistics", request, "X-Authorization", extraHeaders);
692
+ }
693
+ /**
694
+ * Retrieves the information on the available versions of the specified statistic.
695
+ *
696
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions Microsoft Documentation}
697
+ * @example
698
+ * await clientClient.GetPlayerStatisticVersions({
699
+ * "StatisticName": "headshots"
700
+ * });
701
+ */
702
+ GetPlayerStatisticVersions(request, extraHeaders) {
703
+ return this.ExecuteRequestWrapper("/Client/GetPlayerStatisticVersions", request, "X-Authorization", extraHeaders);
704
+ }
705
+ /**
706
+ * Get all tags with a given Namespace (optional) from a player profile.
707
+ *
708
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags Microsoft Documentation}
709
+ * @example
710
+ * await clientClient.GetPlayerTags({
711
+ * "PlayFabId": "10931252888739651331",
712
+ * "Namespace": "title.AAA"
713
+ * });
714
+ */
715
+ GetPlayerTags(request, extraHeaders) {
716
+ return this.ExecuteRequestWrapper("/Client/GetPlayerTags", request, "X-Authorization", extraHeaders);
717
+ }
718
+ /**
719
+ * Gets all trades the player has either opened or accepted, optionally filtered by trade status.
720
+ *
721
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades Microsoft Documentation}
722
+ * @example
723
+ * await clientClient.GetPlayerTrades({
724
+ * "StatusFilter": "Filled"
725
+ * });
726
+ */
727
+ GetPlayerTrades(request, extraHeaders) {
728
+ return this.ExecuteRequestWrapper("/Client/GetPlayerTrades", request, "X-Authorization", extraHeaders);
729
+ }
730
+ /**
731
+ * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
732
+ *
733
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids Microsoft Documentation}
734
+ * @example
735
+ * await clientClient.GetPlayFabIDsFromBattleNetAccountIds({
736
+ * "BattleNetAccountIds": [
737
+ * "526f79204261747478",
738
+ * "526f79204261747479"
739
+ * ]
740
+ * });
741
+ */
742
+ GetPlayFabIDsFromBattleNetAccountIds(request, extraHeaders) {
743
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromBattleNetAccountIds", request, "X-Authorization", extraHeaders);
744
+ }
745
+ /**
746
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
747
+ *
748
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids Microsoft Documentation}
749
+ * @example
750
+ * await clientClient.GetPlayFabIDsFromFacebookIDs({
751
+ * "FacebookIDs": [
752
+ * "857498576495",
753
+ * "759374651209"
754
+ * ]
755
+ * });
756
+ */
757
+ GetPlayFabIDsFromFacebookIDs(request, extraHeaders) {
758
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookIDs", request, "X-Authorization", extraHeaders);
759
+ }
760
+ /**
761
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
762
+ *
763
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids Microsoft Documentation}
764
+ * @example
765
+ * await clientClient.GetPlayFabIDsFromFacebookInstantGamesIds({
766
+ * "FacebookInstantGamesIds": [
767
+ * "1114685845316172",
768
+ * "1114685845316173"
769
+ * ]
770
+ * });
771
+ */
772
+ GetPlayFabIDsFromFacebookInstantGamesIds(request, extraHeaders) {
773
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookInstantGamesIds", request, "X-Authorization", extraHeaders);
774
+ }
775
+ /**
776
+ * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
777
+ * Programming Guide as the Player Identifier).
778
+ *
779
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids Microsoft Documentation}
780
+ * @example
781
+ * await clientClient.GetPlayFabIDsFromGameCenterIDs({
782
+ * "GameCenterIDs": [
783
+ * "857498576495",
784
+ * "759374651209"
785
+ * ]
786
+ * });
787
+ */
788
+ GetPlayFabIDsFromGameCenterIDs(request, extraHeaders) {
789
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGameCenterIDs", request, "X-Authorization", extraHeaders);
790
+ }
791
+ /**
792
+ * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
793
+ * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
794
+ * added to the player account.
795
+ *
796
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids Microsoft Documentation}
797
+ * @example
798
+ * await clientClient.GetPlayFabIDsFromGenericIDs({
799
+ * "GenericIDs": [
800
+ * {
801
+ * "ServiceName": "BigBizSocial",
802
+ * "UserId": "1234567890"
803
+ * },
804
+ * {
805
+ * "ServiceName": "VeeCeeMe",
806
+ * "UserId": "og5igh85gf43gf"
807
+ * }
808
+ * ]
809
+ * });
810
+ */
811
+ GetPlayFabIDsFromGenericIDs(request, extraHeaders) {
812
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGenericIDs", request, "X-Authorization", extraHeaders);
813
+ }
814
+ /**
815
+ * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
816
+ * the user accounts, available as "id" in the Google+ People API calls.
817
+ *
818
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids Microsoft Documentation}
819
+ * @example
820
+ * await clientClient.GetPlayFabIDsFromGoogleIDs({
821
+ * "GoogleIDs": [
822
+ * "857498576495",
823
+ * "759374651209"
824
+ * ]
825
+ * });
826
+ */
827
+ GetPlayFabIDsFromGoogleIDs(request, extraHeaders) {
828
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGoogleIDs", request, "X-Authorization", extraHeaders);
829
+ }
830
+ /**
831
+ * Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
832
+ * identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
833
+ * calls.
834
+ *
835
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids Microsoft Documentation}
836
+ * @example
837
+ * await clientClient.GetPlayFabIDsFromGooglePlayGamesPlayerIDs({
838
+ * "GooglePlayGamesPlayerIDs": [
839
+ * "857498576495",
840
+ * "759374651209"
841
+ * ]
842
+ * });
843
+ */
844
+ GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request, extraHeaders) {
845
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs", request, "X-Authorization", extraHeaders);
846
+ }
847
+ /**
848
+ * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
849
+ * IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
850
+ * http://developers.kongregate.com/docs/client/getUserId).
851
+ *
852
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids Microsoft Documentation}
853
+ * @example
854
+ * await clientClient.GetPlayFabIDsFromKongregateIDs({
855
+ * "KongregateIDs": [
856
+ * "857498576495",
857
+ * "759374651209"
858
+ * ]
859
+ * });
860
+ */
861
+ GetPlayFabIDsFromKongregateIDs(request, extraHeaders) {
862
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromKongregateIDs", request, "X-Authorization", extraHeaders);
863
+ }
864
+ /**
865
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
866
+ *
867
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids Microsoft Documentation}
868
+ * @example
869
+ * await clientClient.GetPlayFabIDsFromNintendoServiceAccountIds({
870
+ * "NintendoAccountIds": [
871
+ * "526f79204261747478",
872
+ * "526f79204261747479"
873
+ * ]
874
+ * });
875
+ */
876
+ GetPlayFabIDsFromNintendoServiceAccountIds(request, extraHeaders) {
877
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoServiceAccountIds", request, "X-Authorization", extraHeaders);
878
+ }
879
+ /**
880
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
881
+ *
882
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids Microsoft Documentation}
883
+ * @example
884
+ * await clientClient.GetPlayFabIDsFromNintendoSwitchDeviceIds({
885
+ * "NintendoSwitchDeviceIds": [
886
+ * "526f79204261747478",
887
+ * "526f79204261747479"
888
+ * ]
889
+ * });
890
+ */
891
+ GetPlayFabIDsFromNintendoSwitchDeviceIds(request, extraHeaders) {
892
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-Authorization", extraHeaders);
893
+ }
894
+ /**
895
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
896
+ *
897
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids Microsoft Documentation}
898
+ * @example
899
+ * await clientClient.GetPlayFabIDsFromPSNAccountIDs({
900
+ * "PSNAccountIDs": [
901
+ * "857498576495",
902
+ * "759374651209"
903
+ * ]
904
+ * });
905
+ */
906
+ GetPlayFabIDsFromPSNAccountIDs(request, extraHeaders) {
907
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNAccountIDs", request, "X-Authorization", extraHeaders);
908
+ }
909
+ /**
910
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
911
+ *
912
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids Microsoft Documentation}
913
+ * @example
914
+ * await clientClient.GetPlayFabIDsFromPSNOnlineIDs({
915
+ * "PSNOnlineIDs": [
916
+ * "857555576495",
917
+ * "759345551209"
918
+ * ]
919
+ * });
920
+ */
921
+ GetPlayFabIDsFromPSNOnlineIDs(request, extraHeaders) {
922
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNOnlineIDs", request, "X-Authorization", extraHeaders);
923
+ }
924
+ /**
925
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
926
+ * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
927
+ *
928
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids Microsoft Documentation}
929
+ * @example
930
+ * await clientClient.GetPlayFabIDsFromSteamIDs({
931
+ * "SteamStringIDs": [
932
+ * "857498576495",
933
+ * "759374651209"
934
+ * ]
935
+ * });
936
+ */
937
+ GetPlayFabIDsFromSteamIDs(request, extraHeaders) {
938
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamIDs", request, "X-Authorization", extraHeaders);
939
+ }
940
+ /**
941
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
942
+ * names.
943
+ *
944
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames Microsoft Documentation}
945
+ * @example
946
+ * await clientClient.GetPlayFabIDsFromSteamNames({
947
+ * "SteamNames": [
948
+ * "steamPersonaName1",
949
+ * "steamPersonaName2"
950
+ * ]
951
+ * });
952
+ */
953
+ GetPlayFabIDsFromSteamNames(request, extraHeaders) {
954
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamNames", request, "X-Authorization", extraHeaders);
955
+ }
956
+ /**
957
+ * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
958
+ * the user accounts, available as "_id" from the Twitch API methods (ex:
959
+ * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
960
+ *
961
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids Microsoft Documentation}
962
+ * @example
963
+ * await clientClient.GetPlayFabIDsFromTwitchIDs({
964
+ * "TwitchIds": [
965
+ * "127168541",
966
+ * "88315720"
967
+ * ]
968
+ * });
969
+ */
970
+ GetPlayFabIDsFromTwitchIDs(request, extraHeaders) {
971
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromTwitchIDs", request, "X-Authorization", extraHeaders);
972
+ }
973
+ /**
974
+ * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
975
+ *
976
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids Microsoft Documentation}
977
+ * @example
978
+ * await clientClient.GetPlayFabIDsFromXboxLiveIDs({
979
+ * "XboxLiveAccountIDs": [
980
+ * "857498576495",
981
+ * "759374651209"
982
+ * ],
983
+ * "Sandbox": "RETAIL"
984
+ * });
985
+ */
986
+ GetPlayFabIDsFromXboxLiveIDs(request, extraHeaders) {
987
+ return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromXboxLiveIDs", request, "X-Authorization", extraHeaders);
988
+ }
989
+ /**
990
+ * Retrieves the key-value store of custom publisher settings
991
+ *
992
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata Microsoft Documentation}
993
+ * @example
994
+ * await clientClient.GetPublisherData({
995
+ * "Keys": [
996
+ * "color",
997
+ * "propertyA"
998
+ * ]
999
+ * });
1000
+ */
1001
+ GetPublisherData(request, extraHeaders) {
1002
+ return this.ExecuteRequestWrapper("/Client/GetPublisherData", request, "X-Authorization", extraHeaders);
1003
+ }
1004
+ /**
1005
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1006
+ * version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
1007
+ * are still active.
1008
+ *
1009
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase Microsoft Documentation}
1010
+ * @example
1011
+ * await clientClient.GetPurchase({
1012
+ * "OrderId": "8853591446005860822"
1013
+ * });
1014
+ */
1015
+ GetPurchase(request, extraHeaders) {
1016
+ return this.ExecuteRequestWrapper("/Client/GetPurchase", request, "X-Authorization", extraHeaders);
1017
+ }
1018
+ /**
1019
+ * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group
1020
+ * may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
1021
+ * Shared Groups are designed for sharing data between a very small number of players, please see our guide:
1022
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1023
+ *
1024
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata Microsoft Documentation}
1025
+ * @example
1026
+ * await clientClient.GetSharedGroupData({
1027
+ * "SharedGroupId": "Clan Data",
1028
+ * "Keys": [
1029
+ * "ClanKills",
1030
+ * "LastClanUpdate"
1031
+ * ],
1032
+ * "GetMembers": true
1033
+ * });
1034
+ */
1035
+ GetSharedGroupData(request, extraHeaders) {
1036
+ return this.ExecuteRequestWrapper("/Client/GetSharedGroupData", request, "X-Authorization", extraHeaders);
1037
+ }
1038
+ /**
1039
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1040
+ * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
1041
+ *
1042
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems Microsoft Documentation}
1043
+ * @example
1044
+ * await clientClient.GetStoreItems({
1045
+ * "StoreId": "BonusStore"
1046
+ * });
1047
+ */
1048
+ GetStoreItems(request, extraHeaders) {
1049
+ return this.ExecuteRequestWrapper("/Client/GetStoreItems", request, "X-Authorization", extraHeaders);
1050
+ }
1051
+ /**
1052
+ * Retrieves the current server time
1053
+ *
1054
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime Microsoft Documentation}
1055
+ * @example
1056
+ * await clientClient.GetTime({});
1057
+ */
1058
+ GetTime(request, extraHeaders) {
1059
+ return this.ExecuteRequestWrapper("/Client/GetTime", request, "X-Authorization", extraHeaders);
1060
+ }
1061
+ /**
1062
+ * Retrieves the key-value store of custom title settings
1063
+ *
1064
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata Microsoft Documentation}
1065
+ * @example
1066
+ * await clientClient.GetTitleData({
1067
+ * "Keys": [
1068
+ * "color",
1069
+ * "propertyA"
1070
+ * ]
1071
+ * });
1072
+ */
1073
+ GetTitleData(request, extraHeaders) {
1074
+ return this.ExecuteRequestWrapper("/Client/GetTitleData", request, "X-Authorization", extraHeaders);
1075
+ }
1076
+ /**
1077
+ * Retrieves the title news feed, as configured in the developer portal
1078
+ *
1079
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews Microsoft Documentation}
1080
+ * @example
1081
+ * await clientClient.GetTitleNews({
1082
+ * "Count": 25
1083
+ * });
1084
+ */
1085
+ GetTitleNews(request, extraHeaders) {
1086
+ return this.ExecuteRequestWrapper("/Client/GetTitleNews", request, "X-Authorization", extraHeaders);
1087
+ }
1088
+ /**
1089
+ * Returns the title's base 64 encoded RSA CSP blob.
1090
+ *
1091
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey Microsoft Documentation}
1092
+ * @example
1093
+ * await clientClient.GetTitlePublicKey({
1094
+ * "TitleId": "ID",
1095
+ * "TitleSharedSecret": "ExampleSecret"
1096
+ * });
1097
+ */
1098
+ GetTitlePublicKey(request, extraHeaders) {
1099
+ return this.ExecuteRequestWrapper("/Client/GetTitlePublicKey", request, null, extraHeaders);
1100
+ }
1101
+ /**
1102
+ * Gets the current status of an existing trade.
1103
+ *
1104
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus Microsoft Documentation}
1105
+ * @example
1106
+ * await clientClient.GetTradeStatus({
1107
+ * "OfferingPlayerId": "CD803BF233CE76CC",
1108
+ * "TradeId": "D819CEC225EA9948C351"
1109
+ * });
1110
+ */
1111
+ GetTradeStatus(request, extraHeaders) {
1112
+ return this.ExecuteRequestWrapper("/Client/GetTradeStatus", request, "X-Authorization", extraHeaders);
1113
+ }
1114
+ /**
1115
+ * NOTE: This call will be deprecated soon. For fetching the data for a given user use GetPlayerCombinedInfo. For looking
1116
+ * up users from the client api, we are in the process of adding a new api call. Once that call is ready, this one will be
1117
+ * deprecated. Retrieves all requested data for a user in one unified request. By default, this API returns all data for
1118
+ * the locally signed-in user. The input parameters may be used to limit the data retrieved to any subset of the available
1119
+ * data, as well as retrieve the available data for a different user. Note that certain data, including inventory, virtual
1120
+ * currency balances, and personally identifying information, may only be retrieved for the locally signed-in user. In the
1121
+ * example below, a request is made for the account details, virtual currency balances, and specified user data for the
1122
+ * locally signed-in user.
1123
+ *
1124
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getusercombinedinfo Microsoft Documentation}
1125
+ * @deprecated Please use GetPlayerCombinedInfo instead.
1126
+ */
1127
+ GetUserCombinedInfo(request, extraHeaders) {
1128
+ return this.ExecuteRequestWrapper("/Client/GetUserCombinedInfo", request, "X-Authorization", extraHeaders);
1129
+ }
1130
+ /**
1131
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
1132
+ *
1133
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata Microsoft Documentation}
1134
+ * @example
1135
+ * await clientClient.GetUserData({
1136
+ * "Keys": [
1137
+ * "preferences",
1138
+ * "progress"
1139
+ * ]
1140
+ * });
1141
+ */
1142
+ GetUserData(request, extraHeaders) {
1143
+ return this.ExecuteRequestWrapper("/Client/GetUserData", request, "X-Authorization", extraHeaders);
1144
+ }
1145
+ /**
1146
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1147
+ * version 2._ Retrieves the user's current inventory of virtual goods
1148
+ *
1149
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory Microsoft Documentation}
1150
+ * @example
1151
+ * await clientClient.GetUserInventory({});
1152
+ */
1153
+ GetUserInventory(request, extraHeaders) {
1154
+ return this.ExecuteRequestWrapper("/Client/GetUserInventory", request, "X-Authorization", extraHeaders);
1155
+ }
1156
+ /**
1157
+ * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
1158
+ *
1159
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata Microsoft Documentation}
1160
+ * @example
1161
+ * await clientClient.GetUserPublisherData({
1162
+ * "Keys": [
1163
+ * "preferences",
1164
+ * "progress"
1165
+ * ]
1166
+ * });
1167
+ */
1168
+ GetUserPublisherData(request, extraHeaders) {
1169
+ return this.ExecuteRequestWrapper("/Client/GetUserPublisherData", request, "X-Authorization", extraHeaders);
1170
+ }
1171
+ /**
1172
+ * Retrieves the publisher-specific custom data for the user which can only be read by the client
1173
+ *
1174
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
1175
+ * @example
1176
+ * await clientClient.GetUserPublisherReadOnlyData({
1177
+ * "Keys": [
1178
+ * "preferences",
1179
+ * "progress"
1180
+ * ]
1181
+ * });
1182
+ */
1183
+ GetUserPublisherReadOnlyData(request, extraHeaders) {
1184
+ return this.ExecuteRequestWrapper("/Client/GetUserPublisherReadOnlyData", request, "X-Authorization", extraHeaders);
1185
+ }
1186
+ /**
1187
+ * Retrieves the title-specific custom data for the user which can only be read by the client
1188
+ *
1189
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata Microsoft Documentation}
1190
+ * @example
1191
+ * await clientClient.GetUserReadOnlyData({
1192
+ * "Keys": [
1193
+ * "preferences",
1194
+ * "progress"
1195
+ * ]
1196
+ * });
1197
+ */
1198
+ GetUserReadOnlyData(request, extraHeaders) {
1199
+ return this.ExecuteRequestWrapper("/Client/GetUserReadOnlyData", request, "X-Authorization", extraHeaders);
1200
+ }
1201
+ /**
1202
+ * Retrieves the details of all title-specific statistics for the user
1203
+ *
1204
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserstatistics Microsoft Documentation}
1205
+ * @deprecated Please use GetPlayerStatistics instead.
1206
+ */
1207
+ GetUserStatistics(request, extraHeaders) {
1208
+ return this.ExecuteRequestWrapper("/Client/GetUserStatistics", request, "X-Authorization", extraHeaders);
1209
+ }
1210
+ /**
1211
+ * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
1212
+ * with the parent PlayFabId to guarantee uniqueness.
1213
+ *
1214
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser Microsoft Documentation}
1215
+ * @example
1216
+ * await clientClient.GrantCharacterToUser({
1217
+ * "CatalogVersion": "2.2",
1218
+ * "ItemId": "Blue Warrior",
1219
+ * "CharacterName": "FighterDude"
1220
+ * });
1221
+ */
1222
+ GrantCharacterToUser(request, extraHeaders) {
1223
+ return this.ExecuteRequestWrapper("/Client/GrantCharacterToUser", request, "X-Authorization", extraHeaders);
1224
+ }
1225
+ /**
1226
+ * Links the Android device identifier to the user's PlayFab account
1227
+ *
1228
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid Microsoft Documentation}
1229
+ * @example
1230
+ * await clientClient.LinkAndroidDeviceID({
1231
+ * "AndroidDeviceId": "526f79204261747479",
1232
+ * "OS": "5.0",
1233
+ * "AndroidDevice": "Nexus 6"
1234
+ * });
1235
+ */
1236
+ LinkAndroidDeviceID(request, extraHeaders) {
1237
+ return this.ExecuteRequestWrapper("/Client/LinkAndroidDeviceID", request, "X-Authorization", extraHeaders);
1238
+ }
1239
+ /**
1240
+ * Links the Apple account associated with the token to the user's PlayFab account.
1241
+ *
1242
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple Microsoft Documentation}
1243
+ * @example
1244
+ * await clientClient.LinkApple({
1245
+ * "IdentityToken": "eyJraWQi..."
1246
+ * });
1247
+ */
1248
+ LinkApple(request, extraHeaders) {
1249
+ return this.ExecuteRequestWrapper("/Client/LinkApple", request, "X-Authorization", extraHeaders);
1250
+ }
1251
+ /**
1252
+ * Links the Battle.net account associated with the token to the user's PlayFab account.
1253
+ *
1254
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount Microsoft Documentation}
1255
+ * @example
1256
+ * await clientClient.LinkBattleNetAccount({
1257
+ * "IdentityToken": "eyJraWQi..."
1258
+ * });
1259
+ */
1260
+ LinkBattleNetAccount(request, extraHeaders) {
1261
+ return this.ExecuteRequestWrapper("/Client/LinkBattleNetAccount", request, "X-Authorization", extraHeaders);
1262
+ }
1263
+ /**
1264
+ * Links the custom identifier, generated by the title, to the user's PlayFab account
1265
+ *
1266
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid Microsoft Documentation}
1267
+ * @example
1268
+ * await clientClient.LinkCustomID({
1269
+ * "CustomId": "67AB-5397-CC54-EA31"
1270
+ * });
1271
+ */
1272
+ LinkCustomID(request, extraHeaders) {
1273
+ return this.ExecuteRequestWrapper("/Client/LinkCustomID", request, "X-Authorization", extraHeaders);
1274
+ }
1275
+ /**
1276
+ * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
1277
+ *
1278
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount Microsoft Documentation}
1279
+ * @example
1280
+ * await clientClient.LinkFacebookAccount({
1281
+ * "AccessToken": "FaceAccessTokenID"
1282
+ * });
1283
+ */
1284
+ LinkFacebookAccount(request, extraHeaders) {
1285
+ return this.ExecuteRequestWrapper("/Client/LinkFacebookAccount", request, "X-Authorization", extraHeaders);
1286
+ }
1287
+ /**
1288
+ * Links the Facebook Instant Games Id to the user's PlayFab account
1289
+ *
1290
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid Microsoft Documentation}
1291
+ * @example
1292
+ * await clientClient.LinkFacebookInstantGamesId({
1293
+ * "FacebookInstantGamesSignature": "abcdef"
1294
+ * });
1295
+ */
1296
+ LinkFacebookInstantGamesId(request, extraHeaders) {
1297
+ return this.ExecuteRequestWrapper("/Client/LinkFacebookInstantGamesId", request, "X-Authorization", extraHeaders);
1298
+ }
1299
+ /**
1300
+ * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with
1301
+ * a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
1302
+ * in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
1303
+ * page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
1304
+ *
1305
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount Microsoft Documentation}
1306
+ * @example
1307
+ * await clientClient.LinkGameCenterAccount({
1308
+ * "GameCenterId": "2998h2998f0b000d0993"
1309
+ * });
1310
+ */
1311
+ LinkGameCenterAccount(request, extraHeaders) {
1312
+ return this.ExecuteRequestWrapper("/Client/LinkGameCenterAccount", request, "X-Authorization", extraHeaders);
1313
+ }
1314
+ /**
1315
+ * Links the currently signed-in user account to their Google account, using their Google account credentials
1316
+ *
1317
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount Microsoft Documentation}
1318
+ * @example
1319
+ * await clientClient.LinkGoogleAccount({
1320
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#"
1321
+ * });
1322
+ */
1323
+ LinkGoogleAccount(request, extraHeaders) {
1324
+ return this.ExecuteRequestWrapper("/Client/LinkGoogleAccount", request, "X-Authorization", extraHeaders);
1325
+ }
1326
+ /**
1327
+ * Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
1328
+ * credentials
1329
+ *
1330
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount Microsoft Documentation}
1331
+ * @example
1332
+ * await clientClient.LinkGooglePlayGamesServicesAccount({
1333
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#"
1334
+ * });
1335
+ */
1336
+ LinkGooglePlayGamesServicesAccount(request, extraHeaders) {
1337
+ return this.ExecuteRequestWrapper("/Client/LinkGooglePlayGamesServicesAccount", request, "X-Authorization", extraHeaders);
1338
+ }
1339
+ /**
1340
+ * Links the vendor-specific iOS device identifier to the user's PlayFab account
1341
+ *
1342
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid Microsoft Documentation}
1343
+ * @example
1344
+ * await clientClient.LinkIOSDeviceID({
1345
+ * "DeviceId": "29848d9bh8900a0b003",
1346
+ * "OS": "7.11",
1347
+ * "DeviceModel": "Iphone 5s"
1348
+ * });
1349
+ */
1350
+ LinkIOSDeviceID(request, extraHeaders) {
1351
+ return this.ExecuteRequestWrapper("/Client/LinkIOSDeviceID", request, "X-Authorization", extraHeaders);
1352
+ }
1353
+ /**
1354
+ * Links the Kongregate identifier to the user's PlayFab account
1355
+ *
1356
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate Microsoft Documentation}
1357
+ * @example
1358
+ * await clientClient.LinkKongregate({
1359
+ * "KongregateId": "457332",
1360
+ * "AuthTicket": "{123-456-78931212}"
1361
+ * });
1362
+ */
1363
+ LinkKongregate(request, extraHeaders) {
1364
+ return this.ExecuteRequestWrapper("/Client/LinkKongregate", request, "X-Authorization", extraHeaders);
1365
+ }
1366
+ /**
1367
+ * Links the Nintendo account associated with the token to the user's PlayFab account.
1368
+ *
1369
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount Microsoft Documentation}
1370
+ * @example
1371
+ * await clientClient.LinkNintendoServiceAccount({
1372
+ * "IdentityToken": "eyJraWQi..."
1373
+ * });
1374
+ */
1375
+ LinkNintendoServiceAccount(request, extraHeaders) {
1376
+ return this.ExecuteRequestWrapper("/Client/LinkNintendoServiceAccount", request, "X-Authorization", extraHeaders);
1377
+ }
1378
+ /**
1379
+ * Links the NintendoSwitchDeviceId to the user's PlayFab account
1380
+ *
1381
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid Microsoft Documentation}
1382
+ * @example
1383
+ * await clientClient.LinkNintendoSwitchDeviceId({
1384
+ * "NintendoSwitchDeviceId": "526f79204261747479"
1385
+ * });
1386
+ */
1387
+ LinkNintendoSwitchDeviceId(request, extraHeaders) {
1388
+ return this.ExecuteRequestWrapper("/Client/LinkNintendoSwitchDeviceId", request, "X-Authorization", extraHeaders);
1389
+ }
1390
+ /**
1391
+ * Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
1392
+ * Open ID Connect provider and the OpenId Connect JWT from that provider.
1393
+ *
1394
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect Microsoft Documentation}
1395
+ * @example
1396
+ * await clientClient.LinkOpenIdConnect({
1397
+ * "ConnectionId": "exampleprovider",
1398
+ * "IdToken": "eyJraWQi..."
1399
+ * });
1400
+ */
1401
+ LinkOpenIdConnect(request, extraHeaders) {
1402
+ return this.ExecuteRequestWrapper("/Client/LinkOpenIdConnect", request, "X-Authorization", extraHeaders);
1403
+ }
1404
+ /**
1405
+ * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
1406
+ *
1407
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount Microsoft Documentation}
1408
+ * @example
1409
+ * await clientClient.LinkPSNAccount({
1410
+ * "AuthCode": "LKJDG7DDE",
1411
+ * "RedirectUri": "orbis://games"
1412
+ * });
1413
+ */
1414
+ LinkPSNAccount(request, extraHeaders) {
1415
+ return this.ExecuteRequestWrapper("/Client/LinkPSNAccount", request, "X-Authorization", extraHeaders);
1416
+ }
1417
+ /**
1418
+ * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
1419
+ *
1420
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount Microsoft Documentation}
1421
+ * @example
1422
+ * await clientClient.LinkSteamAccount({
1423
+ * "SteamTicket": "steamTicketID",
1424
+ * "TicketIsServiceSpecific": true
1425
+ * });
1426
+ */
1427
+ LinkSteamAccount(request, extraHeaders) {
1428
+ return this.ExecuteRequestWrapper("/Client/LinkSteamAccount", request, "X-Authorization", extraHeaders);
1429
+ }
1430
+ /**
1431
+ * Links the Twitch account associated with the token to the user's PlayFab account.
1432
+ *
1433
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch Microsoft Documentation}
1434
+ * @example
1435
+ * await clientClient.LinkTwitch({
1436
+ * "AccessToken": "TwitchAccessToken"
1437
+ * });
1438
+ */
1439
+ LinkTwitch(request, extraHeaders) {
1440
+ return this.ExecuteRequestWrapper("/Client/LinkTwitch", request, "X-Authorization", extraHeaders);
1441
+ }
1442
+ /**
1443
+ * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
1444
+ *
1445
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount Microsoft Documentation}
1446
+ * @example
1447
+ * await clientClient.LinkXboxAccount({
1448
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad"
1449
+ * });
1450
+ */
1451
+ LinkXboxAccount(request, extraHeaders) {
1452
+ return this.ExecuteRequestWrapper("/Client/LinkXboxAccount", request, "X-Authorization", extraHeaders);
1453
+ }
1454
+ /**
1455
+ * Retrieves title-specific custom property values for a player.
1456
+ *
1457
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties Microsoft Documentation}
1458
+ * @example
1459
+ * await clientClient.ListPlayerCustomProperties({});
1460
+ */
1461
+ ListPlayerCustomProperties(request, extraHeaders) {
1462
+ return this.ExecuteRequestWrapper("/Client/ListPlayerCustomProperties", request, "X-Authorization", extraHeaders);
1463
+ }
1464
+ /**
1465
+ * Logs a custom analytics event
1466
+ *
1467
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/logevent Microsoft Documentation}
1468
+ * @deprecated Please use WritePlayerEvent instead.
1469
+ */
1470
+ LogEvent(request, extraHeaders) {
1471
+ return this.ExecuteRequestWrapper("/Client/LogEvent", request, "X-Authorization", extraHeaders);
1472
+ }
1473
+ /**
1474
+ * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
1475
+ * API calls which require an authenticated user
1476
+ *
1477
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid Microsoft Documentation}
1478
+ * @example
1479
+ * await clientClient.LoginWithAndroidDeviceID({
1480
+ * "AndroidDeviceId": "526f79204261747479",
1481
+ * "OS": "5.0",
1482
+ * "AndroidDevice": "Nexus 6",
1483
+ * "CreateAccount": false,
1484
+ * "TitleId": "144"
1485
+ * });
1486
+ */
1487
+ LoginWithAndroidDeviceID(request, extraHeaders) {
1488
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1489
+ if (!request.TitleId) throw this.errorTitleId;
1490
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1491
+ return this.ExecuteRequestWrapper("/Client/LoginWithAndroidDeviceID", request, null, extraHeaders).then((result) => {
1492
+ var _a;
1493
+ if (result) {
1494
+ if (result == null ? void 0 : result.SessionTicket) {
1495
+ this.sessionTicket = result.SessionTicket;
1496
+ }
1497
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1498
+ this.entityToken = result.EntityToken.EntityToken;
1499
+ }
1500
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1501
+ }
1502
+ return result;
1503
+ });
1504
+ }
1505
+ /**
1506
+ * Signs in the user with a Sign in with Apple identity token.
1507
+ *
1508
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple Microsoft Documentation}
1509
+ * @example
1510
+ * await clientClient.LoginWithApple({
1511
+ * "IdentityToken": "eyJraWQi...",
1512
+ * "TitleId": "144"
1513
+ * });
1514
+ */
1515
+ LoginWithApple(request, extraHeaders) {
1516
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1517
+ if (!request.TitleId) throw this.errorTitleId;
1518
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1519
+ return this.ExecuteRequestWrapper("/Client/LoginWithApple", request, null, extraHeaders).then((result) => {
1520
+ var _a;
1521
+ if (result) {
1522
+ if (result == null ? void 0 : result.SessionTicket) {
1523
+ this.sessionTicket = result.SessionTicket;
1524
+ }
1525
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1526
+ this.entityToken = result.EntityToken.EntityToken;
1527
+ }
1528
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1529
+ }
1530
+ return result;
1531
+ });
1532
+ }
1533
+ /**
1534
+ * Sign in the user with a Battle.net identity token
1535
+ *
1536
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet Microsoft Documentation}
1537
+ * @example
1538
+ * await clientClient.LoginWithBattleNet({
1539
+ * "IdentityToken": "eyJraWQi...",
1540
+ * "TitleId": "144"
1541
+ * });
1542
+ */
1543
+ LoginWithBattleNet(request, extraHeaders) {
1544
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1545
+ if (!request.TitleId) throw this.errorTitleId;
1546
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1547
+ return this.ExecuteRequestWrapper("/Client/LoginWithBattleNet", request, null, extraHeaders).then((result) => {
1548
+ var _a;
1549
+ if (result) {
1550
+ if (result == null ? void 0 : result.SessionTicket) {
1551
+ this.sessionTicket = result.SessionTicket;
1552
+ }
1553
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1554
+ this.entityToken = result.EntityToken.EntityToken;
1555
+ }
1556
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1557
+ }
1558
+ return result;
1559
+ });
1560
+ }
1561
+ /**
1562
+ * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
1563
+ * subsequently be used for API calls which require an authenticated user
1564
+ *
1565
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid Microsoft Documentation}
1566
+ * @example
1567
+ * await clientClient.LoginWithCustomID({
1568
+ * "CustomId": "67AB-5397-CC54-EA31",
1569
+ * "CreateAccount": false,
1570
+ * "TitleId": "144"
1571
+ * });
1572
+ */
1573
+ LoginWithCustomID(request, extraHeaders) {
1574
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1575
+ if (!request.TitleId) throw this.errorTitleId;
1576
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1577
+ return this.ExecuteRequestWrapper("/Client/LoginWithCustomID", request, null, extraHeaders).then((result) => {
1578
+ var _a;
1579
+ if (result) {
1580
+ if (result == null ? void 0 : result.SessionTicket) {
1581
+ this.sessionTicket = result.SessionTicket;
1582
+ }
1583
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1584
+ this.entityToken = result.EntityToken.EntityToken;
1585
+ }
1586
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1587
+ }
1588
+ return result;
1589
+ });
1590
+ }
1591
+ /**
1592
+ * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
1593
+ * which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
1594
+ * creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
1595
+ * RegisterPlayFabUser.
1596
+ *
1597
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress Microsoft Documentation}
1598
+ * @example
1599
+ * await clientClient.LoginWithEmailAddress({
1600
+ * "Email": "theuser@domain.com",
1601
+ * "Password": "thepassword",
1602
+ * "TitleId": "144"
1603
+ * });
1604
+ */
1605
+ LoginWithEmailAddress(request, extraHeaders) {
1606
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1607
+ if (!request.TitleId) throw this.errorTitleId;
1608
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1609
+ return this.ExecuteRequestWrapper("/Client/LoginWithEmailAddress", request, null, extraHeaders).then((result) => {
1610
+ var _a;
1611
+ if (result) {
1612
+ if (result == null ? void 0 : result.SessionTicket) {
1613
+ this.sessionTicket = result.SessionTicket;
1614
+ }
1615
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1616
+ this.entityToken = result.EntityToken.EntityToken;
1617
+ }
1618
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1619
+ }
1620
+ return result;
1621
+ });
1622
+ }
1623
+ /**
1624
+ * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
1625
+ * calls which require an authenticated user
1626
+ *
1627
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook Microsoft Documentation}
1628
+ * @example
1629
+ * await clientClient.LoginWithFacebook({
1630
+ * "AccessToken": "FaceAccessTokenID",
1631
+ * "CreateAccount": false,
1632
+ * "TitleId": "144"
1633
+ * });
1634
+ */
1635
+ LoginWithFacebook(request, extraHeaders) {
1636
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1637
+ if (!request.TitleId) throw this.errorTitleId;
1638
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1639
+ return this.ExecuteRequestWrapper("/Client/LoginWithFacebook", request, null, extraHeaders).then((result) => {
1640
+ var _a;
1641
+ if (result) {
1642
+ if (result == null ? void 0 : result.SessionTicket) {
1643
+ this.sessionTicket = result.SessionTicket;
1644
+ }
1645
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1646
+ this.entityToken = result.EntityToken.EntityToken;
1647
+ }
1648
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1649
+ }
1650
+ return result;
1651
+ });
1652
+ }
1653
+ /**
1654
+ * Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
1655
+ * API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
1656
+ *
1657
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid Microsoft Documentation}
1658
+ * @example
1659
+ * await clientClient.LoginWithFacebookInstantGamesId({
1660
+ * "FacebookInstantGamesSignature": "abcdef",
1661
+ * "CreateAccount": false,
1662
+ * "TitleId": "144"
1663
+ * });
1664
+ */
1665
+ LoginWithFacebookInstantGamesId(request, extraHeaders) {
1666
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1667
+ if (!request.TitleId) throw this.errorTitleId;
1668
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1669
+ return this.ExecuteRequestWrapper("/Client/LoginWithFacebookInstantGamesId", request, null, extraHeaders).then((result) => {
1670
+ var _a;
1671
+ if (result) {
1672
+ if (result == null ? void 0 : result.SessionTicket) {
1673
+ this.sessionTicket = result.SessionTicket;
1674
+ }
1675
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1676
+ this.entityToken = result.EntityToken.EntityToken;
1677
+ }
1678
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1679
+ }
1680
+ return result;
1681
+ });
1682
+ }
1683
+ /**
1684
+ * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be
1685
+ * used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not
1686
+ * include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you
1687
+ * require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and
1688
+ * enabling the 'Require secure authentication only for this app' option.
1689
+ *
1690
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter Microsoft Documentation}
1691
+ * @example
1692
+ * await clientClient.LoginWithGameCenter({
1693
+ * "PlayerId": "pachycephalosaurus01",
1694
+ * "CreateAccount": false,
1695
+ * "TitleId": "144"
1696
+ * });
1697
+ */
1698
+ LoginWithGameCenter(request, extraHeaders) {
1699
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1700
+ if (!request.TitleId) throw this.errorTitleId;
1701
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1702
+ return this.ExecuteRequestWrapper("/Client/LoginWithGameCenter", request, null, extraHeaders).then((result) => {
1703
+ var _a;
1704
+ if (result) {
1705
+ if (result == null ? void 0 : result.SessionTicket) {
1706
+ this.sessionTicket = result.SessionTicket;
1707
+ }
1708
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1709
+ this.entityToken = result.EntityToken.EntityToken;
1710
+ }
1711
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1712
+ }
1713
+ return result;
1714
+ });
1715
+ }
1716
+ /**
1717
+ * Signs the user in using their Google account credentials
1718
+ *
1719
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount Microsoft Documentation}
1720
+ * @example
1721
+ * await clientClient.LoginWithGoogleAccount({
1722
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#",
1723
+ * "CreateAccount": false,
1724
+ * "SetEmail": true,
1725
+ * "TitleId": "144"
1726
+ * });
1727
+ */
1728
+ LoginWithGoogleAccount(request, extraHeaders) {
1729
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1730
+ if (!request.TitleId) throw this.errorTitleId;
1731
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1732
+ return this.ExecuteRequestWrapper("/Client/LoginWithGoogleAccount", request, null, extraHeaders).then((result) => {
1733
+ var _a;
1734
+ if (result) {
1735
+ if (result == null ? void 0 : result.SessionTicket) {
1736
+ this.sessionTicket = result.SessionTicket;
1737
+ }
1738
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1739
+ this.entityToken = result.EntityToken.EntityToken;
1740
+ }
1741
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1742
+ }
1743
+ return result;
1744
+ });
1745
+ }
1746
+ /**
1747
+ * Signs the user in using their Google Play Games account credentials
1748
+ *
1749
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices Microsoft Documentation}
1750
+ * @example
1751
+ * await clientClient.LoginWithGooglePlayGamesServices({
1752
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#",
1753
+ * "CreateAccount": false,
1754
+ * "TitleId": "144"
1755
+ * });
1756
+ */
1757
+ LoginWithGooglePlayGamesServices(request, extraHeaders) {
1758
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1759
+ if (!request.TitleId) throw this.errorTitleId;
1760
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1761
+ return this.ExecuteRequestWrapper("/Client/LoginWithGooglePlayGamesServices", request, null, extraHeaders).then((result) => {
1762
+ var _a;
1763
+ if (result) {
1764
+ if (result == null ? void 0 : result.SessionTicket) {
1765
+ this.sessionTicket = result.SessionTicket;
1766
+ }
1767
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1768
+ this.entityToken = result.EntityToken.EntityToken;
1769
+ }
1770
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1771
+ }
1772
+ return result;
1773
+ });
1774
+ }
1775
+ /**
1776
+ * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
1777
+ * be used for API calls which require an authenticated user
1778
+ *
1779
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid Microsoft Documentation}
1780
+ * @example
1781
+ * await clientClient.LoginWithIOSDeviceID({
1782
+ * "DeviceId": "29848d9bh8900a0b003",
1783
+ * "OS": "7.11",
1784
+ * "DeviceModel": "Iphone 5s",
1785
+ * "CreateAccount": false,
1786
+ * "TitleId": "144"
1787
+ * });
1788
+ */
1789
+ LoginWithIOSDeviceID(request, extraHeaders) {
1790
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1791
+ if (!request.TitleId) throw this.errorTitleId;
1792
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1793
+ return this.ExecuteRequestWrapper("/Client/LoginWithIOSDeviceID", request, null, extraHeaders).then((result) => {
1794
+ var _a;
1795
+ if (result) {
1796
+ if (result == null ? void 0 : result.SessionTicket) {
1797
+ this.sessionTicket = result.SessionTicket;
1798
+ }
1799
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1800
+ this.entityToken = result.EntityToken.EntityToken;
1801
+ }
1802
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1803
+ }
1804
+ return result;
1805
+ });
1806
+ }
1807
+ /**
1808
+ * Signs the user in using a Kongregate player account.
1809
+ *
1810
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate Microsoft Documentation}
1811
+ * @example
1812
+ * await clientClient.LoginWithKongregate({
1813
+ * "KongregateId": "457332",
1814
+ * "AuthTicket": "SomeKongregateTokenHere",
1815
+ * "CreateAccount": false,
1816
+ * "TitleId": "144"
1817
+ * });
1818
+ */
1819
+ LoginWithKongregate(request, extraHeaders) {
1820
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1821
+ if (!request.TitleId) throw this.errorTitleId;
1822
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1823
+ return this.ExecuteRequestWrapper("/Client/LoginWithKongregate", request, null, extraHeaders).then((result) => {
1824
+ var _a;
1825
+ if (result) {
1826
+ if (result == null ? void 0 : result.SessionTicket) {
1827
+ this.sessionTicket = result.SessionTicket;
1828
+ }
1829
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1830
+ this.entityToken = result.EntityToken.EntityToken;
1831
+ }
1832
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1833
+ }
1834
+ return result;
1835
+ });
1836
+ }
1837
+ /**
1838
+ * Signs in the user with a Nintendo service account token.
1839
+ *
1840
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount Microsoft Documentation}
1841
+ * @example
1842
+ * await clientClient.LoginWithNintendoServiceAccount({
1843
+ * "IdentityToken": "eyJraWQi...",
1844
+ * "TitleId": "144"
1845
+ * });
1846
+ */
1847
+ LoginWithNintendoServiceAccount(request, extraHeaders) {
1848
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1849
+ if (!request.TitleId) throw this.errorTitleId;
1850
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1851
+ return this.ExecuteRequestWrapper("/Client/LoginWithNintendoServiceAccount", request, null, extraHeaders).then((result) => {
1852
+ var _a;
1853
+ if (result) {
1854
+ if (result == null ? void 0 : result.SessionTicket) {
1855
+ this.sessionTicket = result.SessionTicket;
1856
+ }
1857
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1858
+ this.entityToken = result.EntityToken.EntityToken;
1859
+ }
1860
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1861
+ }
1862
+ return result;
1863
+ });
1864
+ }
1865
+ /**
1866
+ * Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
1867
+ * API calls which require an authenticated user
1868
+ *
1869
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid Microsoft Documentation}
1870
+ * @example
1871
+ * await clientClient.LoginWithNintendoSwitchDeviceId({
1872
+ * "NintendoSwitchDeviceId": "526f79204261747479",
1873
+ * "CreateAccount": false,
1874
+ * "TitleId": "144"
1875
+ * });
1876
+ */
1877
+ LoginWithNintendoSwitchDeviceId(request, extraHeaders) {
1878
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1879
+ if (!request.TitleId) throw this.errorTitleId;
1880
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1881
+ return this.ExecuteRequestWrapper("/Client/LoginWithNintendoSwitchDeviceId", request, null, extraHeaders).then((result) => {
1882
+ var _a;
1883
+ if (result) {
1884
+ if (result == null ? void 0 : result.SessionTicket) {
1885
+ this.sessionTicket = result.SessionTicket;
1886
+ }
1887
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1888
+ this.entityToken = result.EntityToken.EntityToken;
1889
+ }
1890
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1891
+ }
1892
+ return result;
1893
+ });
1894
+ }
1895
+ /**
1896
+ * Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
1897
+ * provider.
1898
+ *
1899
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect Microsoft Documentation}
1900
+ * @example
1901
+ * await clientClient.LoginWithOpenIdConnect({
1902
+ * "ConnectionId": "exampleprovider",
1903
+ * "IdToken": "eyJraWQi...",
1904
+ * "TitleId": "144"
1905
+ * });
1906
+ */
1907
+ LoginWithOpenIdConnect(request, extraHeaders) {
1908
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1909
+ if (!request.TitleId) throw this.errorTitleId;
1910
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1911
+ return this.ExecuteRequestWrapper("/Client/LoginWithOpenIdConnect", request, null, extraHeaders).then((result) => {
1912
+ var _a;
1913
+ if (result) {
1914
+ if (result == null ? void 0 : result.SessionTicket) {
1915
+ this.sessionTicket = result.SessionTicket;
1916
+ }
1917
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1918
+ this.entityToken = result.EntityToken.EntityToken;
1919
+ }
1920
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1921
+ }
1922
+ return result;
1923
+ });
1924
+ }
1925
+ /**
1926
+ * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
1927
+ * which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
1928
+ * new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via
1929
+ * RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
1930
+ *
1931
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab Microsoft Documentation}
1932
+ * @example
1933
+ * await clientClient.LoginWithPlayFab({
1934
+ * "Username": "theuser",
1935
+ * "Password": "ExampleSecret",
1936
+ * "TitleId": "144"
1937
+ * });
1938
+ */
1939
+ LoginWithPlayFab(request, extraHeaders) {
1940
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1941
+ if (!request.TitleId) throw this.errorTitleId;
1942
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1943
+ return this.ExecuteRequestWrapper("/Client/LoginWithPlayFab", request, null, extraHeaders).then((result) => {
1944
+ var _a;
1945
+ if (result) {
1946
+ if (result == null ? void 0 : result.SessionTicket) {
1947
+ this.sessionTicket = result.SessionTicket;
1948
+ }
1949
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1950
+ this.entityToken = result.EntityToken.EntityToken;
1951
+ }
1952
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1953
+ }
1954
+ return result;
1955
+ });
1956
+ }
1957
+ /**
1958
+ * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
1959
+ * subsequently be used for API calls which require an authenticated user
1960
+ *
1961
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn Microsoft Documentation}
1962
+ * @example
1963
+ * await clientClient.LoginWithPSN({
1964
+ * "AuthCode": "LKJ6D896D",
1965
+ * "RedirectUri": "orbis://games",
1966
+ * "CreateAccount": false,
1967
+ * "TitleId": "144"
1968
+ * });
1969
+ */
1970
+ LoginWithPSN(request, extraHeaders) {
1971
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1972
+ if (!request.TitleId) throw this.errorTitleId;
1973
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1974
+ return this.ExecuteRequestWrapper("/Client/LoginWithPSN", request, null, extraHeaders).then((result) => {
1975
+ var _a;
1976
+ if (result) {
1977
+ if (result == null ? void 0 : result.SessionTicket) {
1978
+ this.sessionTicket = result.SessionTicket;
1979
+ }
1980
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1981
+ this.entityToken = result.EntityToken.EntityToken;
1982
+ }
1983
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1984
+ }
1985
+ return result;
1986
+ });
1987
+ }
1988
+ /**
1989
+ * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
1990
+ * API calls which require an authenticated user
1991
+ *
1992
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam Microsoft Documentation}
1993
+ * @example
1994
+ * await clientClient.LoginWithSteam({
1995
+ * "SteamTicket": "steamTicketID",
1996
+ * "CreateAccount": false,
1997
+ * "TicketIsServiceSpecific": true,
1998
+ * "TitleId": "144"
1999
+ * });
2000
+ */
2001
+ LoginWithSteam(request, extraHeaders) {
2002
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
2003
+ if (!request.TitleId) throw this.errorTitleId;
2004
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
2005
+ return this.ExecuteRequestWrapper("/Client/LoginWithSteam", request, null, extraHeaders).then((result) => {
2006
+ var _a;
2007
+ if (result) {
2008
+ if (result == null ? void 0 : result.SessionTicket) {
2009
+ this.sessionTicket = result.SessionTicket;
2010
+ }
2011
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
2012
+ this.entityToken = result.EntityToken.EntityToken;
2013
+ }
2014
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
2015
+ }
2016
+ return result;
2017
+ });
2018
+ }
2019
+ /**
2020
+ * Signs the user in using a Twitch access token.
2021
+ *
2022
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch Microsoft Documentation}
2023
+ * @example
2024
+ * await clientClient.LoginWithTwitch({
2025
+ * "AccessToken": "SomeTwitchTokenHere",
2026
+ * "CreateAccount": false,
2027
+ * "TitleId": "144"
2028
+ * });
2029
+ */
2030
+ LoginWithTwitch(request, extraHeaders) {
2031
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
2032
+ if (!request.TitleId) throw this.errorTitleId;
2033
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
2034
+ return this.ExecuteRequestWrapper("/Client/LoginWithTwitch", request, null, extraHeaders).then((result) => {
2035
+ var _a;
2036
+ if (result) {
2037
+ if (result == null ? void 0 : result.SessionTicket) {
2038
+ this.sessionTicket = result.SessionTicket;
2039
+ }
2040
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
2041
+ this.entityToken = result.EntityToken.EntityToken;
2042
+ }
2043
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
2044
+ }
2045
+ return result;
2046
+ });
2047
+ }
2048
+ /**
2049
+ * Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
2050
+ * which require an authenticated user
2051
+ *
2052
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox Microsoft Documentation}
2053
+ * @example
2054
+ * await clientClient.LoginWithXbox({
2055
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
2056
+ * "CreateAccount": false,
2057
+ * "TitleId": "144"
2058
+ * });
2059
+ */
2060
+ LoginWithXbox(request, extraHeaders) {
2061
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
2062
+ if (!request.TitleId) throw this.errorTitleId;
2063
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
2064
+ return this.ExecuteRequestWrapper("/Client/LoginWithXbox", request, null, extraHeaders).then((result) => {
2065
+ var _a;
2066
+ if (result) {
2067
+ if (result == null ? void 0 : result.SessionTicket) {
2068
+ this.sessionTicket = result.SessionTicket;
2069
+ }
2070
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
2071
+ this.entityToken = result.EntityToken.EntityToken;
2072
+ }
2073
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
2074
+ }
2075
+ return result;
2076
+ });
2077
+ }
2078
+ /**
2079
+ * Attempts to locate a game session matching the given parameters. If the goal is to match the player into a specific
2080
+ * active session, only the LobbyId is required. Otherwise, the BuildVersion, GameMode, and Region are all required
2081
+ * parameters. Note that parameters specified in the search are required (they are not weighting factors). If a slot is
2082
+ * found in a server instance matching the parameters, the slot will be assigned to that player, removing it from the
2083
+ * availabe set. In that case, the information on the game session will be returned, otherwise the Status returned will be
2084
+ * GameNotFound.
2085
+ *
2086
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/matchmake Microsoft Documentation}
2087
+ * @deprecated Please use Match/CreateMatchmakingTicket instead.
2088
+ */
2089
+ Matchmake(request, extraHeaders) {
2090
+ return this.ExecuteRequestWrapper("/Client/Matchmake", request, "X-Authorization", extraHeaders);
2091
+ }
2092
+ /**
2093
+ * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
2094
+ *
2095
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade Microsoft Documentation}
2096
+ * @example
2097
+ * await clientClient.OpenTrade({
2098
+ * "OfferedInventoryInstanceIds": [
2099
+ * "1359447",
2100
+ * "635691"
2101
+ * ],
2102
+ * "RequestedCatalogItemIds": [
2103
+ * "rare_hat_7"
2104
+ * ]
2105
+ * });
2106
+ */
2107
+ OpenTrade(request, extraHeaders) {
2108
+ return this.ExecuteRequestWrapper("/Client/OpenTrade", request, "X-Authorization", extraHeaders);
2109
+ }
2110
+ /**
2111
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2112
+ * version 2._ Selects a payment option for purchase order created via StartPurchase
2113
+ *
2114
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase Microsoft Documentation}
2115
+ * @example
2116
+ * await clientClient.PayForPurchase({
2117
+ * "OrderId": "8853591446005860822",
2118
+ * "ProviderName": "PayPal",
2119
+ * "Currency": "RM"
2120
+ * });
2121
+ */
2122
+ PayForPurchase(request, extraHeaders) {
2123
+ return this.ExecuteRequestWrapper("/Client/PayForPurchase", request, "X-Authorization", extraHeaders);
2124
+ }
2125
+ /**
2126
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2127
+ * version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
2128
+ * well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
2129
+ *
2130
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem Microsoft Documentation}
2131
+ * @example
2132
+ * await clientClient.PurchaseItem({
2133
+ * "ItemId": "shield_level_5",
2134
+ * "VirtualCurrency": "GV",
2135
+ * "Price": 25
2136
+ * });
2137
+ */
2138
+ PurchaseItem(request, extraHeaders) {
2139
+ return this.ExecuteRequestWrapper("/Client/PurchaseItem", request, "X-Authorization", extraHeaders);
2140
+ }
2141
+ /**
2142
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2143
+ * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
2144
+ * Economy->Catalogs tab in the PlayFab Game Manager.
2145
+ *
2146
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon Microsoft Documentation}
2147
+ * @example
2148
+ * await clientClient.RedeemCoupon({
2149
+ * "CouponCode": "123-1234-123",
2150
+ * "CatalogVersion": "5"
2151
+ * });
2152
+ */
2153
+ RedeemCoupon(request, extraHeaders) {
2154
+ return this.ExecuteRequestWrapper("/Client/RedeemCoupon", request, "X-Authorization", extraHeaders);
2155
+ }
2156
+ /**
2157
+ * Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
2158
+ *
2159
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken Microsoft Documentation}
2160
+ * @example
2161
+ * await clientClient.RefreshPSNAuthToken({
2162
+ * "AuthCode": "LKJDG7DDE",
2163
+ * "RedirectUri": "orbis://games"
2164
+ * });
2165
+ */
2166
+ RefreshPSNAuthToken(request, extraHeaders) {
2167
+ return this.ExecuteRequestWrapper("/Client/RefreshPSNAuthToken", request, "X-Authorization", extraHeaders);
2168
+ }
2169
+ /**
2170
+ * Registers the iOS device to receive push notifications
2171
+ *
2172
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification Microsoft Documentation}
2173
+ * @example
2174
+ * await clientClient.RegisterForIOSPushNotification({
2175
+ * "DeviceToken": "39872f98eb882brn8hg3889",
2176
+ * "SendPushNotificationConfirmation": true,
2177
+ * "ConfirmationMessage": "Welcome to PlayFab"
2178
+ * });
2179
+ */
2180
+ RegisterForIOSPushNotification(request, extraHeaders) {
2181
+ return this.ExecuteRequestWrapper("/Client/RegisterForIOSPushNotification", request, "X-Authorization", extraHeaders);
2182
+ }
2183
+ /**
2184
+ * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
2185
+ * require an authenticated user. You must supply a username and an email address.
2186
+ *
2187
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser Microsoft Documentation}
2188
+ * @example
2189
+ * await clientClient.RegisterPlayFabUser({
2190
+ * "Username": "theuser",
2191
+ * "Email": "me@here.com",
2192
+ * "Password": "ExampleSecret",
2193
+ * "TitleId": "1"
2194
+ * });
2195
+ */
2196
+ RegisterPlayFabUser(request, extraHeaders) {
2197
+ request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
2198
+ if (!request.TitleId) throw this.errorTitleId;
2199
+ var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
2200
+ return this.ExecuteRequestWrapper("/Client/RegisterPlayFabUser", request, null, extraHeaders).then((result) => {
2201
+ var _a;
2202
+ if (result) {
2203
+ if (result == null ? void 0 : result.SessionTicket) {
2204
+ this.sessionTicket = result.SessionTicket;
2205
+ }
2206
+ if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
2207
+ this.entityToken = result.EntityToken.EntityToken;
2208
+ }
2209
+ authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
2210
+ }
2211
+ return result;
2212
+ });
2213
+ }
2214
+ /**
2215
+ * Removes a contact email from the player's profile.
2216
+ *
2217
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail Microsoft Documentation}
2218
+ * @example
2219
+ * await clientClient.RemoveContactEmail({});
2220
+ */
2221
+ RemoveContactEmail(request, extraHeaders) {
2222
+ return this.ExecuteRequestWrapper("/Client/RemoveContactEmail", request, "X-Authorization", extraHeaders);
2223
+ }
2224
+ /**
2225
+ * Removes a specified user from the friend list of the local user
2226
+ *
2227
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend Microsoft Documentation}
2228
+ * @example
2229
+ * await clientClient.RemoveFriend({
2230
+ * "FriendPlayFabId": "29837799"
2231
+ * });
2232
+ */
2233
+ RemoveFriend(request, extraHeaders) {
2234
+ return this.ExecuteRequestWrapper("/Client/RemoveFriend", request, "X-Authorization", extraHeaders);
2235
+ }
2236
+ /**
2237
+ * Removes the specified generic service identifier from the player's PlayFab account.
2238
+ *
2239
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid Microsoft Documentation}
2240
+ * @example
2241
+ * await clientClient.RemoveGenericID({
2242
+ * "GenericId": {
2243
+ * "ServiceName": "BigBizSocial",
2244
+ * "UserId": "1234567890"
2245
+ * }
2246
+ * });
2247
+ */
2248
+ RemoveGenericID(request, extraHeaders) {
2249
+ return this.ExecuteRequestWrapper("/Client/RemoveGenericID", request, "X-Authorization", extraHeaders);
2250
+ }
2251
+ /**
2252
+ * 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
2253
+ * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
2254
+ * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
2255
+ * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
2256
+ *
2257
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers Microsoft Documentation}
2258
+ * @example
2259
+ * await clientClient.RemoveSharedGroupMembers({
2260
+ * "SharedGroupId": "Clan Data",
2261
+ * "PlayFabIds": [
2262
+ * "D984A64B832",
2263
+ * "F74A523E1562"
2264
+ * ]
2265
+ * });
2266
+ */
2267
+ RemoveSharedGroupMembers(request, extraHeaders) {
2268
+ return this.ExecuteRequestWrapper("/Client/RemoveSharedGroupMembers", request, "X-Authorization", extraHeaders);
2269
+ }
2270
+ /**
2271
+ * Report player's ad activity
2272
+ *
2273
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity Microsoft Documentation}
2274
+ * @example
2275
+ * await clientClient.ReportAdActivity({
2276
+ * "PlacementId": "A124572382B",
2277
+ * "RewardId": "B2674981A",
2278
+ * "Activity": "End"
2279
+ * });
2280
+ */
2281
+ ReportAdActivity(request, extraHeaders) {
2282
+ return this.ExecuteRequestWrapper("/Client/ReportAdActivity", request, "X-Authorization", extraHeaders);
2283
+ }
2284
+ /**
2285
+ * Write a PlayStream event to describe the provided player device information. This API method is not designed to be
2286
+ * called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
2287
+ *
2288
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo Microsoft Documentation}
2289
+ * @example
2290
+ * await clientClient.ReportDeviceInfo({
2291
+ * "Info": {
2292
+ * "UserAgent": "Some Browser",
2293
+ * "ScreenResolution": "640x480",
2294
+ * "processorCount": "2"
2295
+ * }
2296
+ * });
2297
+ */
2298
+ ReportDeviceInfo(request, extraHeaders) {
2299
+ return this.ExecuteRequestWrapper("/Client/ReportDeviceInfo", request, "X-Authorization", extraHeaders);
2300
+ }
2301
+ /**
2302
+ * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
2303
+ * can take action concerning potentially toxic players.
2304
+ *
2305
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer Microsoft Documentation}
2306
+ * @example
2307
+ * await clientClient.ReportPlayer({
2308
+ * "ReporteeId": "1a46086aed40f142",
2309
+ * "Comment": "cheating"
2310
+ * });
2311
+ */
2312
+ ReportPlayer(request, extraHeaders) {
2313
+ return this.ExecuteRequestWrapper("/Client/ReportPlayer", request, "X-Authorization", extraHeaders);
2314
+ }
2315
+ /**
2316
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2317
+ * version 2._ Restores all in-app purchases based on the given restore receipt
2318
+ *
2319
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases Microsoft Documentation}
2320
+ * @example
2321
+ * await clientClient.RestoreIOSPurchases({
2322
+ * "ReceiptData": "F00000000000000000000"
2323
+ * });
2324
+ */
2325
+ RestoreIOSPurchases(request, extraHeaders) {
2326
+ return this.ExecuteRequestWrapper("/Client/RestoreIOSPurchases", request, "X-Authorization", extraHeaders);
2327
+ }
2328
+ /**
2329
+ * Reward player's ad activity
2330
+ *
2331
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity Microsoft Documentation}
2332
+ * @example
2333
+ * await clientClient.RewardAdActivity({
2334
+ * "PlacementId": "A124572382B",
2335
+ * "RewardId": "B2674981A"
2336
+ * });
2337
+ */
2338
+ RewardAdActivity(request, extraHeaders) {
2339
+ return this.ExecuteRequestWrapper("/Client/RewardAdActivity", request, "X-Authorization", extraHeaders);
2340
+ }
2341
+ /**
2342
+ * Triggers a particular server action, passing the provided inputs to the hosted Cloud Script. An action in this context
2343
+ * is a handler in the JavaScript. NOTE: Before calling this API, you must call GetCloudScriptUrl to be assigned a Cloud
2344
+ * Script server URL. When using an official PlayFab SDK, this URL is stored internally in the SDK, but GetCloudScriptUrl
2345
+ * must still be manually called.
2346
+ *
2347
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/runcloudscript Microsoft Documentation}
2348
+ * @deprecated Please use ExecuteCloudScript instead.
2349
+ */
2350
+ RunCloudScript(request, extraHeaders) {
2351
+ return this.ExecuteRequestWrapper("/Client/RunCloudScript", request, "X-Authorization", extraHeaders);
2352
+ }
2353
+ /**
2354
+ * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
2355
+ * change the password.If an account recovery email template ID is provided, an email using the custom email template will
2356
+ * be used.
2357
+ *
2358
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail Microsoft Documentation}
2359
+ * @example
2360
+ * await clientClient.SendAccountRecoveryEmail({
2361
+ * "Email": "Me@here.com",
2362
+ * "TitleId": "1000",
2363
+ * "EmailTemplateId": "D53AB15D8F12E330"
2364
+ * });
2365
+ */
2366
+ SendAccountRecoveryEmail(request, extraHeaders) {
2367
+ return this.ExecuteRequestWrapper("/Client/SendAccountRecoveryEmail", request, null, extraHeaders);
2368
+ }
2369
+ /**
2370
+ * Updates the tag list for a specified user in the friend list of the local user
2371
+ *
2372
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags Microsoft Documentation}
2373
+ * @example
2374
+ * await clientClient.SetFriendTags({
2375
+ * "FriendPlayFabId": "29837799",
2376
+ * "Tags": [
2377
+ * "great sniper",
2378
+ * "no good at melee"
2379
+ * ]
2380
+ * });
2381
+ */
2382
+ SetFriendTags(request, extraHeaders) {
2383
+ return this.ExecuteRequestWrapper("/Client/SetFriendTags", request, "X-Authorization", extraHeaders);
2384
+ }
2385
+ /**
2386
+ * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
2387
+ * secret use the Admin or Server API method SetPlayerSecret.
2388
+ *
2389
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret Microsoft Documentation}
2390
+ * @example
2391
+ * await clientClient.SetPlayerSecret({
2392
+ * "PlayerSecret": "A cryptographically strong string"
2393
+ * });
2394
+ */
2395
+ SetPlayerSecret(request, extraHeaders) {
2396
+ return this.ExecuteRequestWrapper("/Client/SetPlayerSecret", request, "X-Authorization", extraHeaders);
2397
+ }
2398
+ /**
2399
+ * Start a new game server with a given configuration, add the current player and return the connection information.
2400
+ *
2401
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/startgame Microsoft Documentation}
2402
+ * @deprecated Do not use
2403
+ */
2404
+ StartGame(request, extraHeaders) {
2405
+ return this.ExecuteRequestWrapper("/Client/StartGame", request, "X-Authorization", extraHeaders);
2406
+ }
2407
+ /**
2408
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2409
+ * version 2._ Creates an order for a list of items from the title catalog
2410
+ *
2411
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase Microsoft Documentation}
2412
+ * @example
2413
+ * await clientClient.StartPurchase({
2414
+ * "CatalogVersion": "0",
2415
+ * "StoreId": "BonusStore",
2416
+ * "Items": [
2417
+ * {
2418
+ * "ItemId": "something",
2419
+ * "Quantity": 1,
2420
+ * "Annotation": "totally buying something"
2421
+ * }
2422
+ * ]
2423
+ * });
2424
+ */
2425
+ StartPurchase(request, extraHeaders) {
2426
+ return this.ExecuteRequestWrapper("/Client/StartPurchase", request, "X-Authorization", extraHeaders);
2427
+ }
2428
+ /**
2429
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2430
+ * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
2431
+ * a VC balance negative with this API.
2432
+ *
2433
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
2434
+ * @example
2435
+ * await clientClient.SubtractUserVirtualCurrency({
2436
+ * "VirtualCurrency": "GC",
2437
+ * "Amount": 100
2438
+ * });
2439
+ */
2440
+ SubtractUserVirtualCurrency(request, extraHeaders) {
2441
+ return this.ExecuteRequestWrapper("/Client/SubtractUserVirtualCurrency", request, "X-Authorization", extraHeaders);
2442
+ }
2443
+ /**
2444
+ * Unlinks the related Android device identifier from the user's PlayFab account
2445
+ *
2446
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid Microsoft Documentation}
2447
+ * @example
2448
+ * await clientClient.UnlinkAndroidDeviceID({
2449
+ * "AndroidDeviceId": "526f79204261747479"
2450
+ * });
2451
+ */
2452
+ UnlinkAndroidDeviceID(request, extraHeaders) {
2453
+ return this.ExecuteRequestWrapper("/Client/UnlinkAndroidDeviceID", request, "X-Authorization", extraHeaders);
2454
+ }
2455
+ /**
2456
+ * Unlinks the related Apple account from the user's PlayFab account.
2457
+ *
2458
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple Microsoft Documentation}
2459
+ * @example
2460
+ * await clientClient.UnlinkApple({});
2461
+ */
2462
+ UnlinkApple(request, extraHeaders) {
2463
+ return this.ExecuteRequestWrapper("/Client/UnlinkApple", request, "X-Authorization", extraHeaders);
2464
+ }
2465
+ /**
2466
+ * Unlinks the related Battle.net account from the user's PlayFab account.
2467
+ *
2468
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount Microsoft Documentation}
2469
+ * @example
2470
+ * await clientClient.UnlinkBattleNetAccount({});
2471
+ */
2472
+ UnlinkBattleNetAccount(request, extraHeaders) {
2473
+ return this.ExecuteRequestWrapper("/Client/UnlinkBattleNetAccount", request, "X-Authorization", extraHeaders);
2474
+ }
2475
+ /**
2476
+ * Unlinks the related custom identifier from the user's PlayFab account
2477
+ *
2478
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid Microsoft Documentation}
2479
+ * @example
2480
+ * await clientClient.UnlinkCustomID({
2481
+ * "CustomId": "67AB-5397-CC54-EA31"
2482
+ * });
2483
+ */
2484
+ UnlinkCustomID(request, extraHeaders) {
2485
+ return this.ExecuteRequestWrapper("/Client/UnlinkCustomID", request, "X-Authorization", extraHeaders);
2486
+ }
2487
+ /**
2488
+ * Unlinks the related Facebook account from the user's PlayFab account
2489
+ *
2490
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount Microsoft Documentation}
2491
+ * @example
2492
+ * await clientClient.UnlinkFacebookAccount({});
2493
+ */
2494
+ UnlinkFacebookAccount(request, extraHeaders) {
2495
+ return this.ExecuteRequestWrapper("/Client/UnlinkFacebookAccount", request, "X-Authorization", extraHeaders);
2496
+ }
2497
+ /**
2498
+ * Unlinks the related Facebook Instant Game Ids from the user's PlayFab account
2499
+ *
2500
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid Microsoft Documentation}
2501
+ * @example
2502
+ * await clientClient.UnlinkFacebookInstantGamesId({
2503
+ * "FacebookInstantGamesId": "1114685845316173"
2504
+ * });
2505
+ */
2506
+ UnlinkFacebookInstantGamesId(request, extraHeaders) {
2507
+ return this.ExecuteRequestWrapper("/Client/UnlinkFacebookInstantGamesId", request, "X-Authorization", extraHeaders);
2508
+ }
2509
+ /**
2510
+ * Unlinks the related Game Center account from the user's PlayFab account
2511
+ *
2512
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount Microsoft Documentation}
2513
+ * @example
2514
+ * await clientClient.UnlinkGameCenterAccount({});
2515
+ */
2516
+ UnlinkGameCenterAccount(request, extraHeaders) {
2517
+ return this.ExecuteRequestWrapper("/Client/UnlinkGameCenterAccount", request, "X-Authorization", extraHeaders);
2518
+ }
2519
+ /**
2520
+ * Unlinks the related Google account from the user's PlayFab account
2521
+ * (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
2522
+ *
2523
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount Microsoft Documentation}
2524
+ * @example
2525
+ * await clientClient.UnlinkGoogleAccount({});
2526
+ */
2527
+ UnlinkGoogleAccount(request, extraHeaders) {
2528
+ return this.ExecuteRequestWrapper("/Client/UnlinkGoogleAccount", request, "X-Authorization", extraHeaders);
2529
+ }
2530
+ /**
2531
+ * Unlinks the related Google Play Games account from the user's PlayFab account.
2532
+ *
2533
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount Microsoft Documentation}
2534
+ * @example
2535
+ * await clientClient.UnlinkGooglePlayGamesServicesAccount({});
2536
+ */
2537
+ UnlinkGooglePlayGamesServicesAccount(request, extraHeaders) {
2538
+ return this.ExecuteRequestWrapper("/Client/UnlinkGooglePlayGamesServicesAccount", request, "X-Authorization", extraHeaders);
2539
+ }
2540
+ /**
2541
+ * Unlinks the related iOS device identifier from the user's PlayFab account
2542
+ *
2543
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid Microsoft Documentation}
2544
+ * @example
2545
+ * await clientClient.UnlinkIOSDeviceID({
2546
+ * "DeviceId": "29848d9bh8900a0b003"
2547
+ * });
2548
+ */
2549
+ UnlinkIOSDeviceID(request, extraHeaders) {
2550
+ return this.ExecuteRequestWrapper("/Client/UnlinkIOSDeviceID", request, "X-Authorization", extraHeaders);
2551
+ }
2552
+ /**
2553
+ * Unlinks the related Kongregate identifier from the user's PlayFab account
2554
+ *
2555
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate Microsoft Documentation}
2556
+ * @example
2557
+ * await clientClient.UnlinkKongregate({});
2558
+ */
2559
+ UnlinkKongregate(request, extraHeaders) {
2560
+ return this.ExecuteRequestWrapper("/Client/UnlinkKongregate", request, "X-Authorization", extraHeaders);
2561
+ }
2562
+ /**
2563
+ * Unlinks the related Nintendo account from the user's PlayFab account.
2564
+ *
2565
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount Microsoft Documentation}
2566
+ * @example
2567
+ * await clientClient.UnlinkNintendoServiceAccount({});
2568
+ */
2569
+ UnlinkNintendoServiceAccount(request, extraHeaders) {
2570
+ return this.ExecuteRequestWrapper("/Client/UnlinkNintendoServiceAccount", request, "X-Authorization", extraHeaders);
2571
+ }
2572
+ /**
2573
+ * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
2574
+ *
2575
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid Microsoft Documentation}
2576
+ * @example
2577
+ * await clientClient.UnlinkNintendoSwitchDeviceId({
2578
+ * "NintendoSwitchDeviceId": "526f79204261747479"
2579
+ * });
2580
+ */
2581
+ UnlinkNintendoSwitchDeviceId(request, extraHeaders) {
2582
+ return this.ExecuteRequestWrapper("/Client/UnlinkNintendoSwitchDeviceId", request, "X-Authorization", extraHeaders);
2583
+ }
2584
+ /**
2585
+ * Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
2586
+ * between a title and an Open ID Connect provider.
2587
+ *
2588
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect Microsoft Documentation}
2589
+ * @example
2590
+ * await clientClient.UnlinkOpenIdConnect({
2591
+ * "ConnectionId": "exampleprovider"
2592
+ * });
2593
+ */
2594
+ UnlinkOpenIdConnect(request, extraHeaders) {
2595
+ return this.ExecuteRequestWrapper("/Client/UnlinkOpenIdConnect", request, "X-Authorization", extraHeaders);
2596
+ }
2597
+ /**
2598
+ * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
2599
+ *
2600
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount Microsoft Documentation}
2601
+ * @example
2602
+ * await clientClient.UnlinkPSNAccount({});
2603
+ */
2604
+ UnlinkPSNAccount(request, extraHeaders) {
2605
+ return this.ExecuteRequestWrapper("/Client/UnlinkPSNAccount", request, "X-Authorization", extraHeaders);
2606
+ }
2607
+ /**
2608
+ * Unlinks the related Steam account from the user's PlayFab account
2609
+ *
2610
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount Microsoft Documentation}
2611
+ * @example
2612
+ * await clientClient.UnlinkSteamAccount({});
2613
+ */
2614
+ UnlinkSteamAccount(request, extraHeaders) {
2615
+ return this.ExecuteRequestWrapper("/Client/UnlinkSteamAccount", request, "X-Authorization", extraHeaders);
2616
+ }
2617
+ /**
2618
+ * Unlinks the related Twitch account from the user's PlayFab account.
2619
+ *
2620
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch Microsoft Documentation}
2621
+ * @example
2622
+ * await clientClient.UnlinkTwitch({});
2623
+ */
2624
+ UnlinkTwitch(request, extraHeaders) {
2625
+ return this.ExecuteRequestWrapper("/Client/UnlinkTwitch", request, "X-Authorization", extraHeaders);
2626
+ }
2627
+ /**
2628
+ * Unlinks the related Xbox Live account from the user's PlayFab account
2629
+ *
2630
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount Microsoft Documentation}
2631
+ * @example
2632
+ * await clientClient.UnlinkXboxAccount({});
2633
+ */
2634
+ UnlinkXboxAccount(request, extraHeaders) {
2635
+ return this.ExecuteRequestWrapper("/Client/UnlinkXboxAccount", request, "X-Authorization", extraHeaders);
2636
+ }
2637
+ /**
2638
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2639
+ * version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
2640
+ * opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will
2641
+ * be decremented, consistent with the operation of ConsumeItem.
2642
+ *
2643
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance Microsoft Documentation}
2644
+ * @example
2645
+ * await clientClient.UnlockContainerInstance({
2646
+ * "ContainerItemInstanceId": "123456788",
2647
+ * "KeyItemInstanceId": "123456789"
2648
+ * });
2649
+ */
2650
+ UnlockContainerInstance(request, extraHeaders) {
2651
+ return this.ExecuteRequestWrapper("/Client/UnlockContainerInstance", request, "X-Authorization", extraHeaders);
2652
+ }
2653
+ /**
2654
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2655
+ * version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
2656
+ * using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are
2657
+ * consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
2658
+ *
2659
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem Microsoft Documentation}
2660
+ * @example
2661
+ * await clientClient.UnlockContainerItem({
2662
+ * "ContainerItemId": "crate block 1"
2663
+ * });
2664
+ */
2665
+ UnlockContainerItem(request, extraHeaders) {
2666
+ return this.ExecuteRequestWrapper("/Client/UnlockContainerItem", request, "X-Authorization", extraHeaders);
2667
+ }
2668
+ /**
2669
+ * Update the avatar URL of the player
2670
+ *
2671
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl Microsoft Documentation}
2672
+ * @example
2673
+ * await clientClient.UpdateAvatarUrl({
2674
+ * "ImageUrl": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
2675
+ * });
2676
+ */
2677
+ UpdateAvatarUrl(request, extraHeaders) {
2678
+ return this.ExecuteRequestWrapper("/Client/UpdateAvatarUrl", request, "X-Authorization", extraHeaders);
2679
+ }
2680
+ /**
2681
+ * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
2682
+ *
2683
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata Microsoft Documentation}
2684
+ * @example
2685
+ * await clientClient.UpdateCharacterData({
2686
+ * "CharacterId": "98765456",
2687
+ * "Data": {
2688
+ * "Class": "Fighter",
2689
+ * "Gender": "Female",
2690
+ * "Icon": "Guard 3",
2691
+ * "Theme": "Colorful"
2692
+ * },
2693
+ * "Permission": "Public"
2694
+ * });
2695
+ */
2696
+ UpdateCharacterData(request, extraHeaders) {
2697
+ return this.ExecuteRequestWrapper("/Client/UpdateCharacterData", request, "X-Authorization", extraHeaders);
2698
+ }
2699
+ /**
2700
+ * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
2701
+ * permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
2702
+ *
2703
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics Microsoft Documentation}
2704
+ * @example
2705
+ * await clientClient.UpdateCharacterStatistics({
2706
+ * "CharacterId": "98765432",
2707
+ * "CharacterStatistics": {
2708
+ * "Headshots": 18,
2709
+ * "Kills": 47
2710
+ * }
2711
+ * });
2712
+ */
2713
+ UpdateCharacterStatistics(request, extraHeaders) {
2714
+ return this.ExecuteRequestWrapper("/Client/UpdateCharacterStatistics", request, "X-Authorization", extraHeaders);
2715
+ }
2716
+ /**
2717
+ * Updates the title-specific custom property values for a player
2718
+ *
2719
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties Microsoft Documentation}
2720
+ * @example
2721
+ * await clientClient.UpdatePlayerCustomProperties({
2722
+ * "Properties": [
2723
+ * {
2724
+ * "Name": "level",
2725
+ * "Value": 5
2726
+ * },
2727
+ * {
2728
+ * "Name": "created",
2729
+ * "Value": false
2730
+ * }
2731
+ * ],
2732
+ * "ExpectedPropertiesVersion": 12
2733
+ * });
2734
+ */
2735
+ UpdatePlayerCustomProperties(request, extraHeaders) {
2736
+ return this.ExecuteRequestWrapper("/Client/UpdatePlayerCustomProperties", request, "X-Authorization", extraHeaders);
2737
+ }
2738
+ /**
2739
+ * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
2740
+ * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
2741
+ *
2742
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics Microsoft Documentation}
2743
+ * @example
2744
+ * await clientClient.UpdatePlayerStatistics({
2745
+ * "Statistics": [
2746
+ * {
2747
+ * "StatisticName": "Points",
2748
+ * "Version": 1,
2749
+ * "Value": 600
2750
+ * },
2751
+ * {
2752
+ * "StatisticName": "Wins",
2753
+ * "Version": 0,
2754
+ * "Value": 16
2755
+ * },
2756
+ * {
2757
+ * "StatisticName": "Stars",
2758
+ * "Value": 7
2759
+ * }
2760
+ * ]
2761
+ * });
2762
+ */
2763
+ UpdatePlayerStatistics(request, extraHeaders) {
2764
+ return this.ExecuteRequestWrapper("/Client/UpdatePlayerStatistics", request, "X-Authorization", extraHeaders);
2765
+ }
2766
+ /**
2767
+ * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
2768
+ * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
2769
+ * Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for
2770
+ * sharing data between a very small number of players, please see our guide:
2771
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
2772
+ *
2773
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata Microsoft Documentation}
2774
+ * @example
2775
+ * await clientClient.UpdateSharedGroupData({
2776
+ * "SharedGroupId": "Clan Data",
2777
+ * "Data": {
2778
+ * "ClanKills": "34",
2779
+ * "LastClanUpdate": "2014-10-03T09:21:14Z"
2780
+ * },
2781
+ * "Permission": "Public"
2782
+ * });
2783
+ */
2784
+ UpdateSharedGroupData(request, extraHeaders) {
2785
+ return this.ExecuteRequestWrapper("/Client/UpdateSharedGroupData", request, "X-Authorization", extraHeaders);
2786
+ }
2787
+ /**
2788
+ * Creates and updates the title-specific custom data for the user which is readable and writable by the client
2789
+ *
2790
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata Microsoft Documentation}
2791
+ * @example
2792
+ * await clientClient.UpdateUserData({
2793
+ * "Data": {
2794
+ * "Class": "Fighter",
2795
+ * "Gender": "Female",
2796
+ * "Icon": "Guard 3",
2797
+ * "Theme": "Colorful"
2798
+ * },
2799
+ * "Permission": "Public"
2800
+ * });
2801
+ */
2802
+ UpdateUserData(request, extraHeaders) {
2803
+ return this.ExecuteRequestWrapper("/Client/UpdateUserData", request, "X-Authorization", extraHeaders);
2804
+ }
2805
+ /**
2806
+ * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client
2807
+ *
2808
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata Microsoft Documentation}
2809
+ * @example
2810
+ * await clientClient.UpdateUserPublisherData({
2811
+ * "Data": {
2812
+ * "Class": "Fighter",
2813
+ * "Gender": "Female",
2814
+ * "Icon": "Guard 3",
2815
+ * "Theme": "Colorful"
2816
+ * },
2817
+ * "Permission": "Public"
2818
+ * });
2819
+ */
2820
+ UpdateUserPublisherData(request, extraHeaders) {
2821
+ return this.ExecuteRequestWrapper("/Client/UpdateUserPublisherData", request, "X-Authorization", extraHeaders);
2822
+ }
2823
+ /**
2824
+ * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
2825
+ * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
2826
+ *
2827
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserstatistics Microsoft Documentation}
2828
+ * @deprecated Please use UpdatePlayerStatistics instead.
2829
+ */
2830
+ UpdateUserStatistics(request, extraHeaders) {
2831
+ return this.ExecuteRequestWrapper("/Client/UpdateUserStatistics", request, "X-Authorization", extraHeaders);
2832
+ }
2833
+ /**
2834
+ * Updates the title specific display name for the user
2835
+ *
2836
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname Microsoft Documentation}
2837
+ * @example
2838
+ * await clientClient.UpdateUserTitleDisplayName({
2839
+ * "DisplayName": "User Title Name"
2840
+ * });
2841
+ */
2842
+ UpdateUserTitleDisplayName(request, extraHeaders) {
2843
+ return this.ExecuteRequestWrapper("/Client/UpdateUserTitleDisplayName", request, "X-Authorization", extraHeaders);
2844
+ }
2845
+ /**
2846
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2847
+ * version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
2848
+ * the purchased catalog item
2849
+ *
2850
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt Microsoft Documentation}
2851
+ * @example
2852
+ * await clientClient.ValidateAmazonIAPReceipt({
2853
+ * "ReceiptId": "q1YqVbJSyjH28DGPKChw9c0o8nd3vSstssQtzSkrzM8tCk43K6z0d_HOTcwwN8vxCrVV0lEqBmpJzs_VK8hJrExLTNLLTCzQK8_MSUnJTy8LSpcoWRnoKKUAFRmaGBtZmBqCCFMzpVoA",
2854
+ * "UserId": "l3HL7XppEMhrOGDgur9-ulvqomrSg6qyODKmah72lJU="
2855
+ * });
2856
+ */
2857
+ ValidateAmazonIAPReceipt(request, extraHeaders) {
2858
+ return this.ExecuteRequestWrapper("/Client/ValidateAmazonIAPReceipt", request, "X-Authorization", extraHeaders);
2859
+ }
2860
+ /**
2861
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2862
+ * version 2._ Validates a Google Play purchase and gives the corresponding item to the player.
2863
+ *
2864
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase Microsoft Documentation}
2865
+ * @example
2866
+ * await clientClient.ValidateGooglePlayPurchase({
2867
+ * "ReceiptJson": "{\"orderId\":\"12999763169054705758.1375794066587622\",\"packageName\":\"com.playfab.android.testbed\",\"productId\":\"com.playfab.android.permatest.consumable\",\"purchaseTime\":1410891177231,\"purchaseState\":0,\"purchaseToken\":\"eaflhokdkobkmomjadmoobgb.AO-J1OwoLkW2cqvBcPEgk6SfGceQpOHALMUFmJYeawa-GuDFtl3oKct-5D28t_KvNscFiJOFiWXIS74vJBYg-CGFJgyrdbxalKEMPzXZrg5nLomCME-jIVFAUrzcPah-_66KPImG5ftsMJKI9uzldqEF9OPcakUEmt-kWoXAsl_6-9HH0gBCwh4\"}",
2868
+ * "Signature": "ks12w0hHHpuit4xW3Fyoa5XX6TkxZ2KpEnBsLfpHHpeakYs2JgVtlLdgyLp/05Zp8oHAuKZyIAJTd2RIFXWMAUwDNUsI0JPBDMpr2oaL66Kuneg4VrGWJkJZTrvTyQoGpnTDdXfEME31iFKX6CrKHvWlAG9nwWxYatd58l83eevQ8CIrJhka/bC5ynw3j18OmFG7AcxymO37a4HkM8QjytvAYDJeOnDU9mooY7afcHIajtffdyAU9kzGWOqDByiU9IsRdkliwQoQYbuX/R5wQnMVZ+FGDDwO1mybx9B20rm7/WCBnWGy2NLsSAFI77iX8tUy/QebfBQhrVnRORi7bw==",
2869
+ * "CurrencyCode": "USD",
2870
+ * "PurchasePrice": 199
2871
+ * });
2872
+ */
2873
+ ValidateGooglePlayPurchase(request, extraHeaders) {
2874
+ return this.ExecuteRequestWrapper("/Client/ValidateGooglePlayPurchase", request, "X-Authorization", extraHeaders);
2875
+ }
2876
+ /**
2877
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2878
+ * version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
2879
+ * purchased catalog item
2880
+ *
2881
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt Microsoft Documentation}
2882
+ * @example
2883
+ * await clientClient.ValidateIOSReceipt({
2884
+ * "ReceiptData": "MTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nzc3Nw0KODgNCjk5OTk5OTk5OTk5OQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nw0KODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODgNCjkNCkFwcGxlIEluYy4gV29ybGR3aWRlIERldmVsb3BlciBSZWxhdGlvbnMgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgKG5vdCByZWFsbHkgLSBmYWtlIFBsYXlGYWIgZXhhbXBsZSwgYnV0IGNvbmdyYXRzIG9uIHRoaW5raW5nIHRvIGRlY29kZSB0aGlzISkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3Nzc3DQo4OA0KOTk5OTk5OTk5OTk5DQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3DQo4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4OA0KOQ0KQXBwbGUgSW5jLiBXb3JsZHdpZGUgRGV2ZWxvcGVyIFJlbGF0aW9ucyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAobm90IHJlYWxseSAtIGZha2UgUGxheUZhYiBleGFtcGxlLCBidXQgY29uZ3JhdHMgb24gdGhpbmtpbmcgdG8gZGVjb2RlIHRoaXMhKQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw",
2885
+ * "CurrencyCode": "GBP",
2886
+ * "PurchasePrice": 199
2887
+ * });
2888
+ */
2889
+ ValidateIOSReceipt(request, extraHeaders) {
2890
+ return this.ExecuteRequestWrapper("/Client/ValidateIOSReceipt", request, "X-Authorization", extraHeaders);
2891
+ }
2892
+ /**
2893
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
2894
+ * version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
2895
+ * matches the purchased catalog item
2896
+ *
2897
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt Microsoft Documentation}
2898
+ * @example
2899
+ * await clientClient.ValidateWindowsStoreReceipt({
2900
+ * "Receipt": "<Receipt Version=\"1.0\" ReceiptDate=\"2012-08-30T23:10:05Z\" CertificateId=\"b809e47cd0110a4db043b3f73e83acd917fe1336\" ReceiptDeviceId=\"4e362949-acc3-fe3a-e71b-89893eb4f528\">\r\n <AppReceipt Id=\"8ffa256d-eca8-712a-7cf8-cbf5522df24b\" AppId=\"55428GreenlakeApps.CurrentAppSimulatorEventTest_z7q3q7z11crfr\" PurchaseDate=\"2012-06-04T23:07:24Z\" LicenseType=\"Full\" />\r\n <ProductReceipt Id=\"6bbf4366-6fb2-8be8-7947-92fd5f683530\" ProductId=\"Product1\" PurchaseDate=\"2012-08-30T23:08:52Z\" ExpirationDate=\"2012-09-02T23:08:49Z\" ProductType=\"Durable\" AppId=\"55428GreenlakeApps.CurrentAppSimulatorEventTest_z7q3q7z11crfr\" />\r\n <Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\">\r\n <SignedInfo>\r\n <CanonicalizationMethod Algorithm=\"http://www.w3.org/2001/10/xml-exc-c14n#\" />\r\n <SignatureMethod Algorithm=\"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\" />\r\n <Reference URI=\"\">\r\n <Transforms>\r\n <Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\" />\r\n </Transforms>\r\n <DigestMethod Algorithm=\"http://www.w3.org/2001/04/xmlenc#sha256\" />\r\n <DigestValue>cdiU06eD8X/w1aGCHeaGCG9w/kWZ8I099rw4mmPpvdU=</DigestValue>\r\n </Reference>\r\n </SignedInfo>\r\n <SignatureValue>SjRIxS/2r2P6ZdgaR9bwUSa6ZItYYFpKLJZrnAa3zkMylbiWjh9oZGGng2p6/gtBHC2dSTZlLbqnysJjl7mQp/A3wKaIkzjyRXv3kxoVaSV0pkqiPt04cIfFTP0JZkE5QD/vYxiWjeyGp1dThEM2RV811sRWvmEs/hHhVxb32e8xCLtpALYx3a9lW51zRJJN0eNdPAvNoiCJlnogAoTToUQLHs72I1dECnSbeNPXiG7klpy5boKKMCZfnVXXkneWvVFtAA1h2sB7ll40LEHO4oYN6VzD+uKd76QOgGmsu9iGVyRvvmMtahvtL1/pxoxsTRedhKq6zrzCfT8qfh3C1w==</SignatureValue>\r\n </Signature>\r\n</Receipt>\r\n"
2901
+ * });
2902
+ */
2903
+ ValidateWindowsStoreReceipt(request, extraHeaders) {
2904
+ return this.ExecuteRequestWrapper("/Client/ValidateWindowsStoreReceipt", request, "X-Authorization", extraHeaders);
2905
+ }
2906
+ /**
2907
+ * Writes a character-based event into PlayStream.
2908
+ *
2909
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent Microsoft Documentation}
2910
+ * @example
2911
+ * await clientClient.WriteCharacterEvent({
2912
+ * "CharacterId": "E161CB4B7F6C34B",
2913
+ * "EventName": "character_defeated_enemy",
2914
+ * "Timestamp": "2016-03-07T00:00:00Z",
2915
+ * "Body": {
2916
+ * "Enemy": "guardian",
2917
+ * "Damage": 5,
2918
+ * "Coordinates": {
2919
+ * "X": 123.4,
2920
+ * "Y": 543.2
2921
+ * }
2922
+ * }
2923
+ * });
2924
+ */
2925
+ WriteCharacterEvent(request, extraHeaders) {
2926
+ return this.ExecuteRequestWrapper("/Client/WriteCharacterEvent", request, "X-Authorization", extraHeaders);
2927
+ }
2928
+ /**
2929
+ * Writes a player-based event into PlayStream.
2930
+ *
2931
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent Microsoft Documentation}
2932
+ * @example
2933
+ * await clientClient.WritePlayerEvent({
2934
+ * "EventName": "player_defeated_enemy",
2935
+ * "Timestamp": "2014-03-07T00:00:00Z",
2936
+ * "Body": {
2937
+ * "Enemy": "guardian",
2938
+ * "Damage": 5,
2939
+ * "Coordinates": {
2940
+ * "X": 123.4,
2941
+ * "Y": 543.2
2942
+ * }
2943
+ * }
2944
+ * });
2945
+ */
2946
+ WritePlayerEvent(request, extraHeaders) {
2947
+ return this.ExecuteRequestWrapper("/Client/WritePlayerEvent", request, "X-Authorization", extraHeaders);
2948
+ }
2949
+ /**
2950
+ * Writes a title-based event into PlayStream.
2951
+ *
2952
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent Microsoft Documentation}
2953
+ * @example
2954
+ * await clientClient.WriteTitleEvent({
2955
+ * "EventName": "client_update_submitted",
2956
+ * "Timestamp": "2016-03-07T00:00:00Z",
2957
+ * "Body": {
2958
+ * "Version": "1.4.50"
2959
+ * }
2960
+ * });
2961
+ */
2962
+ WriteTitleEvent(request, extraHeaders) {
2963
+ return this.ExecuteRequestWrapper("/Client/WriteTitleEvent", request, "X-Authorization", extraHeaders);
2964
+ }
2965
+ };
2966
+
2967
+ export {
2968
+ PlayFabClientApi
2969
+ };
2970
+ //# sourceMappingURL=chunk-5LPKBU65.js.map