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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/dist/Addon.d.ts +178 -38
  2. package/dist/Addon.js +2 -2
  3. package/dist/Admin.d.ts +2385 -194
  4. package/dist/Admin.js +2 -2
  5. package/dist/Authentication.d.ts +31 -4
  6. package/dist/Authentication.js +2 -2
  7. package/dist/Client.d.ts +2234 -320
  8. package/dist/Client.js +2 -2
  9. package/dist/CloudScript.d.ts +198 -30
  10. package/dist/CloudScript.js +2 -2
  11. package/dist/Data.d.ts +136 -17
  12. package/dist/Data.js +2 -2
  13. package/dist/Economy.d.ts +1145 -106
  14. package/dist/Economy.js +2 -2
  15. package/dist/Events.d.ts +199 -12
  16. package/dist/Events.js +2 -2
  17. package/dist/Experimentation.d.ts +163 -16
  18. package/dist/Experimentation.js +2 -2
  19. package/dist/Groups.d.ts +266 -27
  20. package/dist/Groups.js +2 -2
  21. package/dist/Insights.d.ts +32 -6
  22. package/dist/Insights.js +2 -2
  23. package/dist/Localization.d.ts +4 -1
  24. package/dist/Localization.js +2 -2
  25. package/dist/Matchmaker.d.ts +271 -0
  26. package/dist/Matchmaker.js +8 -0
  27. package/dist/Matchmaker.js.map +1 -0
  28. package/dist/Multiplayer.d.ts +2696 -168
  29. package/dist/Multiplayer.js +2 -2
  30. package/dist/Profiles.d.ts +162 -18
  31. package/dist/Profiles.js +2 -2
  32. package/dist/Progression.d.ts +286 -34
  33. package/dist/Progression.js +2 -2
  34. package/dist/Server.d.ts +1903 -241
  35. package/dist/Server.js +2 -2
  36. package/dist/chunk-3I6ONUUQ.js +237 -0
  37. package/dist/chunk-3I6ONUUQ.js.map +1 -0
  38. package/dist/chunk-3O5QT4SL.js +2477 -0
  39. package/dist/chunk-3O5QT4SL.js.map +1 -0
  40. package/dist/chunk-3OBHYLBF.js +2673 -0
  41. package/dist/chunk-3OBHYLBF.js.map +1 -0
  42. package/dist/chunk-57KYHGBO.js +421 -0
  43. package/dist/chunk-57KYHGBO.js.map +1 -0
  44. package/dist/{chunk-CLMINF57.js → chunk-5CWZN75H.js} +6 -3
  45. package/dist/chunk-5CWZN75H.js.map +1 -0
  46. package/dist/chunk-73SVDH45.js +197 -0
  47. package/dist/chunk-73SVDH45.js.map +1 -0
  48. package/dist/chunk-ADHTNFTN.js +175 -0
  49. package/dist/chunk-ADHTNFTN.js.map +1 -0
  50. package/dist/chunk-C7U2JQNZ.js +76 -0
  51. package/dist/chunk-C7U2JQNZ.js.map +1 -0
  52. package/dist/{chunk-PXPOK2QU.js → chunk-GAZYZIK2.js} +34 -8
  53. package/dist/chunk-GAZYZIK2.js.map +1 -0
  54. package/dist/chunk-J54WY4UN.js +413 -0
  55. package/dist/chunk-J54WY4UN.js.map +1 -0
  56. package/dist/chunk-NFWQ4MMZ.js +1048 -0
  57. package/dist/chunk-NFWQ4MMZ.js.map +1 -0
  58. package/dist/{chunk-7UQYMDJQ.js → chunk-P7UVG26J.js} +167 -32
  59. package/dist/chunk-P7UVG26J.js.map +1 -0
  60. package/dist/chunk-PFXZB4UN.js +2387 -0
  61. package/dist/chunk-PFXZB4UN.js.map +1 -0
  62. package/dist/{chunk-RJPMKD7P.js → chunk-QNGQW3YB.js} +28 -6
  63. package/dist/chunk-QNGQW3YB.js.map +1 -0
  64. package/dist/chunk-SQWILU5T.js +270 -0
  65. package/dist/chunk-SQWILU5T.js.map +1 -0
  66. package/dist/{chunk-FEEE3PRD.js → chunk-SR2RIRLX.js} +1482 -175
  67. package/dist/chunk-SR2RIRLX.js.map +1 -0
  68. package/dist/{chunk-6TH6EJYH.js → chunk-XVDYM74A.js} +4 -4
  69. package/dist/chunk-XVDYM74A.js.map +1 -0
  70. package/dist/chunk-ZW4TJ3MQ.js +225 -0
  71. package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
  72. package/dist/index.d.ts +6 -5
  73. package/dist/index.js +29 -25
  74. package/package.json +2 -2
  75. package/dist/chunk-2IBLMNAQ.js +0 -882
  76. package/dist/chunk-2IBLMNAQ.js.map +0 -1
  77. package/dist/chunk-3TRLETD6.js +0 -119
  78. package/dist/chunk-3TRLETD6.js.map +0 -1
  79. package/dist/chunk-4LT3OUQD.js +0 -632
  80. package/dist/chunk-4LT3OUQD.js.map +0 -1
  81. package/dist/chunk-6TH6EJYH.js.map +0 -1
  82. package/dist/chunk-7UQYMDJQ.js.map +0 -1
  83. package/dist/chunk-CLMINF57.js.map +0 -1
  84. package/dist/chunk-F5NRBD4O.js +0 -174
  85. package/dist/chunk-F5NRBD4O.js.map +0 -1
  86. package/dist/chunk-FEEE3PRD.js.map +0 -1
  87. package/dist/chunk-HKZJ4H4O.js +0 -97
  88. package/dist/chunk-HKZJ4H4O.js.map +0 -1
  89. package/dist/chunk-NJQCK4TL.js +0 -61
  90. package/dist/chunk-NJQCK4TL.js.map +0 -1
  91. package/dist/chunk-ONCBQLGS.js +0 -1147
  92. package/dist/chunk-ONCBQLGS.js.map +0 -1
  93. package/dist/chunk-PXPOK2QU.js.map +0 -1
  94. package/dist/chunk-Q22JHX4G.js +0 -76
  95. package/dist/chunk-Q22JHX4G.js.map +0 -1
  96. package/dist/chunk-RJPMKD7P.js.map +0 -1
  97. package/dist/chunk-WROXLFDZ.js +0 -103
  98. package/dist/chunk-WROXLFDZ.js.map +0 -1
  99. package/dist/chunk-XAI5IWL4.js +0 -187
  100. package/dist/chunk-XAI5IWL4.js.map +0 -1
  101. package/dist/chunk-XM26BUTO.js +0 -384
  102. package/dist/chunk-XM26BUTO.js.map +0 -1
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  PlayFabCommon
3
- } from "./chunk-6TH6EJYH.js";
3
+ } from "./chunk-XVDYM74A.js";
4
4
 
5
5
  // src/apis/PlayFabClientApi.ts
6
6
  var PlayFabClientApi = class extends PlayFabCommon {
@@ -11,7 +11,17 @@ var PlayFabClientApi = class extends PlayFabCommon {
11
11
  * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
12
12
  * allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
13
13
  * items will be swapped between the two players' inventories.
14
- * https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade
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
+ * });
15
25
  */
16
26
  AcceptTrade(request, extraHeaders) {
17
27
  return this.ExecuteRequestWrapper("/Client/AcceptTrade", request, "X-Authorization", extraHeaders);
@@ -19,7 +29,12 @@ var PlayFabClientApi = class extends PlayFabCommon {
19
29
  /**
20
30
  * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
21
31
  * least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
22
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
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
+ * });
23
38
  */
24
39
  AddFriend(request, extraHeaders) {
25
40
  return this.ExecuteRequestWrapper("/Client/AddFriend", request, "X-Authorization", extraHeaders);
@@ -28,14 +43,27 @@ var PlayFabClientApi = class extends PlayFabCommon {
28
43
  * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
29
44
  * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
30
45
  * authentication credentials, as the intent is that it is easily accessible by other players.
31
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid
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
+ * });
32
55
  */
33
56
  AddGenericID(request, extraHeaders) {
34
57
  return this.ExecuteRequestWrapper("/Client/AddGenericID", request, "X-Authorization", extraHeaders);
35
58
  }
36
59
  /**
37
60
  * Adds or updates a contact email to the player's profile.
38
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
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
+ * });
39
67
  */
40
68
  AddOrUpdateContactEmail(request, extraHeaders) {
41
69
  return this.ExecuteRequestWrapper("/Client/AddOrUpdateContactEmail", request, "X-Authorization", extraHeaders);
@@ -44,7 +72,16 @@ var PlayFabClientApi = class extends PlayFabCommon {
44
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
45
73
  * in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
46
74
  * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
47
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers
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
+ * });
48
85
  */
49
86
  AddSharedGroupMembers(request, extraHeaders) {
50
87
  return this.ExecuteRequestWrapper("/Client/AddSharedGroupMembers", request, "X-Authorization", extraHeaders);
@@ -52,7 +89,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
52
89
  /**
53
90
  * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
54
91
  * ID login.
55
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
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
+ * });
56
100
  */
57
101
  AddUsernamePassword(request, extraHeaders) {
58
102
  return this.ExecuteRequestWrapper("/Client/AddUsernamePassword", request, "X-Authorization", extraHeaders);
@@ -60,21 +104,39 @@ var PlayFabClientApi = class extends PlayFabCommon {
60
104
  /**
61
105
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
62
106
  * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
63
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency
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
+ * });
64
114
  */
65
115
  AddUserVirtualCurrency(request, extraHeaders) {
66
116
  return this.ExecuteRequestWrapper("/Client/AddUserVirtualCurrency", request, "X-Authorization", extraHeaders);
67
117
  }
68
118
  /**
69
119
  * Registers the Android device to receive push notifications
70
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
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
+ * });
71
128
  */
72
129
  AndroidDevicePushNotificationRegistration(request, extraHeaders) {
73
130
  return this.ExecuteRequestWrapper("/Client/AndroidDevicePushNotificationRegistration", request, "X-Authorization", extraHeaders);
74
131
  }
75
132
  /**
76
133
  * Attributes an install for advertisment.
77
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
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
+ * });
78
140
  */
79
141
  AttributeInstall(request, extraHeaders) {
80
142
  return this.ExecuteRequestWrapper("/Client/AttributeInstall", request, "X-Authorization", extraHeaders);
@@ -83,7 +145,12 @@ var PlayFabClientApi = class extends PlayFabCommon {
83
145
  * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
84
146
  * can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
85
147
  * players from accepting them, for trades that can be claimed by more than one player).
86
- * https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade
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
+ * });
87
154
  */
88
155
  CancelTrade(request, extraHeaders) {
89
156
  return this.ExecuteRequestWrapper("/Client/CancelTrade", request, "X-Authorization", extraHeaders);
@@ -92,7 +159,12 @@ var PlayFabClientApi = class extends PlayFabCommon {
92
159
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
93
160
  * version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
94
161
  * virtual currency balances as appropriate
95
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
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
+ * });
96
168
  */
97
169
  ConfirmPurchase(request, extraHeaders) {
98
170
  return this.ExecuteRequestWrapper("/Client/ConfirmPurchase", request, "X-Authorization", extraHeaders);
@@ -101,14 +173,30 @@ var PlayFabClientApi = class extends PlayFabCommon {
101
173
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
102
174
  * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
103
175
  * inventory.
104
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
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
+ * });
105
183
  */
106
184
  ConsumeItem(request, extraHeaders) {
107
185
  return this.ExecuteRequestWrapper("/Client/ConsumeItem", request, "X-Authorization", extraHeaders);
108
186
  }
109
187
  /**
110
188
  * Grants the player's current entitlements from Microsoft Store's Collection API
111
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements
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
+ * });
112
200
  */
113
201
  ConsumeMicrosoftStoreEntitlements(request, extraHeaders) {
114
202
  return this.ExecuteRequestWrapper("/Client/ConsumeMicrosoftStoreEntitlements", request, "X-Authorization", extraHeaders);
@@ -116,14 +204,27 @@ var PlayFabClientApi = class extends PlayFabCommon {
116
204
  /**
117
205
  * Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
118
206
  * PlayFab items
119
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements
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
+ * });
120
216
  */
121
217
  ConsumePS5Entitlements(request, extraHeaders) {
122
218
  return this.ExecuteRequestWrapper("/Client/ConsumePS5Entitlements", request, "X-Authorization", extraHeaders);
123
219
  }
124
220
  /**
125
221
  * Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
126
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements
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
+ * });
127
228
  */
128
229
  ConsumePSNEntitlements(request, extraHeaders) {
129
230
  return this.ExecuteRequestWrapper("/Client/ConsumePSNEntitlements", request, "X-Authorization", extraHeaders);
@@ -131,7 +232,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
131
232
  /**
132
233
  * Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
133
234
  * player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
134
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements
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
+ * });
135
242
  */
136
243
  ConsumeXboxEntitlements(request, extraHeaders) {
137
244
  return this.ExecuteRequestWrapper("/Client/ConsumeXboxEntitlements", request, "X-Authorization", extraHeaders);
@@ -141,14 +248,28 @@ var PlayFabClientApi = class extends PlayFabCommon {
141
248
  * group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
142
249
  * between a very small number of players, please see our guide:
143
250
  * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
144
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup
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
+ * });
145
257
  */
146
258
  CreateSharedGroup(request, extraHeaders) {
147
259
  return this.ExecuteRequestWrapper("/Client/CreateSharedGroup", request, "X-Authorization", extraHeaders);
148
260
  }
149
261
  /**
150
262
  * Deletes title-specific custom properties for a player
151
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties
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
+ * });
152
273
  */
153
274
  DeletePlayerCustomProperties(request, extraHeaders) {
154
275
  return this.ExecuteRequestWrapper("/Client/DeletePlayerCustomProperties", request, "X-Authorization", extraHeaders);
@@ -156,21 +277,45 @@ var PlayFabClientApi = class extends PlayFabCommon {
156
277
  /**
157
278
  * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
158
279
  * PlayFab ID is the entity ID of the player's master_player_account entity.
159
- * https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript
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
+ * });
160
292
  */
161
293
  ExecuteCloudScript(request, extraHeaders) {
162
294
  return this.ExecuteRequestWrapper("/Client/ExecuteCloudScript", request, "X-Authorization", extraHeaders);
163
295
  }
164
296
  /**
165
297
  * Retrieves the user's PlayFab account details
166
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
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
+ * });
167
304
  */
168
305
  GetAccountInfo(request, extraHeaders) {
169
306
  return this.ExecuteRequestWrapper("/Client/GetAccountInfo", request, "X-Authorization", extraHeaders);
170
307
  }
171
308
  /**
172
309
  * Returns a list of ad placements and a reward for each
173
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements
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
+ * });
174
319
  */
175
320
  GetAdPlacements(request, extraHeaders) {
176
321
  return this.ExecuteRequestWrapper("/Client/GetAdPlacements", request, "X-Authorization", extraHeaders);
@@ -178,7 +323,12 @@ var PlayFabClientApi = class extends PlayFabCommon {
178
323
  /**
179
324
  * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
180
325
  * evaluated with the parent PlayFabId to guarantee uniqueness.
181
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
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
+ * });
182
332
  */
183
333
  GetAllUsersCharacters(request, extraHeaders) {
184
334
  return this.ExecuteRequestWrapper("/Client/GetAllUsersCharacters", request, "X-Authorization", extraHeaders);
@@ -186,14 +336,29 @@ var PlayFabClientApi = class extends PlayFabCommon {
186
336
  /**
187
337
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
188
338
  * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
189
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems
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
+ * });
190
345
  */
191
346
  GetCatalogItems(request, extraHeaders) {
192
347
  return this.ExecuteRequestWrapper("/Client/GetCatalogItems", request, "X-Authorization", extraHeaders);
193
348
  }
194
349
  /**
195
350
  * Retrieves the title-specific custom data for the character which is readable and writable by the client
196
- * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata
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
+ * });
197
362
  */
198
363
  GetCharacterData(request, extraHeaders) {
199
364
  return this.ExecuteRequestWrapper("/Client/GetCharacterData", request, "X-Authorization", extraHeaders);
@@ -201,32 +366,71 @@ var PlayFabClientApi = class extends PlayFabCommon {
201
366
  /**
202
367
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
203
368
  * version 2._ Retrieves the specified character's current inventory of virtual goods
204
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory
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
+ * });
205
376
  */
206
377
  GetCharacterInventory(request, extraHeaders) {
207
378
  return this.ExecuteRequestWrapper("/Client/GetCharacterInventory", request, "X-Authorization", extraHeaders);
208
379
  }
209
380
  /**
210
381
  * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
211
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard
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
+ * });
212
391
  */
213
392
  GetCharacterLeaderboard(request, extraHeaders) {
214
393
  return this.ExecuteRequestWrapper("/Client/GetCharacterLeaderboard", request, "X-Authorization", extraHeaders);
215
394
  }
216
395
  /**
217
396
  * Retrieves the title-specific custom data for the character which can only be read by the client
218
- * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata
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
+ * });
219
408
  */
220
409
  GetCharacterReadOnlyData(request, extraHeaders) {
221
410
  return this.ExecuteRequestWrapper("/Client/GetCharacterReadOnlyData", request, "X-Authorization", extraHeaders);
222
411
  }
223
412
  /**
224
413
  * Retrieves the details of all title-specific statistics for the user
225
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
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
+ * });
226
420
  */
227
421
  GetCharacterStatistics(request, extraHeaders) {
228
422
  return this.ExecuteRequestWrapper("/Client/GetCharacterStatistics", request, "X-Authorization", extraHeaders);
229
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
+ }
230
434
  /**
231
435
  * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
232
436
  * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
@@ -234,23 +438,62 @@ var PlayFabClientApi = class extends PlayFabCommon {
234
438
  * the query to retrieve the data will fail. See this post for more information:
235
439
  * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
236
440
  * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
237
- * https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl
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
+ * });
238
447
  */
239
448
  GetContentDownloadUrl(request, extraHeaders) {
240
449
  return this.ExecuteRequestWrapper("/Client/GetContentDownloadUrl", request, "X-Authorization", extraHeaders);
241
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
+ }
242
460
  /**
243
461
  * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
244
462
  * the leaderboard
245
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard
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
+ * });
246
472
  */
247
473
  GetFriendLeaderboard(request, extraHeaders) {
248
474
  return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboard", request, "X-Authorization", extraHeaders);
249
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
+ }
250
486
  /**
251
487
  * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
252
488
  * user. If PlayFabId is empty or null will return currently logged in user.
253
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer
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
+ * });
254
497
  */
255
498
  GetFriendLeaderboardAroundPlayer(request, extraHeaders) {
256
499
  return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboardAroundPlayer", request, "X-Authorization", extraHeaders);
@@ -258,36 +501,84 @@ var PlayFabClientApi = class extends PlayFabCommon {
258
501
  /**
259
502
  * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
260
503
  * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
261
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist
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
+ * });
262
510
  */
263
511
  GetFriendsList(request, extraHeaders) {
264
512
  return this.ExecuteRequestWrapper("/Client/GetFriendsList", request, "X-Authorization", extraHeaders);
265
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
+ }
266
523
  /**
267
524
  * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
268
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard
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
+ * });
269
533
  */
270
534
  GetLeaderboard(request, extraHeaders) {
271
535
  return this.ExecuteRequestWrapper("/Client/GetLeaderboard", request, "X-Authorization", extraHeaders);
272
536
  }
273
537
  /**
274
538
  * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
275
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter
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
+ * });
276
547
  */
277
548
  GetLeaderboardAroundCharacter(request, extraHeaders) {
278
549
  return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundCharacter", request, "X-Authorization", extraHeaders);
279
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
+ }
280
560
  /**
281
561
  * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
282
562
  * null will return currently logged in user.
283
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
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
+ * });
284
570
  */
285
571
  GetLeaderboardAroundPlayer(request, extraHeaders) {
286
572
  return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundPlayer", request, "X-Authorization", extraHeaders);
287
573
  }
288
574
  /**
289
575
  * Retrieves a list of all of the user's characters for the given statistic.
290
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters
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
+ * });
291
582
  */
292
583
  GetLeaderboardForUserCharacters(request, extraHeaders) {
293
584
  return this.ExecuteRequestWrapper("/Client/GetLeaderboardForUserCharacters", request, "X-Authorization", extraHeaders);
@@ -297,7 +588,12 @@ var PlayFabClientApi = class extends PlayFabCommon {
297
588
  * version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
298
589
  * client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
299
590
  * client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
300
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken
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
+ * });
301
597
  */
302
598
  GetPaymentToken(request, extraHeaders) {
303
599
  return this.ExecuteRequestWrapper("/Client/GetPaymentToken", request, "X-Authorization", extraHeaders);
@@ -305,35 +601,75 @@ var PlayFabClientApi = class extends PlayFabCommon {
305
601
  /**
306
602
  * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
307
603
  * https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
308
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
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
+ * });
309
610
  */
310
611
  GetPhotonAuthenticationToken(request, extraHeaders) {
311
612
  return this.ExecuteRequestWrapper("/Client/GetPhotonAuthenticationToken", request, "X-Authorization", extraHeaders);
312
613
  }
313
614
  /**
314
615
  * Retrieves all of the user's different kinds of info.
315
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo
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
+ * });
316
639
  */
317
640
  GetPlayerCombinedInfo(request, extraHeaders) {
318
641
  return this.ExecuteRequestWrapper("/Client/GetPlayerCombinedInfo", request, "X-Authorization", extraHeaders);
319
642
  }
320
643
  /**
321
644
  * Retrieves a title-specific custom property value for a player.
322
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
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
+ * });
323
651
  */
324
652
  GetPlayerCustomProperty(request, extraHeaders) {
325
653
  return this.ExecuteRequestWrapper("/Client/GetPlayerCustomProperty", request, "X-Authorization", extraHeaders);
326
654
  }
327
655
  /**
328
656
  * Retrieves the player's profile
329
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
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
+ * });
330
663
  */
331
664
  GetPlayerProfile(request, extraHeaders) {
332
665
  return this.ExecuteRequestWrapper("/Client/GetPlayerProfile", request, "X-Authorization", extraHeaders);
333
666
  }
334
667
  /**
335
668
  * List all segments that a player currently belongs to at this moment in time.
336
- * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments
669
+ *
670
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments Microsoft Documentation}
671
+ * @example
672
+ * await clientClient.GetPlayerSegments({});
337
673
  */
338
674
  GetPlayerSegments(request, extraHeaders) {
339
675
  return this.ExecuteRequestWrapper("/Client/GetPlayerSegments", request, "X-Authorization", extraHeaders);
@@ -341,49 +677,97 @@ var PlayFabClientApi = class extends PlayFabCommon {
341
677
  /**
342
678
  * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
343
679
  * player.
344
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics
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
+ * });
345
689
  */
346
690
  GetPlayerStatistics(request, extraHeaders) {
347
691
  return this.ExecuteRequestWrapper("/Client/GetPlayerStatistics", request, "X-Authorization", extraHeaders);
348
692
  }
349
693
  /**
350
694
  * Retrieves the information on the available versions of the specified statistic.
351
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
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
+ * });
352
701
  */
353
702
  GetPlayerStatisticVersions(request, extraHeaders) {
354
703
  return this.ExecuteRequestWrapper("/Client/GetPlayerStatisticVersions", request, "X-Authorization", extraHeaders);
355
704
  }
356
705
  /**
357
706
  * Get all tags with a given Namespace (optional) from a player profile.
358
- * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
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
+ * });
359
714
  */
360
715
  GetPlayerTags(request, extraHeaders) {
361
716
  return this.ExecuteRequestWrapper("/Client/GetPlayerTags", request, "X-Authorization", extraHeaders);
362
717
  }
363
718
  /**
364
719
  * Gets all trades the player has either opened or accepted, optionally filtered by trade status.
365
- * https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades
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
+ * });
366
726
  */
367
727
  GetPlayerTrades(request, extraHeaders) {
368
728
  return this.ExecuteRequestWrapper("/Client/GetPlayerTrades", request, "X-Authorization", extraHeaders);
369
729
  }
370
730
  /**
371
731
  * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
372
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids
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
+ * });
373
741
  */
374
742
  GetPlayFabIDsFromBattleNetAccountIds(request, extraHeaders) {
375
743
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromBattleNetAccountIds", request, "X-Authorization", extraHeaders);
376
744
  }
377
745
  /**
378
746
  * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
379
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids
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
+ * });
380
756
  */
381
757
  GetPlayFabIDsFromFacebookIDs(request, extraHeaders) {
382
758
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookIDs", request, "X-Authorization", extraHeaders);
383
759
  }
384
760
  /**
385
761
  * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
386
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids
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
+ * });
387
771
  */
388
772
  GetPlayFabIDsFromFacebookInstantGamesIds(request, extraHeaders) {
389
773
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookInstantGamesIds", request, "X-Authorization", extraHeaders);
@@ -391,7 +775,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
391
775
  /**
392
776
  * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
393
777
  * Programming Guide as the Player Identifier).
394
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids
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
+ * });
395
787
  */
396
788
  GetPlayFabIDsFromGameCenterIDs(request, extraHeaders) {
397
789
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGameCenterIDs", request, "X-Authorization", extraHeaders);
@@ -400,7 +792,21 @@ var PlayFabClientApi = class extends PlayFabCommon {
400
792
  * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
401
793
  * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
402
794
  * added to the player account.
403
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids
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
+ * });
404
810
  */
405
811
  GetPlayFabIDsFromGenericIDs(request, extraHeaders) {
406
812
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGenericIDs", request, "X-Authorization", extraHeaders);
@@ -408,7 +814,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
408
814
  /**
409
815
  * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
410
816
  * the user accounts, available as "id" in the Google+ People API calls.
411
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids
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
+ * });
412
826
  */
413
827
  GetPlayFabIDsFromGoogleIDs(request, extraHeaders) {
414
828
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGoogleIDs", request, "X-Authorization", extraHeaders);
@@ -417,7 +831,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
417
831
  * Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
418
832
  * identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
419
833
  * calls.
420
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids
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
+ * });
421
843
  */
422
844
  GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request, extraHeaders) {
423
845
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs", request, "X-Authorization", extraHeaders);
@@ -426,35 +848,75 @@ var PlayFabClientApi = class extends PlayFabCommon {
426
848
  * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
427
849
  * IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
428
850
  * http://developers.kongregate.com/docs/client/getUserId).
429
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids
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
+ * });
430
860
  */
431
861
  GetPlayFabIDsFromKongregateIDs(request, extraHeaders) {
432
862
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromKongregateIDs", request, "X-Authorization", extraHeaders);
433
863
  }
434
864
  /**
435
865
  * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
436
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids
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
+ * });
437
875
  */
438
876
  GetPlayFabIDsFromNintendoServiceAccountIds(request, extraHeaders) {
439
877
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoServiceAccountIds", request, "X-Authorization", extraHeaders);
440
878
  }
441
879
  /**
442
880
  * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
443
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids
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
+ * });
444
890
  */
445
891
  GetPlayFabIDsFromNintendoSwitchDeviceIds(request, extraHeaders) {
446
892
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-Authorization", extraHeaders);
447
893
  }
448
894
  /**
449
895
  * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
450
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids
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
+ * });
451
905
  */
452
906
  GetPlayFabIDsFromPSNAccountIDs(request, extraHeaders) {
453
907
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNAccountIDs", request, "X-Authorization", extraHeaders);
454
908
  }
455
909
  /**
456
910
  * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
457
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids
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
+ * });
458
920
  */
459
921
  GetPlayFabIDsFromPSNOnlineIDs(request, extraHeaders) {
460
922
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNOnlineIDs", request, "X-Authorization", extraHeaders);
@@ -462,7 +924,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
462
924
  /**
463
925
  * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
464
926
  * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
465
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids
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
+ * });
466
936
  */
467
937
  GetPlayFabIDsFromSteamIDs(request, extraHeaders) {
468
938
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamIDs", request, "X-Authorization", extraHeaders);
@@ -470,7 +940,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
470
940
  /**
471
941
  * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
472
942
  * names.
473
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames
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
+ * });
474
952
  */
475
953
  GetPlayFabIDsFromSteamNames(request, extraHeaders) {
476
954
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamNames", request, "X-Authorization", extraHeaders);
@@ -479,21 +957,46 @@ var PlayFabClientApi = class extends PlayFabCommon {
479
957
  * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
480
958
  * the user accounts, available as "_id" from the Twitch API methods (ex:
481
959
  * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
482
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids
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
+ * });
483
969
  */
484
970
  GetPlayFabIDsFromTwitchIDs(request, extraHeaders) {
485
971
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromTwitchIDs", request, "X-Authorization", extraHeaders);
486
972
  }
487
973
  /**
488
974
  * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
489
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids
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
+ * });
490
985
  */
491
986
  GetPlayFabIDsFromXboxLiveIDs(request, extraHeaders) {
492
987
  return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromXboxLiveIDs", request, "X-Authorization", extraHeaders);
493
988
  }
494
989
  /**
495
990
  * Retrieves the key-value store of custom publisher settings
496
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata
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
+ * });
497
1000
  */
498
1001
  GetPublisherData(request, extraHeaders) {
499
1002
  return this.ExecuteRequestWrapper("/Client/GetPublisherData", request, "X-Authorization", extraHeaders);
@@ -502,7 +1005,12 @@ var PlayFabClientApi = class extends PlayFabCommon {
502
1005
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
503
1006
  * version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
504
1007
  * are still active.
505
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
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
+ * });
506
1014
  */
507
1015
  GetPurchase(request, extraHeaders) {
508
1016
  return this.ExecuteRequestWrapper("/Client/GetPurchase", request, "X-Authorization", extraHeaders);
@@ -512,7 +1020,17 @@ var PlayFabClientApi = class extends PlayFabCommon {
512
1020
  * may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
513
1021
  * Shared Groups are designed for sharing data between a very small number of players, please see our guide:
514
1022
  * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
515
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata
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
+ * });
516
1034
  */
517
1035
  GetSharedGroupData(request, extraHeaders) {
518
1036
  return this.ExecuteRequestWrapper("/Client/GetSharedGroupData", request, "X-Authorization", extraHeaders);
@@ -520,49 +1038,106 @@ var PlayFabClientApi = class extends PlayFabCommon {
520
1038
  /**
521
1039
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
522
1040
  * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
523
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems
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
+ * });
524
1047
  */
525
1048
  GetStoreItems(request, extraHeaders) {
526
1049
  return this.ExecuteRequestWrapper("/Client/GetStoreItems", request, "X-Authorization", extraHeaders);
527
1050
  }
528
1051
  /**
529
1052
  * Retrieves the current server time
530
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
1053
+ *
1054
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime Microsoft Documentation}
1055
+ * @example
1056
+ * await clientClient.GetTime({});
531
1057
  */
532
1058
  GetTime(request, extraHeaders) {
533
1059
  return this.ExecuteRequestWrapper("/Client/GetTime", request, "X-Authorization", extraHeaders);
534
1060
  }
535
1061
  /**
536
1062
  * Retrieves the key-value store of custom title settings
537
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata
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
+ * });
538
1072
  */
539
1073
  GetTitleData(request, extraHeaders) {
540
1074
  return this.ExecuteRequestWrapper("/Client/GetTitleData", request, "X-Authorization", extraHeaders);
541
1075
  }
542
1076
  /**
543
1077
  * Retrieves the title news feed, as configured in the developer portal
544
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews
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
+ * });
545
1084
  */
546
1085
  GetTitleNews(request, extraHeaders) {
547
1086
  return this.ExecuteRequestWrapper("/Client/GetTitleNews", request, "X-Authorization", extraHeaders);
548
1087
  }
549
1088
  /**
550
1089
  * Returns the title's base 64 encoded RSA CSP blob.
551
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
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
+ * });
552
1097
  */
553
1098
  GetTitlePublicKey(request, extraHeaders) {
554
1099
  return this.ExecuteRequestWrapper("/Client/GetTitlePublicKey", request, null, extraHeaders);
555
1100
  }
556
1101
  /**
557
1102
  * Gets the current status of an existing trade.
558
- * https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus
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
+ * });
559
1110
  */
560
1111
  GetTradeStatus(request, extraHeaders) {
561
1112
  return this.ExecuteRequestWrapper("/Client/GetTradeStatus", request, "X-Authorization", extraHeaders);
562
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
+ }
563
1130
  /**
564
1131
  * Retrieves the title-specific custom data for the user which is readable and writable by the client
565
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata
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
+ * });
566
1141
  */
567
1142
  GetUserData(request, extraHeaders) {
568
1143
  return this.ExecuteRequestWrapper("/Client/GetUserData", request, "X-Authorization", extraHeaders);
@@ -570,78 +1145,153 @@ var PlayFabClientApi = class extends PlayFabCommon {
570
1145
  /**
571
1146
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
572
1147
  * version 2._ Retrieves the user's current inventory of virtual goods
573
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
1148
+ *
1149
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory Microsoft Documentation}
1150
+ * @example
1151
+ * await clientClient.GetUserInventory({});
574
1152
  */
575
1153
  GetUserInventory(request, extraHeaders) {
576
1154
  return this.ExecuteRequestWrapper("/Client/GetUserInventory", request, "X-Authorization", extraHeaders);
577
1155
  }
578
1156
  /**
579
1157
  * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
580
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata
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
+ * });
581
1167
  */
582
1168
  GetUserPublisherData(request, extraHeaders) {
583
1169
  return this.ExecuteRequestWrapper("/Client/GetUserPublisherData", request, "X-Authorization", extraHeaders);
584
1170
  }
585
1171
  /**
586
1172
  * Retrieves the publisher-specific custom data for the user which can only be read by the client
587
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata
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
+ * });
588
1182
  */
589
1183
  GetUserPublisherReadOnlyData(request, extraHeaders) {
590
1184
  return this.ExecuteRequestWrapper("/Client/GetUserPublisherReadOnlyData", request, "X-Authorization", extraHeaders);
591
1185
  }
592
1186
  /**
593
1187
  * Retrieves the title-specific custom data for the user which can only be read by the client
594
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata
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
+ * });
595
1197
  */
596
1198
  GetUserReadOnlyData(request, extraHeaders) {
597
1199
  return this.ExecuteRequestWrapper("/Client/GetUserReadOnlyData", request, "X-Authorization", extraHeaders);
598
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
+ }
599
1210
  /**
600
1211
  * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
601
1212
  * with the parent PlayFabId to guarantee uniqueness.
602
- * https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
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
+ * });
603
1221
  */
604
1222
  GrantCharacterToUser(request, extraHeaders) {
605
1223
  return this.ExecuteRequestWrapper("/Client/GrantCharacterToUser", request, "X-Authorization", extraHeaders);
606
1224
  }
607
1225
  /**
608
1226
  * Links the Android device identifier to the user's PlayFab account
609
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
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
+ * });
610
1235
  */
611
1236
  LinkAndroidDeviceID(request, extraHeaders) {
612
1237
  return this.ExecuteRequestWrapper("/Client/LinkAndroidDeviceID", request, "X-Authorization", extraHeaders);
613
1238
  }
614
1239
  /**
615
1240
  * Links the Apple account associated with the token to the user's PlayFab account.
616
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple
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
+ * });
617
1247
  */
618
1248
  LinkApple(request, extraHeaders) {
619
1249
  return this.ExecuteRequestWrapper("/Client/LinkApple", request, "X-Authorization", extraHeaders);
620
1250
  }
621
1251
  /**
622
1252
  * Links the Battle.net account associated with the token to the user's PlayFab account.
623
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount
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
+ * });
624
1259
  */
625
1260
  LinkBattleNetAccount(request, extraHeaders) {
626
1261
  return this.ExecuteRequestWrapper("/Client/LinkBattleNetAccount", request, "X-Authorization", extraHeaders);
627
1262
  }
628
1263
  /**
629
1264
  * Links the custom identifier, generated by the title, to the user's PlayFab account
630
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid
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
+ * });
631
1271
  */
632
1272
  LinkCustomID(request, extraHeaders) {
633
1273
  return this.ExecuteRequestWrapper("/Client/LinkCustomID", request, "X-Authorization", extraHeaders);
634
1274
  }
635
1275
  /**
636
1276
  * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
637
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount
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
+ * });
638
1283
  */
639
1284
  LinkFacebookAccount(request, extraHeaders) {
640
1285
  return this.ExecuteRequestWrapper("/Client/LinkFacebookAccount", request, "X-Authorization", extraHeaders);
641
1286
  }
642
1287
  /**
643
1288
  * Links the Facebook Instant Games Id to the user's PlayFab account
644
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
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
+ * });
645
1295
  */
646
1296
  LinkFacebookInstantGamesId(request, extraHeaders) {
647
1297
  return this.ExecuteRequestWrapper("/Client/LinkFacebookInstantGamesId", request, "X-Authorization", extraHeaders);
@@ -651,14 +1301,24 @@ var PlayFabClientApi = class extends PlayFabCommon {
651
1301
  * a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
652
1302
  * in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
653
1303
  * page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
654
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount
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
+ * });
655
1310
  */
656
1311
  LinkGameCenterAccount(request, extraHeaders) {
657
1312
  return this.ExecuteRequestWrapper("/Client/LinkGameCenterAccount", request, "X-Authorization", extraHeaders);
658
1313
  }
659
1314
  /**
660
1315
  * Links the currently signed-in user account to their Google account, using their Google account credentials
661
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount
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
+ * });
662
1322
  */
663
1323
  LinkGoogleAccount(request, extraHeaders) {
664
1324
  return this.ExecuteRequestWrapper("/Client/LinkGoogleAccount", request, "X-Authorization", extraHeaders);
@@ -666,35 +1326,63 @@ var PlayFabClientApi = class extends PlayFabCommon {
666
1326
  /**
667
1327
  * Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
668
1328
  * credentials
669
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
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
+ * });
670
1335
  */
671
1336
  LinkGooglePlayGamesServicesAccount(request, extraHeaders) {
672
1337
  return this.ExecuteRequestWrapper("/Client/LinkGooglePlayGamesServicesAccount", request, "X-Authorization", extraHeaders);
673
1338
  }
674
1339
  /**
675
1340
  * Links the vendor-specific iOS device identifier to the user's PlayFab account
676
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid
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
+ * });
677
1349
  */
678
1350
  LinkIOSDeviceID(request, extraHeaders) {
679
1351
  return this.ExecuteRequestWrapper("/Client/LinkIOSDeviceID", request, "X-Authorization", extraHeaders);
680
1352
  }
681
1353
  /**
682
1354
  * Links the Kongregate identifier to the user's PlayFab account
683
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
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
+ * });
684
1362
  */
685
1363
  LinkKongregate(request, extraHeaders) {
686
1364
  return this.ExecuteRequestWrapper("/Client/LinkKongregate", request, "X-Authorization", extraHeaders);
687
1365
  }
688
1366
  /**
689
1367
  * Links the Nintendo account associated with the token to the user's PlayFab account.
690
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount
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
+ * });
691
1374
  */
692
1375
  LinkNintendoServiceAccount(request, extraHeaders) {
693
1376
  return this.ExecuteRequestWrapper("/Client/LinkNintendoServiceAccount", request, "X-Authorization", extraHeaders);
694
1377
  }
695
1378
  /**
696
1379
  * Links the NintendoSwitchDeviceId to the user's PlayFab account
697
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
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
+ * });
698
1386
  */
699
1387
  LinkNintendoSwitchDeviceId(request, extraHeaders) {
700
1388
  return this.ExecuteRequestWrapper("/Client/LinkNintendoSwitchDeviceId", request, "X-Authorization", extraHeaders);
@@ -702,50 +1390,99 @@ var PlayFabClientApi = class extends PlayFabCommon {
702
1390
  /**
703
1391
  * Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
704
1392
  * Open ID Connect provider and the OpenId Connect JWT from that provider.
705
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
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
+ * });
706
1400
  */
707
1401
  LinkOpenIdConnect(request, extraHeaders) {
708
1402
  return this.ExecuteRequestWrapper("/Client/LinkOpenIdConnect", request, "X-Authorization", extraHeaders);
709
1403
  }
710
1404
  /**
711
1405
  * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
712
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount
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
+ * });
713
1413
  */
714
1414
  LinkPSNAccount(request, extraHeaders) {
715
1415
  return this.ExecuteRequestWrapper("/Client/LinkPSNAccount", request, "X-Authorization", extraHeaders);
716
1416
  }
717
1417
  /**
718
1418
  * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
719
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount
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
+ * });
720
1426
  */
721
1427
  LinkSteamAccount(request, extraHeaders) {
722
1428
  return this.ExecuteRequestWrapper("/Client/LinkSteamAccount", request, "X-Authorization", extraHeaders);
723
1429
  }
724
1430
  /**
725
1431
  * Links the Twitch account associated with the token to the user's PlayFab account.
726
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch
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
+ * });
727
1438
  */
728
1439
  LinkTwitch(request, extraHeaders) {
729
1440
  return this.ExecuteRequestWrapper("/Client/LinkTwitch", request, "X-Authorization", extraHeaders);
730
1441
  }
731
1442
  /**
732
1443
  * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
733
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount
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
+ * });
734
1450
  */
735
1451
  LinkXboxAccount(request, extraHeaders) {
736
1452
  return this.ExecuteRequestWrapper("/Client/LinkXboxAccount", request, "X-Authorization", extraHeaders);
737
1453
  }
738
1454
  /**
739
1455
  * Retrieves title-specific custom property values for a player.
740
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
1456
+ *
1457
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties Microsoft Documentation}
1458
+ * @example
1459
+ * await clientClient.ListPlayerCustomProperties({});
741
1460
  */
742
1461
  ListPlayerCustomProperties(request, extraHeaders) {
743
1462
  return this.ExecuteRequestWrapper("/Client/ListPlayerCustomProperties", request, "X-Authorization", extraHeaders);
744
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
+ }
745
1473
  /**
746
1474
  * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
747
1475
  * API calls which require an authenticated user
748
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid
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
+ * });
749
1486
  */
750
1487
  LoginWithAndroidDeviceID(request, extraHeaders) {
751
1488
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -767,7 +1504,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
767
1504
  }
768
1505
  /**
769
1506
  * Signs in the user with a Sign in with Apple identity token.
770
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
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
+ * });
771
1514
  */
772
1515
  LoginWithApple(request, extraHeaders) {
773
1516
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -789,7 +1532,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
789
1532
  }
790
1533
  /**
791
1534
  * Sign in the user with a Battle.net identity token
792
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet
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
+ * });
793
1542
  */
794
1543
  LoginWithBattleNet(request, extraHeaders) {
795
1544
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -812,7 +1561,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
812
1561
  /**
813
1562
  * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
814
1563
  * subsequently be used for API calls which require an authenticated user
815
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
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
+ * });
816
1572
  */
817
1573
  LoginWithCustomID(request, extraHeaders) {
818
1574
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -837,7 +1593,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
837
1593
  * which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
838
1594
  * creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
839
1595
  * RegisterPlayFabUser.
840
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
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
+ * });
841
1604
  */
842
1605
  LoginWithEmailAddress(request, extraHeaders) {
843
1606
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -860,7 +1623,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
860
1623
  /**
861
1624
  * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
862
1625
  * calls which require an authenticated user
863
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook
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
+ * });
864
1634
  */
865
1635
  LoginWithFacebook(request, extraHeaders) {
866
1636
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -883,7 +1653,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
883
1653
  /**
884
1654
  * Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
885
1655
  * API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
886
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid
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
+ * });
887
1664
  */
888
1665
  LoginWithFacebookInstantGamesId(request, extraHeaders) {
889
1666
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -909,7 +1686,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
909
1686
  * include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you
910
1687
  * require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and
911
1688
  * enabling the 'Require secure authentication only for this app' option.
912
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter
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
+ * });
913
1697
  */
914
1698
  LoginWithGameCenter(request, extraHeaders) {
915
1699
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -931,7 +1715,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
931
1715
  }
932
1716
  /**
933
1717
  * Signs the user in using their Google account credentials
934
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount
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
+ * });
935
1727
  */
936
1728
  LoginWithGoogleAccount(request, extraHeaders) {
937
1729
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -953,7 +1745,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
953
1745
  }
954
1746
  /**
955
1747
  * Signs the user in using their Google Play Games account credentials
956
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices
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
+ * });
957
1756
  */
958
1757
  LoginWithGooglePlayGamesServices(request, extraHeaders) {
959
1758
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -976,7 +1775,16 @@ var PlayFabClientApi = class extends PlayFabCommon {
976
1775
  /**
977
1776
  * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
978
1777
  * be used for API calls which require an authenticated user
979
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid
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
+ * });
980
1788
  */
981
1789
  LoginWithIOSDeviceID(request, extraHeaders) {
982
1790
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -998,7 +1806,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
998
1806
  }
999
1807
  /**
1000
1808
  * Signs the user in using a Kongregate player account.
1001
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate
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
+ * });
1002
1818
  */
1003
1819
  LoginWithKongregate(request, extraHeaders) {
1004
1820
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1020,7 +1836,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
1020
1836
  }
1021
1837
  /**
1022
1838
  * Signs in the user with a Nintendo service account token.
1023
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount
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
+ * });
1024
1846
  */
1025
1847
  LoginWithNintendoServiceAccount(request, extraHeaders) {
1026
1848
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1043,7 +1865,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1043
1865
  /**
1044
1866
  * Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
1045
1867
  * API calls which require an authenticated user
1046
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid
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
+ * });
1047
1876
  */
1048
1877
  LoginWithNintendoSwitchDeviceId(request, extraHeaders) {
1049
1878
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1066,7 +1895,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1066
1895
  /**
1067
1896
  * Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
1068
1897
  * provider.
1069
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect
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
+ * });
1070
1906
  */
1071
1907
  LoginWithOpenIdConnect(request, extraHeaders) {
1072
1908
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1091,7 +1927,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1091
1927
  * which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
1092
1928
  * new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via
1093
1929
  * RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
1094
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab
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
+ * });
1095
1938
  */
1096
1939
  LoginWithPlayFab(request, extraHeaders) {
1097
1940
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1114,7 +1957,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
1114
1957
  /**
1115
1958
  * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
1116
1959
  * subsequently be used for API calls which require an authenticated user
1117
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn
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
+ * });
1118
1969
  */
1119
1970
  LoginWithPSN(request, extraHeaders) {
1120
1971
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1137,7 +1988,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
1137
1988
  /**
1138
1989
  * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
1139
1990
  * API calls which require an authenticated user
1140
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam
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
+ * });
1141
2000
  */
1142
2001
  LoginWithSteam(request, extraHeaders) {
1143
2002
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1159,7 +2018,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1159
2018
  }
1160
2019
  /**
1161
2020
  * Signs the user in using a Twitch access token.
1162
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch
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
+ * });
1163
2029
  */
1164
2030
  LoginWithTwitch(request, extraHeaders) {
1165
2031
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1182,7 +2048,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1182
2048
  /**
1183
2049
  * Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
1184
2050
  * which require an authenticated user
1185
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox
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
+ * });
1186
2059
  */
1187
2060
  LoginWithXbox(request, extraHeaders) {
1188
2061
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1202,9 +2075,34 @@ var PlayFabClientApi = class extends PlayFabCommon {
1202
2075
  return result;
1203
2076
  });
1204
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
+ }
1205
2092
  /**
1206
2093
  * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
1207
- * https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade
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
+ * });
1208
2106
  */
1209
2107
  OpenTrade(request, extraHeaders) {
1210
2108
  return this.ExecuteRequestWrapper("/Client/OpenTrade", request, "X-Authorization", extraHeaders);
@@ -1212,7 +2110,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1212
2110
  /**
1213
2111
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1214
2112
  * version 2._ Selects a payment option for purchase order created via StartPurchase
1215
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase
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
+ * });
1216
2121
  */
1217
2122
  PayForPurchase(request, extraHeaders) {
1218
2123
  return this.ExecuteRequestWrapper("/Client/PayForPurchase", request, "X-Authorization", extraHeaders);
@@ -1221,7 +2126,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1221
2126
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1222
2127
  * version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
1223
2128
  * well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
1224
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem
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
+ * });
1225
2137
  */
1226
2138
  PurchaseItem(request, extraHeaders) {
1227
2139
  return this.ExecuteRequestWrapper("/Client/PurchaseItem", request, "X-Authorization", extraHeaders);
@@ -1230,21 +2142,40 @@ var PlayFabClientApi = class extends PlayFabCommon {
1230
2142
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1231
2143
  * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
1232
2144
  * Economy->Catalogs tab in the PlayFab Game Manager.
1233
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon
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
+ * });
1234
2152
  */
1235
2153
  RedeemCoupon(request, extraHeaders) {
1236
2154
  return this.ExecuteRequestWrapper("/Client/RedeemCoupon", request, "X-Authorization", extraHeaders);
1237
2155
  }
1238
2156
  /**
1239
2157
  * Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
1240
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken
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
+ * });
1241
2165
  */
1242
2166
  RefreshPSNAuthToken(request, extraHeaders) {
1243
2167
  return this.ExecuteRequestWrapper("/Client/RefreshPSNAuthToken", request, "X-Authorization", extraHeaders);
1244
2168
  }
1245
2169
  /**
1246
2170
  * Registers the iOS device to receive push notifications
1247
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification
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
+ * });
1248
2179
  */
1249
2180
  RegisterForIOSPushNotification(request, extraHeaders) {
1250
2181
  return this.ExecuteRequestWrapper("/Client/RegisterForIOSPushNotification", request, "X-Authorization", extraHeaders);
@@ -1252,7 +2183,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
1252
2183
  /**
1253
2184
  * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
1254
2185
  * require an authenticated user. You must supply a username and an email address.
1255
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser
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
+ * });
1256
2195
  */
1257
2196
  RegisterPlayFabUser(request, extraHeaders) {
1258
2197
  request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
@@ -1274,21 +2213,37 @@ var PlayFabClientApi = class extends PlayFabCommon {
1274
2213
  }
1275
2214
  /**
1276
2215
  * Removes a contact email from the player's profile.
1277
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail
2216
+ *
2217
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail Microsoft Documentation}
2218
+ * @example
2219
+ * await clientClient.RemoveContactEmail({});
1278
2220
  */
1279
2221
  RemoveContactEmail(request, extraHeaders) {
1280
2222
  return this.ExecuteRequestWrapper("/Client/RemoveContactEmail", request, "X-Authorization", extraHeaders);
1281
2223
  }
1282
2224
  /**
1283
2225
  * Removes a specified user from the friend list of the local user
1284
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend
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
+ * });
1285
2232
  */
1286
2233
  RemoveFriend(request, extraHeaders) {
1287
2234
  return this.ExecuteRequestWrapper("/Client/RemoveFriend", request, "X-Authorization", extraHeaders);
1288
2235
  }
1289
2236
  /**
1290
2237
  * Removes the specified generic service identifier from the player's PlayFab account.
1291
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid
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
+ * });
1292
2247
  */
1293
2248
  RemoveGenericID(request, extraHeaders) {
1294
2249
  return this.ExecuteRequestWrapper("/Client/RemoveGenericID", request, "X-Authorization", extraHeaders);
@@ -1298,14 +2253,30 @@ var PlayFabClientApi = class extends PlayFabCommon {
1298
2253
  * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
1299
2254
  * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
1300
2255
  * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1301
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers
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
+ * });
1302
2266
  */
1303
2267
  RemoveSharedGroupMembers(request, extraHeaders) {
1304
2268
  return this.ExecuteRequestWrapper("/Client/RemoveSharedGroupMembers", request, "X-Authorization", extraHeaders);
1305
2269
  }
1306
2270
  /**
1307
2271
  * Report player's ad activity
1308
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity
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
+ * });
1309
2280
  */
1310
2281
  ReportAdActivity(request, extraHeaders) {
1311
2282
  return this.ExecuteRequestWrapper("/Client/ReportAdActivity", request, "X-Authorization", extraHeaders);
@@ -1313,7 +2284,16 @@ var PlayFabClientApi = class extends PlayFabCommon {
1313
2284
  /**
1314
2285
  * Write a PlayStream event to describe the provided player device information. This API method is not designed to be
1315
2286
  * called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
1316
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo
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
+ * });
1317
2297
  */
1318
2298
  ReportDeviceInfo(request, extraHeaders) {
1319
2299
  return this.ExecuteRequestWrapper("/Client/ReportDeviceInfo", request, "X-Authorization", extraHeaders);
@@ -1321,7 +2301,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
1321
2301
  /**
1322
2302
  * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
1323
2303
  * can take action concerning potentially toxic players.
1324
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer
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
+ * });
1325
2311
  */
1326
2312
  ReportPlayer(request, extraHeaders) {
1327
2313
  return this.ExecuteRequestWrapper("/Client/ReportPlayer", request, "X-Authorization", extraHeaders);
@@ -1329,30 +2315,69 @@ var PlayFabClientApi = class extends PlayFabCommon {
1329
2315
  /**
1330
2316
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1331
2317
  * version 2._ Restores all in-app purchases based on the given restore receipt
1332
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases
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
+ * });
1333
2324
  */
1334
2325
  RestoreIOSPurchases(request, extraHeaders) {
1335
2326
  return this.ExecuteRequestWrapper("/Client/RestoreIOSPurchases", request, "X-Authorization", extraHeaders);
1336
2327
  }
1337
2328
  /**
1338
2329
  * Reward player's ad activity
1339
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity
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
+ * });
1340
2337
  */
1341
2338
  RewardAdActivity(request, extraHeaders) {
1342
2339
  return this.ExecuteRequestWrapper("/Client/RewardAdActivity", request, "X-Authorization", extraHeaders);
1343
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
+ }
1344
2353
  /**
1345
2354
  * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
1346
2355
  * change the password.If an account recovery email template ID is provided, an email using the custom email template will
1347
2356
  * be used.
1348
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail
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
+ * });
1349
2365
  */
1350
2366
  SendAccountRecoveryEmail(request, extraHeaders) {
1351
2367
  return this.ExecuteRequestWrapper("/Client/SendAccountRecoveryEmail", request, null, extraHeaders);
1352
2368
  }
1353
2369
  /**
1354
2370
  * Updates the tag list for a specified user in the friend list of the local user
1355
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags
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
+ * });
1356
2381
  */
1357
2382
  SetFriendTags(request, extraHeaders) {
1358
2383
  return this.ExecuteRequestWrapper("/Client/SetFriendTags", request, "X-Authorization", extraHeaders);
@@ -1360,15 +2385,42 @@ var PlayFabClientApi = class extends PlayFabCommon {
1360
2385
  /**
1361
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
1362
2387
  * secret use the Admin or Server API method SetPlayerSecret.
1363
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/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
+ * });
1364
2394
  */
1365
2395
  SetPlayerSecret(request, extraHeaders) {
1366
2396
  return this.ExecuteRequestWrapper("/Client/SetPlayerSecret", request, "X-Authorization", extraHeaders);
1367
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
+ }
1368
2407
  /**
1369
2408
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1370
2409
  * version 2._ Creates an order for a list of items from the title catalog
1371
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase
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
+ * });
1372
2424
  */
1373
2425
  StartPurchase(request, extraHeaders) {
1374
2426
  return this.ExecuteRequestWrapper("/Client/StartPurchase", request, "X-Authorization", extraHeaders);
@@ -1377,56 +2429,89 @@ var PlayFabClientApi = class extends PlayFabCommon {
1377
2429
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1378
2430
  * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
1379
2431
  * a VC balance negative with this API.
1380
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency
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
+ * });
1381
2439
  */
1382
2440
  SubtractUserVirtualCurrency(request, extraHeaders) {
1383
2441
  return this.ExecuteRequestWrapper("/Client/SubtractUserVirtualCurrency", request, "X-Authorization", extraHeaders);
1384
2442
  }
1385
2443
  /**
1386
2444
  * Unlinks the related Android device identifier from the user's PlayFab account
1387
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid
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
+ * });
1388
2451
  */
1389
2452
  UnlinkAndroidDeviceID(request, extraHeaders) {
1390
2453
  return this.ExecuteRequestWrapper("/Client/UnlinkAndroidDeviceID", request, "X-Authorization", extraHeaders);
1391
2454
  }
1392
2455
  /**
1393
2456
  * Unlinks the related Apple account from the user's PlayFab account.
1394
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple
2457
+ *
2458
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple Microsoft Documentation}
2459
+ * @example
2460
+ * await clientClient.UnlinkApple({});
1395
2461
  */
1396
2462
  UnlinkApple(request, extraHeaders) {
1397
2463
  return this.ExecuteRequestWrapper("/Client/UnlinkApple", request, "X-Authorization", extraHeaders);
1398
2464
  }
1399
2465
  /**
1400
2466
  * Unlinks the related Battle.net account from the user's PlayFab account.
1401
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount
2467
+ *
2468
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount Microsoft Documentation}
2469
+ * @example
2470
+ * await clientClient.UnlinkBattleNetAccount({});
1402
2471
  */
1403
2472
  UnlinkBattleNetAccount(request, extraHeaders) {
1404
2473
  return this.ExecuteRequestWrapper("/Client/UnlinkBattleNetAccount", request, "X-Authorization", extraHeaders);
1405
2474
  }
1406
2475
  /**
1407
2476
  * Unlinks the related custom identifier from the user's PlayFab account
1408
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid
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
+ * });
1409
2483
  */
1410
2484
  UnlinkCustomID(request, extraHeaders) {
1411
2485
  return this.ExecuteRequestWrapper("/Client/UnlinkCustomID", request, "X-Authorization", extraHeaders);
1412
2486
  }
1413
2487
  /**
1414
2488
  * Unlinks the related Facebook account from the user's PlayFab account
1415
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount
2489
+ *
2490
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount Microsoft Documentation}
2491
+ * @example
2492
+ * await clientClient.UnlinkFacebookAccount({});
1416
2493
  */
1417
2494
  UnlinkFacebookAccount(request, extraHeaders) {
1418
2495
  return this.ExecuteRequestWrapper("/Client/UnlinkFacebookAccount", request, "X-Authorization", extraHeaders);
1419
2496
  }
1420
2497
  /**
1421
2498
  * Unlinks the related Facebook Instant Game Ids from the user's PlayFab account
1422
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid
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
+ * });
1423
2505
  */
1424
2506
  UnlinkFacebookInstantGamesId(request, extraHeaders) {
1425
2507
  return this.ExecuteRequestWrapper("/Client/UnlinkFacebookInstantGamesId", request, "X-Authorization", extraHeaders);
1426
2508
  }
1427
2509
  /**
1428
2510
  * Unlinks the related Game Center account from the user's PlayFab account
1429
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount
2511
+ *
2512
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount Microsoft Documentation}
2513
+ * @example
2514
+ * await clientClient.UnlinkGameCenterAccount({});
1430
2515
  */
1431
2516
  UnlinkGameCenterAccount(request, extraHeaders) {
1432
2517
  return this.ExecuteRequestWrapper("/Client/UnlinkGameCenterAccount", request, "X-Authorization", extraHeaders);
@@ -1434,42 +2519,64 @@ var PlayFabClientApi = class extends PlayFabCommon {
1434
2519
  /**
1435
2520
  * Unlinks the related Google account from the user's PlayFab account
1436
2521
  * (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
1437
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount
2522
+ *
2523
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount Microsoft Documentation}
2524
+ * @example
2525
+ * await clientClient.UnlinkGoogleAccount({});
1438
2526
  */
1439
2527
  UnlinkGoogleAccount(request, extraHeaders) {
1440
2528
  return this.ExecuteRequestWrapper("/Client/UnlinkGoogleAccount", request, "X-Authorization", extraHeaders);
1441
2529
  }
1442
2530
  /**
1443
2531
  * Unlinks the related Google Play Games account from the user's PlayFab account.
1444
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount
2532
+ *
2533
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount Microsoft Documentation}
2534
+ * @example
2535
+ * await clientClient.UnlinkGooglePlayGamesServicesAccount({});
1445
2536
  */
1446
2537
  UnlinkGooglePlayGamesServicesAccount(request, extraHeaders) {
1447
2538
  return this.ExecuteRequestWrapper("/Client/UnlinkGooglePlayGamesServicesAccount", request, "X-Authorization", extraHeaders);
1448
2539
  }
1449
2540
  /**
1450
2541
  * Unlinks the related iOS device identifier from the user's PlayFab account
1451
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid
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
+ * });
1452
2548
  */
1453
2549
  UnlinkIOSDeviceID(request, extraHeaders) {
1454
2550
  return this.ExecuteRequestWrapper("/Client/UnlinkIOSDeviceID", request, "X-Authorization", extraHeaders);
1455
2551
  }
1456
2552
  /**
1457
2553
  * Unlinks the related Kongregate identifier from the user's PlayFab account
1458
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate
2554
+ *
2555
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate Microsoft Documentation}
2556
+ * @example
2557
+ * await clientClient.UnlinkKongregate({});
1459
2558
  */
1460
2559
  UnlinkKongregate(request, extraHeaders) {
1461
2560
  return this.ExecuteRequestWrapper("/Client/UnlinkKongregate", request, "X-Authorization", extraHeaders);
1462
2561
  }
1463
2562
  /**
1464
2563
  * Unlinks the related Nintendo account from the user's PlayFab account.
1465
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount
2564
+ *
2565
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount Microsoft Documentation}
2566
+ * @example
2567
+ * await clientClient.UnlinkNintendoServiceAccount({});
1466
2568
  */
1467
2569
  UnlinkNintendoServiceAccount(request, extraHeaders) {
1468
2570
  return this.ExecuteRequestWrapper("/Client/UnlinkNintendoServiceAccount", request, "X-Authorization", extraHeaders);
1469
2571
  }
1470
2572
  /**
1471
2573
  * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
1472
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid
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
+ * });
1473
2580
  */
1474
2581
  UnlinkNintendoSwitchDeviceId(request, extraHeaders) {
1475
2582
  return this.ExecuteRequestWrapper("/Client/UnlinkNintendoSwitchDeviceId", request, "X-Authorization", extraHeaders);
@@ -1477,35 +2584,52 @@ var PlayFabClientApi = class extends PlayFabCommon {
1477
2584
  /**
1478
2585
  * Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
1479
2586
  * between a title and an Open ID Connect provider.
1480
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect
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
+ * });
1481
2593
  */
1482
2594
  UnlinkOpenIdConnect(request, extraHeaders) {
1483
2595
  return this.ExecuteRequestWrapper("/Client/UnlinkOpenIdConnect", request, "X-Authorization", extraHeaders);
1484
2596
  }
1485
2597
  /**
1486
2598
  * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
1487
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount
2599
+ *
2600
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount Microsoft Documentation}
2601
+ * @example
2602
+ * await clientClient.UnlinkPSNAccount({});
1488
2603
  */
1489
2604
  UnlinkPSNAccount(request, extraHeaders) {
1490
2605
  return this.ExecuteRequestWrapper("/Client/UnlinkPSNAccount", request, "X-Authorization", extraHeaders);
1491
2606
  }
1492
2607
  /**
1493
2608
  * Unlinks the related Steam account from the user's PlayFab account
1494
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount
2609
+ *
2610
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount Microsoft Documentation}
2611
+ * @example
2612
+ * await clientClient.UnlinkSteamAccount({});
1495
2613
  */
1496
2614
  UnlinkSteamAccount(request, extraHeaders) {
1497
2615
  return this.ExecuteRequestWrapper("/Client/UnlinkSteamAccount", request, "X-Authorization", extraHeaders);
1498
2616
  }
1499
2617
  /**
1500
2618
  * Unlinks the related Twitch account from the user's PlayFab account.
1501
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch
2619
+ *
2620
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch Microsoft Documentation}
2621
+ * @example
2622
+ * await clientClient.UnlinkTwitch({});
1502
2623
  */
1503
2624
  UnlinkTwitch(request, extraHeaders) {
1504
2625
  return this.ExecuteRequestWrapper("/Client/UnlinkTwitch", request, "X-Authorization", extraHeaders);
1505
2626
  }
1506
2627
  /**
1507
2628
  * Unlinks the related Xbox Live account from the user's PlayFab account
1508
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount
2629
+ *
2630
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount Microsoft Documentation}
2631
+ * @example
2632
+ * await clientClient.UnlinkXboxAccount({});
1509
2633
  */
1510
2634
  UnlinkXboxAccount(request, extraHeaders) {
1511
2635
  return this.ExecuteRequestWrapper("/Client/UnlinkXboxAccount", request, "X-Authorization", extraHeaders);
@@ -1515,7 +2639,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
1515
2639
  * version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
1516
2640
  * opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will
1517
2641
  * be decremented, consistent with the operation of ConsumeItem.
1518
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance
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
+ * });
1519
2649
  */
1520
2650
  UnlockContainerInstance(request, extraHeaders) {
1521
2651
  return this.ExecuteRequestWrapper("/Client/UnlockContainerInstance", request, "X-Authorization", extraHeaders);
@@ -1525,21 +2655,43 @@ var PlayFabClientApi = class extends PlayFabCommon {
1525
2655
  * version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
1526
2656
  * using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are
1527
2657
  * consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
1528
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem
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
+ * });
1529
2664
  */
1530
2665
  UnlockContainerItem(request, extraHeaders) {
1531
2666
  return this.ExecuteRequestWrapper("/Client/UnlockContainerItem", request, "X-Authorization", extraHeaders);
1532
2667
  }
1533
2668
  /**
1534
2669
  * Update the avatar URL of the player
1535
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl
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
+ * });
1536
2676
  */
1537
2677
  UpdateAvatarUrl(request, extraHeaders) {
1538
2678
  return this.ExecuteRequestWrapper("/Client/UpdateAvatarUrl", request, "X-Authorization", extraHeaders);
1539
2679
  }
1540
2680
  /**
1541
2681
  * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
1542
- * https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata
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
+ * });
1543
2695
  */
1544
2696
  UpdateCharacterData(request, extraHeaders) {
1545
2697
  return this.ExecuteRequestWrapper("/Client/UpdateCharacterData", request, "X-Authorization", extraHeaders);
@@ -1547,14 +2699,38 @@ var PlayFabClientApi = class extends PlayFabCommon {
1547
2699
  /**
1548
2700
  * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
1549
2701
  * permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
1550
- * https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics
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
+ * });
1551
2712
  */
1552
2713
  UpdateCharacterStatistics(request, extraHeaders) {
1553
2714
  return this.ExecuteRequestWrapper("/Client/UpdateCharacterStatistics", request, "X-Authorization", extraHeaders);
1554
2715
  }
1555
2716
  /**
1556
2717
  * Updates the title-specific custom property values for a player
1557
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties
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
+ * });
1558
2734
  */
1559
2735
  UpdatePlayerCustomProperties(request, extraHeaders) {
1560
2736
  return this.ExecuteRequestWrapper("/Client/UpdatePlayerCustomProperties", request, "X-Authorization", extraHeaders);
@@ -1562,7 +2738,27 @@ var PlayFabClientApi = class extends PlayFabCommon {
1562
2738
  /**
1563
2739
  * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
1564
2740
  * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
1565
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics
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
+ * });
1566
2762
  */
1567
2763
  UpdatePlayerStatistics(request, extraHeaders) {
1568
2764
  return this.ExecuteRequestWrapper("/Client/UpdatePlayerStatistics", request, "X-Authorization", extraHeaders);
@@ -1573,28 +2769,75 @@ var PlayFabClientApi = class extends PlayFabCommon {
1573
2769
  * Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for
1574
2770
  * sharing data between a very small number of players, please see our guide:
1575
2771
  * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1576
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata
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
+ * });
1577
2783
  */
1578
2784
  UpdateSharedGroupData(request, extraHeaders) {
1579
2785
  return this.ExecuteRequestWrapper("/Client/UpdateSharedGroupData", request, "X-Authorization", extraHeaders);
1580
2786
  }
1581
2787
  /**
1582
2788
  * Creates and updates the title-specific custom data for the user which is readable and writable by the client
1583
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata
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
+ * });
1584
2801
  */
1585
2802
  UpdateUserData(request, extraHeaders) {
1586
2803
  return this.ExecuteRequestWrapper("/Client/UpdateUserData", request, "X-Authorization", extraHeaders);
1587
2804
  }
1588
2805
  /**
1589
2806
  * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client
1590
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata
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
+ * });
1591
2819
  */
1592
2820
  UpdateUserPublisherData(request, extraHeaders) {
1593
2821
  return this.ExecuteRequestWrapper("/Client/UpdateUserPublisherData", request, "X-Authorization", extraHeaders);
1594
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
+ }
1595
2833
  /**
1596
2834
  * Updates the title specific display name for the user
1597
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname
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
+ * });
1598
2841
  */
1599
2842
  UpdateUserTitleDisplayName(request, extraHeaders) {
1600
2843
  return this.ExecuteRequestWrapper("/Client/UpdateUserTitleDisplayName", request, "X-Authorization", extraHeaders);
@@ -1603,7 +2846,13 @@ var PlayFabClientApi = class extends PlayFabCommon {
1603
2846
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1604
2847
  * version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
1605
2848
  * the purchased catalog item
1606
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt
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
+ * });
1607
2856
  */
1608
2857
  ValidateAmazonIAPReceipt(request, extraHeaders) {
1609
2858
  return this.ExecuteRequestWrapper("/Client/ValidateAmazonIAPReceipt", request, "X-Authorization", extraHeaders);
@@ -1611,7 +2860,15 @@ var PlayFabClientApi = class extends PlayFabCommon {
1611
2860
  /**
1612
2861
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1613
2862
  * version 2._ Validates a Google Play purchase and gives the corresponding item to the player.
1614
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase
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
+ * });
1615
2872
  */
1616
2873
  ValidateGooglePlayPurchase(request, extraHeaders) {
1617
2874
  return this.ExecuteRequestWrapper("/Client/ValidateGooglePlayPurchase", request, "X-Authorization", extraHeaders);
@@ -1620,7 +2877,14 @@ var PlayFabClientApi = class extends PlayFabCommon {
1620
2877
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1621
2878
  * version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
1622
2879
  * purchased catalog item
1623
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt
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
+ * });
1624
2888
  */
1625
2889
  ValidateIOSReceipt(request, extraHeaders) {
1626
2890
  return this.ExecuteRequestWrapper("/Client/ValidateIOSReceipt", request, "X-Authorization", extraHeaders);
@@ -1629,28 +2893,71 @@ var PlayFabClientApi = class extends PlayFabCommon {
1629
2893
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1630
2894
  * version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
1631
2895
  * matches the purchased catalog item
1632
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt
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
+ * });
1633
2902
  */
1634
2903
  ValidateWindowsStoreReceipt(request, extraHeaders) {
1635
2904
  return this.ExecuteRequestWrapper("/Client/ValidateWindowsStoreReceipt", request, "X-Authorization", extraHeaders);
1636
2905
  }
1637
2906
  /**
1638
2907
  * Writes a character-based event into PlayStream.
1639
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent
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
+ * });
1640
2924
  */
1641
2925
  WriteCharacterEvent(request, extraHeaders) {
1642
2926
  return this.ExecuteRequestWrapper("/Client/WriteCharacterEvent", request, "X-Authorization", extraHeaders);
1643
2927
  }
1644
2928
  /**
1645
2929
  * Writes a player-based event into PlayStream.
1646
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent
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
+ * });
1647
2945
  */
1648
2946
  WritePlayerEvent(request, extraHeaders) {
1649
2947
  return this.ExecuteRequestWrapper("/Client/WritePlayerEvent", request, "X-Authorization", extraHeaders);
1650
2948
  }
1651
2949
  /**
1652
2950
  * Writes a title-based event into PlayStream.
1653
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent
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
+ * });
1654
2961
  */
1655
2962
  WriteTitleEvent(request, extraHeaders) {
1656
2963
  return this.ExecuteRequestWrapper("/Client/WriteTitleEvent", request, "X-Authorization", extraHeaders);
@@ -1660,4 +2967,4 @@ var PlayFabClientApi = class extends PlayFabCommon {
1660
2967
  export {
1661
2968
  PlayFabClientApi
1662
2969
  };
1663
- //# sourceMappingURL=chunk-FEEE3PRD.js.map
2970
+ //# sourceMappingURL=chunk-SR2RIRLX.js.map