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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/dist/Addon.d.ts +31 -31
  2. package/dist/Addon.js +4 -448
  3. package/dist/Addon.js.map +1 -1
  4. package/dist/Admin.d.ts +118 -118
  5. package/dist/Admin.js +4 -1108
  6. package/dist/Admin.js.map +1 -1
  7. package/dist/Authentication.d.ts +5 -5
  8. package/dist/Authentication.js +4 -286
  9. package/dist/Authentication.js.map +1 -1
  10. package/dist/Client.d.ts +174 -174
  11. package/dist/Client.js +4 -1889
  12. package/dist/Client.js.map +1 -1
  13. package/dist/CloudScript.d.ts +16 -16
  14. package/dist/CloudScript.js +4 -345
  15. package/dist/CloudScript.js.map +1 -1
  16. package/dist/Data.d.ts +8 -8
  17. package/dist/Data.js +4 -287
  18. package/dist/Data.js.map +1 -1
  19. package/dist/Economy.d.ts +47 -47
  20. package/dist/Economy.js +4 -610
  21. package/dist/Economy.js.map +1 -1
  22. package/dist/Events.d.ts +13 -13
  23. package/dist/Events.js +4 -323
  24. package/dist/Events.js.map +1 -1
  25. package/dist/Experimentation.d.ts +14 -14
  26. package/dist/Experimentation.js +4 -329
  27. package/dist/Experimentation.js.map +1 -1
  28. package/dist/Groups.d.ts +26 -26
  29. package/dist/Groups.js +4 -413
  30. package/dist/Groups.js.map +1 -1
  31. package/dist/Insights.d.ts +7 -7
  32. package/dist/Insights.js +4 -282
  33. package/dist/Insights.js.map +1 -1
  34. package/dist/Localization.d.ts +2 -2
  35. package/dist/Localization.js +4 -245
  36. package/dist/Localization.js.map +1 -1
  37. package/dist/Multiplayer.d.ts +88 -88
  38. package/dist/Multiplayer.js +4 -858
  39. package/dist/Multiplayer.js.map +1 -1
  40. package/dist/{PlayFabCommon-BUv4zqXf.d.ts → PlayFabCommon-BX3jSqGx.d.ts} +4 -6
  41. package/dist/Profiles.d.ts +10 -10
  42. package/dist/Profiles.js +4 -302
  43. package/dist/Profiles.js.map +1 -1
  44. package/dist/Progression.d.ts +24 -24
  45. package/dist/Progression.js +4 -400
  46. package/dist/Progression.js.map +1 -1
  47. package/dist/Server.d.ts +150 -150
  48. package/dist/Server.js +4 -1373
  49. package/dist/Server.js.map +1 -1
  50. package/dist/chunk-3FCAP7OZ.js +187 -0
  51. package/dist/chunk-3FCAP7OZ.js.map +1 -0
  52. package/dist/chunk-62SULWOK.js +195 -0
  53. package/dist/chunk-62SULWOK.js.map +1 -0
  54. package/dist/chunk-A7VD6ALV.js +222 -0
  55. package/dist/chunk-A7VD6ALV.js.map +1 -0
  56. package/dist/chunk-BX65UND2.js +632 -0
  57. package/dist/chunk-BX65UND2.js.map +1 -0
  58. package/dist/chunk-J4QS5VX5.js +19 -0
  59. package/dist/chunk-J4QS5VX5.js.map +1 -0
  60. package/dist/chunk-JGDO2ZE3.js +1663 -0
  61. package/dist/chunk-JGDO2ZE3.js.map +1 -0
  62. package/dist/chunk-POMI7LEF.js +76 -0
  63. package/dist/chunk-POMI7LEF.js.map +1 -0
  64. package/dist/chunk-Q3OF3AOJ.js +97 -0
  65. package/dist/chunk-Q3OF3AOJ.js.map +1 -0
  66. package/dist/chunk-QUZHVSVZ.js +174 -0
  67. package/dist/chunk-QUZHVSVZ.js.map +1 -0
  68. package/dist/chunk-QVLIVSO4.js +1147 -0
  69. package/dist/chunk-QVLIVSO4.js.map +1 -0
  70. package/dist/chunk-R7V7DFCF.js +103 -0
  71. package/dist/chunk-R7V7DFCF.js.map +1 -0
  72. package/dist/chunk-SGSEOIKS.js +56 -0
  73. package/dist/chunk-SGSEOIKS.js.map +1 -0
  74. package/dist/chunk-UOHHNVCJ.js +119 -0
  75. package/dist/chunk-UOHHNVCJ.js.map +1 -0
  76. package/dist/chunk-USKFWNQK.js +384 -0
  77. package/dist/chunk-USKFWNQK.js.map +1 -0
  78. package/dist/chunk-UX7LFJCX.js +61 -0
  79. package/dist/chunk-UX7LFJCX.js.map +1 -0
  80. package/dist/chunk-X34XZJB6.js +60 -0
  81. package/dist/chunk-X34XZJB6.js.map +1 -0
  82. package/dist/chunk-YNZF3WXS.js +882 -0
  83. package/dist/chunk-YNZF3WXS.js.map +1 -0
  84. package/dist/index.d.ts +1 -1
  85. package/dist/index.js +49 -5988
  86. package/dist/index.js.map +1 -1
  87. package/package.json +1 -1
package/dist/Client.js CHANGED
@@ -1,1892 +1,7 @@
1
- // src/constants.ts
2
- var AuthInfoMap = {
3
- "X-EntityToken": {
4
- authAttr: "entityToken",
5
- authError: "errorEntityToken"
6
- },
7
- "X-Authorization": {
8
- authAttr: "sessionTicket",
9
- authError: "errorLoggedIn"
10
- },
11
- "X-SecretKey": {
12
- authAttr: "developerSecretKey",
13
- authError: "errorSecretKey"
14
- }
15
- };
16
- var constants_default = {
17
- sdkVersion: "1.192.250526",
18
- sdkFingerprint: "JavaScriptSDK-1.192.250526",
19
- buildIdentifier: "custom_async-javascriptsdk",
20
- defaultSettings: {
21
- titleId: "",
22
- developerSecretKey: "",
23
- GlobalHeaderInjection: {},
24
- productionServerUrl: ".playfabapi.com",
25
- verticalName: null
26
- }
27
- };
28
-
29
- // src/PlayFabContext.ts
30
- var PlayFabContext = class _PlayFabContext {
31
- constructor() {
32
- this.settings = constants_default.defaultSettings;
33
- this.authenticationContext = {
34
- PlayFabId: null,
35
- EntityId: null,
36
- EntityType: null,
37
- SessionTicket: null,
38
- EntityToken: null
39
- };
40
- this.sessionTicket = null;
41
- this.entityToken = null;
42
- }
43
- static get instance() {
44
- if (!_PlayFabContext._instance) {
45
- _PlayFabContext._instance = new _PlayFabContext();
46
- }
47
- return _PlayFabContext._instance;
48
- }
49
- };
50
-
51
- // src/PlayFabCommon.ts
52
- var PlayFabCommon = class {
53
- constructor(settings = void 0) {
54
- this.buildIdentifier = constants_default.buildIdentifier;
55
- this.requestGetParams = {
56
- sdk: constants_default.sdkFingerprint
57
- };
58
- this.errorTitleId = "Must be have settings.titleId set to call this method";
59
- this.errorLoggedIn = "Must be logged in to call this method";
60
- this.errorEntityToken = "You must successfully call GetEntityToken before calling this";
61
- this.errorSecretKey = "Must have settings.developerSecretKey set to call this method";
62
- this._context = PlayFabContext.instance;
63
- if (settings) {
64
- Object.assign(this._context.settings, settings);
65
- }
66
- }
67
- get settings() {
68
- return this._context.settings;
69
- }
70
- get authenticationContext() {
71
- return this._context.authenticationContext;
72
- }
73
- get sessionTicket() {
74
- return this._context.sessionTicket;
75
- }
76
- set sessionTicket(value) {
77
- this._context.sessionTicket = value;
78
- }
79
- get entityToken() {
80
- return this._context.entityToken;
81
- }
82
- set entityToken(value) {
83
- this._context.entityToken = value;
84
- }
85
- GetServerUrl() {
86
- if (!(this.settings.productionServerUrl.substring(0, 4) === "http")) {
87
- return `https://${this.settings.verticalName || this.settings.titleId}${this.settings.productionServerUrl}`;
88
- } else {
89
- return this.settings.productionServerUrl;
90
- }
91
- }
92
- InjectHeaders(xhr, headersObj) {
93
- if (!headersObj) return;
94
- for (const headerKey in headersObj) {
95
- try {
96
- xhr.setRequestHeader(headerKey, headersObj[headerKey]);
97
- } catch (e) {
98
- console.log(
99
- `Failed to append header: ${headerKey} = ${headersObj[headerKey]} Error: ${e}`
100
- );
101
- }
102
- }
103
- }
104
- ExecuteRequest(url, body, authkey, authValue, customData, extraHeaders) {
105
- return new Promise((resolve, reject) => {
106
- if (body == null) body = {};
107
- var startTime = (/* @__PURE__ */ new Date()).getTime();
108
- var requestBody = JSON.stringify(body);
109
- var urlArr = [url];
110
- var getParams = this.requestGetParams;
111
- if (getParams != null) {
112
- var firstParam = true;
113
- for (var key in getParams) {
114
- if (firstParam) {
115
- urlArr.push("?");
116
- firstParam = false;
117
- } else {
118
- urlArr.push("&");
119
- }
120
- urlArr.push(key);
121
- urlArr.push("=");
122
- urlArr.push(getParams[key]);
123
- }
124
- }
125
- var completeUrl = urlArr.join("");
126
- var xhr = new XMLHttpRequest();
127
- xhr.open("POST", completeUrl, true);
128
- xhr.setRequestHeader("Content-Type", "application/json");
129
- xhr.setRequestHeader(
130
- "X-PlayFabSDK",
131
- "JavaScriptSDK-" + constants_default.sdkVersion
132
- );
133
- if (authkey != null) {
134
- xhr.setRequestHeader(authkey, authValue);
135
- }
136
- this.InjectHeaders(xhr, this.settings.GlobalHeaderInjection);
137
- this.InjectHeaders(xhr, extraHeaders);
138
- xhr.onloadend = () => {
139
- var result = this.GetPlayFabResponse(body, xhr, startTime, customData);
140
- if (result.code === 200) {
141
- resolve(result.data || result);
142
- } else {
143
- reject(result);
144
- }
145
- };
146
- xhr.onerror = () => {
147
- var result = this.GetPlayFabResponse(body, xhr, startTime, customData);
148
- reject(result);
149
- };
150
- xhr.send(requestBody);
151
- });
152
- }
153
- GetPlayFabResponse(request, xhr, startTime, customData) {
154
- var result = null;
155
- try {
156
- result = JSON.parse(xhr.responseText);
157
- } catch (e) {
158
- result = {
159
- code: 503,
160
- // Service Unavailable
161
- status: "Service Unavailable",
162
- error: "Connection error",
163
- errorCode: 2,
164
- // PlayFabErrorCode.ConnectionError
165
- errorMessage: xhr.responseText
166
- };
167
- }
168
- result.CallBackTimeMS = (/* @__PURE__ */ new Date()).getTime() - startTime;
169
- result.Request = request;
170
- result.CustomData = customData;
171
- return result;
172
- }
173
- UpdateAuthenticationContext(currentAuthContext, result) {
174
- var authenticationContextUpdates = {};
175
- if (result == null ? void 0 : result.PlayFabId) {
176
- authenticationContextUpdates.PlayFabId = result.PlayFabId;
177
- }
178
- if (result == null ? void 0 : result.SessionTicket) {
179
- authenticationContextUpdates.SessionTicket = result.SessionTicket;
180
- }
181
- if (result == null ? void 0 : result.EntityToken) {
182
- authenticationContextUpdates.EntityId = result.EntityToken.Entity.Id;
183
- authenticationContextUpdates.EntityType = result.EntityToken.Entity.Type;
184
- authenticationContextUpdates.EntityToken = result.EntityToken.EntityToken;
185
- }
186
- currentAuthContext = Object.assign(
187
- currentAuthContext,
188
- authenticationContextUpdates
189
- );
190
- this._context.authenticationContext = currentAuthContext;
191
- return currentAuthContext;
192
- }
193
- GetAuthInfo(request, authKey) {
194
- var authError = AuthInfoMap[authKey].authError;
195
- var authAttr = AuthInfoMap[authKey].authAttr;
196
- var defaultAuthValue = null;
197
- if (authAttr === "entityToken") defaultAuthValue = this.entityToken;
198
- else if (authAttr === "sessionTicket")
199
- defaultAuthValue = this.sessionTicket;
200
- else if (authAttr === "developerSecretKey")
201
- defaultAuthValue = this.settings.developerSecretKey;
202
- var authValue = request.AuthenticationContext ? request.AuthenticationContext[authAttr] : defaultAuthValue;
203
- return { authKey, authValue, authError };
204
- }
205
- ExecuteRequestWrapper(apiURL, request, authKey, customData, extraHeaders) {
206
- var authValue = null;
207
- if (authKey !== null) {
208
- const { authError, ...authInfo } = this.GetAuthInfo(request, authKey);
209
- authKey = authInfo.authKey;
210
- authValue = authInfo.authValue;
211
- if (!authValue) throw authError;
212
- }
213
- return this.ExecuteRequest(
214
- this.GetServerUrl() + apiURL,
215
- request,
216
- authKey,
217
- authValue,
218
- customData,
219
- extraHeaders
220
- );
221
- }
222
- GenerateErrorReport(error) {
223
- if (error == null) return "";
224
- var fullErrors = error.errorMessage;
225
- for (var paramName in error.errorDetails)
226
- for (var msgIdx in error.errorDetails[paramName])
227
- fullErrors += "\n" + paramName + ": " + error.errorDetails[paramName][msgIdx];
228
- return fullErrors;
229
- }
230
- ForgetAllCredentials() {
231
- this._context.sessionTicket = null;
232
- this._context.entityToken = null;
233
- }
234
- };
235
-
236
- // src/apis/PlayFabClientApi.ts
237
- var PlayFabClientApi = class extends PlayFabCommon {
238
- IsClientLoggedIn() {
239
- return this.sessionTicket != null && this.sessionTicket.length > 0;
240
- }
241
- /**
242
- * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
243
- * allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
244
- * items will be swapped between the two players' inventories.
245
- * https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade
246
- */
247
- AcceptTrade(request, customData, extraHeaders) {
248
- return this.ExecuteRequestWrapper("/Client/AcceptTrade", request, "X-Authorization", customData, extraHeaders);
249
- }
250
- /**
251
- * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
252
- * least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
253
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
254
- */
255
- AddFriend(request, customData, extraHeaders) {
256
- return this.ExecuteRequestWrapper("/Client/AddFriend", request, "X-Authorization", customData, extraHeaders);
257
- }
258
- /**
259
- * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
260
- * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
261
- * authentication credentials, as the intent is that it is easily accessible by other players.
262
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid
263
- */
264
- AddGenericID(request, customData, extraHeaders) {
265
- return this.ExecuteRequestWrapper("/Client/AddGenericID", request, "X-Authorization", customData, extraHeaders);
266
- }
267
- /**
268
- * Adds or updates a contact email to the player's profile.
269
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
270
- */
271
- AddOrUpdateContactEmail(request, customData, extraHeaders) {
272
- return this.ExecuteRequestWrapper("/Client/AddOrUpdateContactEmail", request, "X-Authorization", customData, extraHeaders);
273
- }
274
- /**
275
- * 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
276
- * in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
277
- * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
278
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers
279
- */
280
- AddSharedGroupMembers(request, customData, extraHeaders) {
281
- return this.ExecuteRequestWrapper("/Client/AddSharedGroupMembers", request, "X-Authorization", customData, extraHeaders);
282
- }
283
- /**
284
- * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
285
- * ID login.
286
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
287
- */
288
- AddUsernamePassword(request, customData, extraHeaders) {
289
- return this.ExecuteRequestWrapper("/Client/AddUsernamePassword", request, "X-Authorization", customData, extraHeaders);
290
- }
291
- /**
292
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
293
- * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
294
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency
295
- */
296
- AddUserVirtualCurrency(request, customData, extraHeaders) {
297
- return this.ExecuteRequestWrapper("/Client/AddUserVirtualCurrency", request, "X-Authorization", customData, extraHeaders);
298
- }
299
- /**
300
- * Registers the Android device to receive push notifications
301
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
302
- */
303
- AndroidDevicePushNotificationRegistration(request, customData, extraHeaders) {
304
- return this.ExecuteRequestWrapper("/Client/AndroidDevicePushNotificationRegistration", request, "X-Authorization", customData, extraHeaders);
305
- }
306
- /**
307
- * Attributes an install for advertisment.
308
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
309
- */
310
- AttributeInstall(request, customData, extraHeaders) {
311
- return this.ExecuteRequestWrapper("/Client/AttributeInstall", request, "X-Authorization", customData, extraHeaders);
312
- }
313
- /**
314
- * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
315
- * can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
316
- * players from accepting them, for trades that can be claimed by more than one player).
317
- * https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade
318
- */
319
- CancelTrade(request, customData, extraHeaders) {
320
- return this.ExecuteRequestWrapper("/Client/CancelTrade", request, "X-Authorization", customData, extraHeaders);
321
- }
322
- /**
323
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
324
- * version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
325
- * virtual currency balances as appropriate
326
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
327
- */
328
- ConfirmPurchase(request, customData, extraHeaders) {
329
- return this.ExecuteRequestWrapper("/Client/ConfirmPurchase", request, "X-Authorization", customData, extraHeaders);
330
- }
331
- /**
332
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
333
- * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
334
- * inventory.
335
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
336
- */
337
- ConsumeItem(request, customData, extraHeaders) {
338
- return this.ExecuteRequestWrapper("/Client/ConsumeItem", request, "X-Authorization", customData, extraHeaders);
339
- }
340
- /**
341
- * Grants the player's current entitlements from Microsoft Store's Collection API
342
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements
343
- */
344
- ConsumeMicrosoftStoreEntitlements(request, customData, extraHeaders) {
345
- return this.ExecuteRequestWrapper("/Client/ConsumeMicrosoftStoreEntitlements", request, "X-Authorization", customData, extraHeaders);
346
- }
347
- /**
348
- * Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
349
- * PlayFab items
350
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements
351
- */
352
- ConsumePS5Entitlements(request, customData, extraHeaders) {
353
- return this.ExecuteRequestWrapper("/Client/ConsumePS5Entitlements", request, "X-Authorization", customData, extraHeaders);
354
- }
355
- /**
356
- * Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
357
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements
358
- */
359
- ConsumePSNEntitlements(request, customData, extraHeaders) {
360
- return this.ExecuteRequestWrapper("/Client/ConsumePSNEntitlements", request, "X-Authorization", customData, extraHeaders);
361
- }
362
- /**
363
- * Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
364
- * player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
365
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements
366
- */
367
- ConsumeXboxEntitlements(request, customData, extraHeaders) {
368
- return this.ExecuteRequestWrapper("/Client/ConsumeXboxEntitlements", request, "X-Authorization", customData, extraHeaders);
369
- }
370
- /**
371
- * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
372
- * group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
373
- * between a very small number of players, please see our guide:
374
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
375
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup
376
- */
377
- CreateSharedGroup(request, customData, extraHeaders) {
378
- return this.ExecuteRequestWrapper("/Client/CreateSharedGroup", request, "X-Authorization", customData, extraHeaders);
379
- }
380
- /**
381
- * Deletes title-specific custom properties for a player
382
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties
383
- */
384
- DeletePlayerCustomProperties(request, customData, extraHeaders) {
385
- return this.ExecuteRequestWrapper("/Client/DeletePlayerCustomProperties", request, "X-Authorization", customData, extraHeaders);
386
- }
387
- /**
388
- * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
389
- * PlayFab ID is the entity ID of the player's master_player_account entity.
390
- * https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript
391
- */
392
- ExecuteCloudScript(request, customData, extraHeaders) {
393
- return this.ExecuteRequestWrapper("/Client/ExecuteCloudScript", request, "X-Authorization", customData, extraHeaders);
394
- }
395
- /**
396
- * Retrieves the user's PlayFab account details
397
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
398
- */
399
- GetAccountInfo(request, customData, extraHeaders) {
400
- return this.ExecuteRequestWrapper("/Client/GetAccountInfo", request, "X-Authorization", customData, extraHeaders);
401
- }
402
- /**
403
- * Returns a list of ad placements and a reward for each
404
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements
405
- */
406
- GetAdPlacements(request, customData, extraHeaders) {
407
- return this.ExecuteRequestWrapper("/Client/GetAdPlacements", request, "X-Authorization", customData, extraHeaders);
408
- }
409
- /**
410
- * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
411
- * evaluated with the parent PlayFabId to guarantee uniqueness.
412
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
413
- */
414
- GetAllUsersCharacters(request, customData, extraHeaders) {
415
- return this.ExecuteRequestWrapper("/Client/GetAllUsersCharacters", request, "X-Authorization", customData, extraHeaders);
416
- }
417
- /**
418
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
419
- * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
420
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems
421
- */
422
- GetCatalogItems(request, customData, extraHeaders) {
423
- return this.ExecuteRequestWrapper("/Client/GetCatalogItems", request, "X-Authorization", customData, extraHeaders);
424
- }
425
- /**
426
- * Retrieves the title-specific custom data for the character which is readable and writable by the client
427
- * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata
428
- */
429
- GetCharacterData(request, customData, extraHeaders) {
430
- return this.ExecuteRequestWrapper("/Client/GetCharacterData", request, "X-Authorization", customData, extraHeaders);
431
- }
432
- /**
433
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
434
- * version 2._ Retrieves the specified character's current inventory of virtual goods
435
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory
436
- */
437
- GetCharacterInventory(request, customData, extraHeaders) {
438
- return this.ExecuteRequestWrapper("/Client/GetCharacterInventory", request, "X-Authorization", customData, extraHeaders);
439
- }
440
- /**
441
- * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
442
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard
443
- */
444
- GetCharacterLeaderboard(request, customData, extraHeaders) {
445
- return this.ExecuteRequestWrapper("/Client/GetCharacterLeaderboard", request, "X-Authorization", customData, extraHeaders);
446
- }
447
- /**
448
- * Retrieves the title-specific custom data for the character which can only be read by the client
449
- * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata
450
- */
451
- GetCharacterReadOnlyData(request, customData, extraHeaders) {
452
- return this.ExecuteRequestWrapper("/Client/GetCharacterReadOnlyData", request, "X-Authorization", customData, extraHeaders);
453
- }
454
- /**
455
- * Retrieves the details of all title-specific statistics for the user
456
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
457
- */
458
- GetCharacterStatistics(request, customData, extraHeaders) {
459
- return this.ExecuteRequestWrapper("/Client/GetCharacterStatistics", request, "X-Authorization", customData, extraHeaders);
460
- }
461
- /**
462
- * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
463
- * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
464
- * content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
465
- * the query to retrieve the data will fail. See this post for more information:
466
- * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
467
- * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
468
- * https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl
469
- */
470
- GetContentDownloadUrl(request, customData, extraHeaders) {
471
- return this.ExecuteRequestWrapper("/Client/GetContentDownloadUrl", request, "X-Authorization", customData, extraHeaders);
472
- }
473
- /**
474
- * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
475
- * the leaderboard
476
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard
477
- */
478
- GetFriendLeaderboard(request, customData, extraHeaders) {
479
- return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboard", request, "X-Authorization", customData, extraHeaders);
480
- }
481
- /**
482
- * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
483
- * user. If PlayFabId is empty or null will return currently logged in user.
484
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer
485
- */
486
- GetFriendLeaderboardAroundPlayer(request, customData, extraHeaders) {
487
- return this.ExecuteRequestWrapper("/Client/GetFriendLeaderboardAroundPlayer", request, "X-Authorization", customData, extraHeaders);
488
- }
489
- /**
490
- * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
491
- * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
492
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist
493
- */
494
- GetFriendsList(request, customData, extraHeaders) {
495
- return this.ExecuteRequestWrapper("/Client/GetFriendsList", request, "X-Authorization", customData, extraHeaders);
496
- }
497
- /**
498
- * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
499
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard
500
- */
501
- GetLeaderboard(request, customData, extraHeaders) {
502
- return this.ExecuteRequestWrapper("/Client/GetLeaderboard", request, "X-Authorization", customData, extraHeaders);
503
- }
504
- /**
505
- * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
506
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter
507
- */
508
- GetLeaderboardAroundCharacter(request, customData, extraHeaders) {
509
- return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundCharacter", request, "X-Authorization", customData, extraHeaders);
510
- }
511
- /**
512
- * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
513
- * null will return currently logged in user.
514
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
515
- */
516
- GetLeaderboardAroundPlayer(request, customData, extraHeaders) {
517
- return this.ExecuteRequestWrapper("/Client/GetLeaderboardAroundPlayer", request, "X-Authorization", customData, extraHeaders);
518
- }
519
- /**
520
- * Retrieves a list of all of the user's characters for the given statistic.
521
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters
522
- */
523
- GetLeaderboardForUserCharacters(request, customData, extraHeaders) {
524
- return this.ExecuteRequestWrapper("/Client/GetLeaderboardForUserCharacters", request, "X-Authorization", customData, extraHeaders);
525
- }
526
- /**
527
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
528
- * version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
529
- * client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
530
- * client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
531
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken
532
- */
533
- GetPaymentToken(request, customData, extraHeaders) {
534
- return this.ExecuteRequestWrapper("/Client/GetPaymentToken", request, "X-Authorization", customData, extraHeaders);
535
- }
536
- /**
537
- * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
538
- * https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
539
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
540
- */
541
- GetPhotonAuthenticationToken(request, customData, extraHeaders) {
542
- return this.ExecuteRequestWrapper("/Client/GetPhotonAuthenticationToken", request, "X-Authorization", customData, extraHeaders);
543
- }
544
- /**
545
- * Retrieves all of the user's different kinds of info.
546
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo
547
- */
548
- GetPlayerCombinedInfo(request, customData, extraHeaders) {
549
- return this.ExecuteRequestWrapper("/Client/GetPlayerCombinedInfo", request, "X-Authorization", customData, extraHeaders);
550
- }
551
- /**
552
- * Retrieves a title-specific custom property value for a player.
553
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
554
- */
555
- GetPlayerCustomProperty(request, customData, extraHeaders) {
556
- return this.ExecuteRequestWrapper("/Client/GetPlayerCustomProperty", request, "X-Authorization", customData, extraHeaders);
557
- }
558
- /**
559
- * Retrieves the player's profile
560
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
561
- */
562
- GetPlayerProfile(request, customData, extraHeaders) {
563
- return this.ExecuteRequestWrapper("/Client/GetPlayerProfile", request, "X-Authorization", customData, extraHeaders);
564
- }
565
- /**
566
- * List all segments that a player currently belongs to at this moment in time.
567
- * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments
568
- */
569
- GetPlayerSegments(request, customData, extraHeaders) {
570
- return this.ExecuteRequestWrapper("/Client/GetPlayerSegments", request, "X-Authorization", customData, extraHeaders);
571
- }
572
- /**
573
- * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
574
- * player.
575
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics
576
- */
577
- GetPlayerStatistics(request, customData, extraHeaders) {
578
- return this.ExecuteRequestWrapper("/Client/GetPlayerStatistics", request, "X-Authorization", customData, extraHeaders);
579
- }
580
- /**
581
- * Retrieves the information on the available versions of the specified statistic.
582
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
583
- */
584
- GetPlayerStatisticVersions(request, customData, extraHeaders) {
585
- return this.ExecuteRequestWrapper("/Client/GetPlayerStatisticVersions", request, "X-Authorization", customData, extraHeaders);
586
- }
587
- /**
588
- * Get all tags with a given Namespace (optional) from a player profile.
589
- * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
590
- */
591
- GetPlayerTags(request, customData, extraHeaders) {
592
- return this.ExecuteRequestWrapper("/Client/GetPlayerTags", request, "X-Authorization", customData, extraHeaders);
593
- }
594
- /**
595
- * Gets all trades the player has either opened or accepted, optionally filtered by trade status.
596
- * https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades
597
- */
598
- GetPlayerTrades(request, customData, extraHeaders) {
599
- return this.ExecuteRequestWrapper("/Client/GetPlayerTrades", request, "X-Authorization", customData, extraHeaders);
600
- }
601
- /**
602
- * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
603
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids
604
- */
605
- GetPlayFabIDsFromBattleNetAccountIds(request, customData, extraHeaders) {
606
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromBattleNetAccountIds", request, "X-Authorization", customData, extraHeaders);
607
- }
608
- /**
609
- * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
610
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids
611
- */
612
- GetPlayFabIDsFromFacebookIDs(request, customData, extraHeaders) {
613
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookIDs", request, "X-Authorization", customData, extraHeaders);
614
- }
615
- /**
616
- * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
617
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids
618
- */
619
- GetPlayFabIDsFromFacebookInstantGamesIds(request, customData, extraHeaders) {
620
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookInstantGamesIds", request, "X-Authorization", customData, extraHeaders);
621
- }
622
- /**
623
- * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
624
- * Programming Guide as the Player Identifier).
625
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids
626
- */
627
- GetPlayFabIDsFromGameCenterIDs(request, customData, extraHeaders) {
628
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGameCenterIDs", request, "X-Authorization", customData, extraHeaders);
629
- }
630
- /**
631
- * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
632
- * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
633
- * added to the player account.
634
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids
635
- */
636
- GetPlayFabIDsFromGenericIDs(request, customData, extraHeaders) {
637
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGenericIDs", request, "X-Authorization", customData, extraHeaders);
638
- }
639
- /**
640
- * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
641
- * the user accounts, available as "id" in the Google+ People API calls.
642
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids
643
- */
644
- GetPlayFabIDsFromGoogleIDs(request, customData, extraHeaders) {
645
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGoogleIDs", request, "X-Authorization", customData, extraHeaders);
646
- }
647
- /**
648
- * Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
649
- * identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
650
- * calls.
651
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids
652
- */
653
- GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request, customData, extraHeaders) {
654
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs", request, "X-Authorization", customData, extraHeaders);
655
- }
656
- /**
657
- * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
658
- * IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
659
- * http://developers.kongregate.com/docs/client/getUserId).
660
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids
661
- */
662
- GetPlayFabIDsFromKongregateIDs(request, customData, extraHeaders) {
663
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromKongregateIDs", request, "X-Authorization", customData, extraHeaders);
664
- }
665
- /**
666
- * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
667
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids
668
- */
669
- GetPlayFabIDsFromNintendoServiceAccountIds(request, customData, extraHeaders) {
670
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoServiceAccountIds", request, "X-Authorization", customData, extraHeaders);
671
- }
672
- /**
673
- * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
674
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids
675
- */
676
- GetPlayFabIDsFromNintendoSwitchDeviceIds(request, customData, extraHeaders) {
677
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-Authorization", customData, extraHeaders);
678
- }
679
- /**
680
- * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
681
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids
682
- */
683
- GetPlayFabIDsFromPSNAccountIDs(request, customData, extraHeaders) {
684
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNAccountIDs", request, "X-Authorization", customData, extraHeaders);
685
- }
686
- /**
687
- * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
688
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids
689
- */
690
- GetPlayFabIDsFromPSNOnlineIDs(request, customData, extraHeaders) {
691
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNOnlineIDs", request, "X-Authorization", customData, extraHeaders);
692
- }
693
- /**
694
- * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
695
- * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
696
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids
697
- */
698
- GetPlayFabIDsFromSteamIDs(request, customData, extraHeaders) {
699
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamIDs", request, "X-Authorization", customData, extraHeaders);
700
- }
701
- /**
702
- * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
703
- * names.
704
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames
705
- */
706
- GetPlayFabIDsFromSteamNames(request, customData, extraHeaders) {
707
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamNames", request, "X-Authorization", customData, extraHeaders);
708
- }
709
- /**
710
- * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
711
- * the user accounts, available as "_id" from the Twitch API methods (ex:
712
- * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
713
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids
714
- */
715
- GetPlayFabIDsFromTwitchIDs(request, customData, extraHeaders) {
716
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromTwitchIDs", request, "X-Authorization", customData, extraHeaders);
717
- }
718
- /**
719
- * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
720
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids
721
- */
722
- GetPlayFabIDsFromXboxLiveIDs(request, customData, extraHeaders) {
723
- return this.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromXboxLiveIDs", request, "X-Authorization", customData, extraHeaders);
724
- }
725
- /**
726
- * Retrieves the key-value store of custom publisher settings
727
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata
728
- */
729
- GetPublisherData(request, customData, extraHeaders) {
730
- return this.ExecuteRequestWrapper("/Client/GetPublisherData", request, "X-Authorization", customData, extraHeaders);
731
- }
732
- /**
733
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
734
- * version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
735
- * are still active.
736
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
737
- */
738
- GetPurchase(request, customData, extraHeaders) {
739
- return this.ExecuteRequestWrapper("/Client/GetPurchase", request, "X-Authorization", customData, extraHeaders);
740
- }
741
- /**
742
- * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group
743
- * may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
744
- * Shared Groups are designed for sharing data between a very small number of players, please see our guide:
745
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
746
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata
747
- */
748
- GetSharedGroupData(request, customData, extraHeaders) {
749
- return this.ExecuteRequestWrapper("/Client/GetSharedGroupData", request, "X-Authorization", customData, extraHeaders);
750
- }
751
- /**
752
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
753
- * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
754
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems
755
- */
756
- GetStoreItems(request, customData, extraHeaders) {
757
- return this.ExecuteRequestWrapper("/Client/GetStoreItems", request, "X-Authorization", customData, extraHeaders);
758
- }
759
- /**
760
- * Retrieves the current server time
761
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
762
- */
763
- GetTime(request, customData, extraHeaders) {
764
- return this.ExecuteRequestWrapper("/Client/GetTime", request, "X-Authorization", customData, extraHeaders);
765
- }
766
- /**
767
- * Retrieves the key-value store of custom title settings
768
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata
769
- */
770
- GetTitleData(request, customData, extraHeaders) {
771
- return this.ExecuteRequestWrapper("/Client/GetTitleData", request, "X-Authorization", customData, extraHeaders);
772
- }
773
- /**
774
- * Retrieves the title news feed, as configured in the developer portal
775
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews
776
- */
777
- GetTitleNews(request, customData, extraHeaders) {
778
- return this.ExecuteRequestWrapper("/Client/GetTitleNews", request, "X-Authorization", customData, extraHeaders);
779
- }
780
- /**
781
- * Returns the title's base 64 encoded RSA CSP blob.
782
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
783
- */
784
- GetTitlePublicKey(request, customData, extraHeaders) {
785
- return this.ExecuteRequestWrapper("/Client/GetTitlePublicKey", request, null, customData, extraHeaders);
786
- }
787
- /**
788
- * Gets the current status of an existing trade.
789
- * https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus
790
- */
791
- GetTradeStatus(request, customData, extraHeaders) {
792
- return this.ExecuteRequestWrapper("/Client/GetTradeStatus", request, "X-Authorization", customData, extraHeaders);
793
- }
794
- /**
795
- * Retrieves the title-specific custom data for the user which is readable and writable by the client
796
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata
797
- */
798
- GetUserData(request, customData, extraHeaders) {
799
- return this.ExecuteRequestWrapper("/Client/GetUserData", request, "X-Authorization", customData, extraHeaders);
800
- }
801
- /**
802
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
803
- * version 2._ Retrieves the user's current inventory of virtual goods
804
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
805
- */
806
- GetUserInventory(request, customData, extraHeaders) {
807
- return this.ExecuteRequestWrapper("/Client/GetUserInventory", request, "X-Authorization", customData, extraHeaders);
808
- }
809
- /**
810
- * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
811
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata
812
- */
813
- GetUserPublisherData(request, customData, extraHeaders) {
814
- return this.ExecuteRequestWrapper("/Client/GetUserPublisherData", request, "X-Authorization", customData, extraHeaders);
815
- }
816
- /**
817
- * Retrieves the publisher-specific custom data for the user which can only be read by the client
818
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata
819
- */
820
- GetUserPublisherReadOnlyData(request, customData, extraHeaders) {
821
- return this.ExecuteRequestWrapper("/Client/GetUserPublisherReadOnlyData", request, "X-Authorization", customData, extraHeaders);
822
- }
823
- /**
824
- * Retrieves the title-specific custom data for the user which can only be read by the client
825
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata
826
- */
827
- GetUserReadOnlyData(request, customData, extraHeaders) {
828
- return this.ExecuteRequestWrapper("/Client/GetUserReadOnlyData", request, "X-Authorization", customData, extraHeaders);
829
- }
830
- /**
831
- * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
832
- * with the parent PlayFabId to guarantee uniqueness.
833
- * https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
834
- */
835
- GrantCharacterToUser(request, customData, extraHeaders) {
836
- return this.ExecuteRequestWrapper("/Client/GrantCharacterToUser", request, "X-Authorization", customData, extraHeaders);
837
- }
838
- /**
839
- * Links the Android device identifier to the user's PlayFab account
840
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
841
- */
842
- LinkAndroidDeviceID(request, customData, extraHeaders) {
843
- return this.ExecuteRequestWrapper("/Client/LinkAndroidDeviceID", request, "X-Authorization", customData, extraHeaders);
844
- }
845
- /**
846
- * Links the Apple account associated with the token to the user's PlayFab account.
847
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple
848
- */
849
- LinkApple(request, customData, extraHeaders) {
850
- return this.ExecuteRequestWrapper("/Client/LinkApple", request, "X-Authorization", customData, extraHeaders);
851
- }
852
- /**
853
- * Links the Battle.net account associated with the token to the user's PlayFab account.
854
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount
855
- */
856
- LinkBattleNetAccount(request, customData, extraHeaders) {
857
- return this.ExecuteRequestWrapper("/Client/LinkBattleNetAccount", request, "X-Authorization", customData, extraHeaders);
858
- }
859
- /**
860
- * Links the custom identifier, generated by the title, to the user's PlayFab account
861
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid
862
- */
863
- LinkCustomID(request, customData, extraHeaders) {
864
- return this.ExecuteRequestWrapper("/Client/LinkCustomID", request, "X-Authorization", customData, extraHeaders);
865
- }
866
- /**
867
- * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
868
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount
869
- */
870
- LinkFacebookAccount(request, customData, extraHeaders) {
871
- return this.ExecuteRequestWrapper("/Client/LinkFacebookAccount", request, "X-Authorization", customData, extraHeaders);
872
- }
873
- /**
874
- * Links the Facebook Instant Games Id to the user's PlayFab account
875
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
876
- */
877
- LinkFacebookInstantGamesId(request, customData, extraHeaders) {
878
- return this.ExecuteRequestWrapper("/Client/LinkFacebookInstantGamesId", request, "X-Authorization", customData, extraHeaders);
879
- }
880
- /**
881
- * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with
882
- * a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
883
- * in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
884
- * page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
885
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount
886
- */
887
- LinkGameCenterAccount(request, customData, extraHeaders) {
888
- return this.ExecuteRequestWrapper("/Client/LinkGameCenterAccount", request, "X-Authorization", customData, extraHeaders);
889
- }
890
- /**
891
- * Links the currently signed-in user account to their Google account, using their Google account credentials
892
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount
893
- */
894
- LinkGoogleAccount(request, customData, extraHeaders) {
895
- return this.ExecuteRequestWrapper("/Client/LinkGoogleAccount", request, "X-Authorization", customData, extraHeaders);
896
- }
897
- /**
898
- * Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
899
- * credentials
900
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
901
- */
902
- LinkGooglePlayGamesServicesAccount(request, customData, extraHeaders) {
903
- return this.ExecuteRequestWrapper("/Client/LinkGooglePlayGamesServicesAccount", request, "X-Authorization", customData, extraHeaders);
904
- }
905
- /**
906
- * Links the vendor-specific iOS device identifier to the user's PlayFab account
907
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid
908
- */
909
- LinkIOSDeviceID(request, customData, extraHeaders) {
910
- return this.ExecuteRequestWrapper("/Client/LinkIOSDeviceID", request, "X-Authorization", customData, extraHeaders);
911
- }
912
- /**
913
- * Links the Kongregate identifier to the user's PlayFab account
914
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
915
- */
916
- LinkKongregate(request, customData, extraHeaders) {
917
- return this.ExecuteRequestWrapper("/Client/LinkKongregate", request, "X-Authorization", customData, extraHeaders);
918
- }
919
- /**
920
- * Links the Nintendo account associated with the token to the user's PlayFab account.
921
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount
922
- */
923
- LinkNintendoServiceAccount(request, customData, extraHeaders) {
924
- return this.ExecuteRequestWrapper("/Client/LinkNintendoServiceAccount", request, "X-Authorization", customData, extraHeaders);
925
- }
926
- /**
927
- * Links the NintendoSwitchDeviceId to the user's PlayFab account
928
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
929
- */
930
- LinkNintendoSwitchDeviceId(request, customData, extraHeaders) {
931
- return this.ExecuteRequestWrapper("/Client/LinkNintendoSwitchDeviceId", request, "X-Authorization", customData, extraHeaders);
932
- }
933
- /**
934
- * Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
935
- * Open ID Connect provider and the OpenId Connect JWT from that provider.
936
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
937
- */
938
- LinkOpenIdConnect(request, customData, extraHeaders) {
939
- return this.ExecuteRequestWrapper("/Client/LinkOpenIdConnect", request, "X-Authorization", customData, extraHeaders);
940
- }
941
- /**
942
- * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
943
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount
944
- */
945
- LinkPSNAccount(request, customData, extraHeaders) {
946
- return this.ExecuteRequestWrapper("/Client/LinkPSNAccount", request, "X-Authorization", customData, extraHeaders);
947
- }
948
- /**
949
- * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
950
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount
951
- */
952
- LinkSteamAccount(request, customData, extraHeaders) {
953
- return this.ExecuteRequestWrapper("/Client/LinkSteamAccount", request, "X-Authorization", customData, extraHeaders);
954
- }
955
- /**
956
- * Links the Twitch account associated with the token to the user's PlayFab account.
957
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch
958
- */
959
- LinkTwitch(request, customData, extraHeaders) {
960
- return this.ExecuteRequestWrapper("/Client/LinkTwitch", request, "X-Authorization", customData, extraHeaders);
961
- }
962
- /**
963
- * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
964
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount
965
- */
966
- LinkXboxAccount(request, customData, extraHeaders) {
967
- return this.ExecuteRequestWrapper("/Client/LinkXboxAccount", request, "X-Authorization", customData, extraHeaders);
968
- }
969
- /**
970
- * Retrieves title-specific custom property values for a player.
971
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
972
- */
973
- ListPlayerCustomProperties(request, customData, extraHeaders) {
974
- return this.ExecuteRequestWrapper("/Client/ListPlayerCustomProperties", request, "X-Authorization", customData, extraHeaders);
975
- }
976
- /**
977
- * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
978
- * API calls which require an authenticated user
979
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid
980
- */
981
- LoginWithAndroidDeviceID(request, customData, extraHeaders) {
982
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
983
- if (!request.TitleId) throw this.errorTitleId;
984
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
985
- return this.ExecuteRequestWrapper("/Client/LoginWithAndroidDeviceID", request, null, customData, extraHeaders).then((result) => {
986
- var _a;
987
- if (result) {
988
- if (result == null ? void 0 : result.SessionTicket) {
989
- this.sessionTicket = result.SessionTicket;
990
- }
991
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
992
- this.entityToken = result.EntityToken.EntityToken;
993
- }
994
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
995
- }
996
- return result;
997
- });
998
- }
999
- /**
1000
- * Signs in the user with a Sign in with Apple identity token.
1001
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
1002
- */
1003
- LoginWithApple(request, customData, extraHeaders) {
1004
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1005
- if (!request.TitleId) throw this.errorTitleId;
1006
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1007
- return this.ExecuteRequestWrapper("/Client/LoginWithApple", request, null, customData, extraHeaders).then((result) => {
1008
- var _a;
1009
- if (result) {
1010
- if (result == null ? void 0 : result.SessionTicket) {
1011
- this.sessionTicket = result.SessionTicket;
1012
- }
1013
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1014
- this.entityToken = result.EntityToken.EntityToken;
1015
- }
1016
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1017
- }
1018
- return result;
1019
- });
1020
- }
1021
- /**
1022
- * Sign in the user with a Battle.net identity token
1023
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet
1024
- */
1025
- LoginWithBattleNet(request, customData, extraHeaders) {
1026
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1027
- if (!request.TitleId) throw this.errorTitleId;
1028
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1029
- return this.ExecuteRequestWrapper("/Client/LoginWithBattleNet", request, null, customData, extraHeaders).then((result) => {
1030
- var _a;
1031
- if (result) {
1032
- if (result == null ? void 0 : result.SessionTicket) {
1033
- this.sessionTicket = result.SessionTicket;
1034
- }
1035
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1036
- this.entityToken = result.EntityToken.EntityToken;
1037
- }
1038
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1039
- }
1040
- return result;
1041
- });
1042
- }
1043
- /**
1044
- * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
1045
- * subsequently be used for API calls which require an authenticated user
1046
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
1047
- */
1048
- LoginWithCustomID(request, customData, extraHeaders) {
1049
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1050
- if (!request.TitleId) throw this.errorTitleId;
1051
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1052
- return this.ExecuteRequestWrapper("/Client/LoginWithCustomID", request, null, customData, extraHeaders).then((result) => {
1053
- var _a;
1054
- if (result) {
1055
- if (result == null ? void 0 : result.SessionTicket) {
1056
- this.sessionTicket = result.SessionTicket;
1057
- }
1058
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1059
- this.entityToken = result.EntityToken.EntityToken;
1060
- }
1061
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1062
- }
1063
- return result;
1064
- });
1065
- }
1066
- /**
1067
- * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
1068
- * which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
1069
- * creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
1070
- * RegisterPlayFabUser.
1071
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
1072
- */
1073
- LoginWithEmailAddress(request, customData, extraHeaders) {
1074
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1075
- if (!request.TitleId) throw this.errorTitleId;
1076
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1077
- return this.ExecuteRequestWrapper("/Client/LoginWithEmailAddress", request, null, customData, extraHeaders).then((result) => {
1078
- var _a;
1079
- if (result) {
1080
- if (result == null ? void 0 : result.SessionTicket) {
1081
- this.sessionTicket = result.SessionTicket;
1082
- }
1083
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1084
- this.entityToken = result.EntityToken.EntityToken;
1085
- }
1086
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1087
- }
1088
- return result;
1089
- });
1090
- }
1091
- /**
1092
- * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
1093
- * calls which require an authenticated user
1094
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook
1095
- */
1096
- LoginWithFacebook(request, customData, extraHeaders) {
1097
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1098
- if (!request.TitleId) throw this.errorTitleId;
1099
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1100
- return this.ExecuteRequestWrapper("/Client/LoginWithFacebook", request, null, customData, extraHeaders).then((result) => {
1101
- var _a;
1102
- if (result) {
1103
- if (result == null ? void 0 : result.SessionTicket) {
1104
- this.sessionTicket = result.SessionTicket;
1105
- }
1106
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1107
- this.entityToken = result.EntityToken.EntityToken;
1108
- }
1109
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1110
- }
1111
- return result;
1112
- });
1113
- }
1114
- /**
1115
- * Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
1116
- * API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
1117
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid
1118
- */
1119
- LoginWithFacebookInstantGamesId(request, customData, extraHeaders) {
1120
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1121
- if (!request.TitleId) throw this.errorTitleId;
1122
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1123
- return this.ExecuteRequestWrapper("/Client/LoginWithFacebookInstantGamesId", request, null, customData, extraHeaders).then((result) => {
1124
- var _a;
1125
- if (result) {
1126
- if (result == null ? void 0 : result.SessionTicket) {
1127
- this.sessionTicket = result.SessionTicket;
1128
- }
1129
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1130
- this.entityToken = result.EntityToken.EntityToken;
1131
- }
1132
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1133
- }
1134
- return result;
1135
- });
1136
- }
1137
- /**
1138
- * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be
1139
- * used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not
1140
- * include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you
1141
- * require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and
1142
- * enabling the 'Require secure authentication only for this app' option.
1143
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter
1144
- */
1145
- LoginWithGameCenter(request, customData, extraHeaders) {
1146
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1147
- if (!request.TitleId) throw this.errorTitleId;
1148
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1149
- return this.ExecuteRequestWrapper("/Client/LoginWithGameCenter", request, null, customData, extraHeaders).then((result) => {
1150
- var _a;
1151
- if (result) {
1152
- if (result == null ? void 0 : result.SessionTicket) {
1153
- this.sessionTicket = result.SessionTicket;
1154
- }
1155
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1156
- this.entityToken = result.EntityToken.EntityToken;
1157
- }
1158
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1159
- }
1160
- return result;
1161
- });
1162
- }
1163
- /**
1164
- * Signs the user in using their Google account credentials
1165
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount
1166
- */
1167
- LoginWithGoogleAccount(request, customData, extraHeaders) {
1168
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1169
- if (!request.TitleId) throw this.errorTitleId;
1170
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1171
- return this.ExecuteRequestWrapper("/Client/LoginWithGoogleAccount", request, null, customData, extraHeaders).then((result) => {
1172
- var _a;
1173
- if (result) {
1174
- if (result == null ? void 0 : result.SessionTicket) {
1175
- this.sessionTicket = result.SessionTicket;
1176
- }
1177
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1178
- this.entityToken = result.EntityToken.EntityToken;
1179
- }
1180
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1181
- }
1182
- return result;
1183
- });
1184
- }
1185
- /**
1186
- * Signs the user in using their Google Play Games account credentials
1187
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices
1188
- */
1189
- LoginWithGooglePlayGamesServices(request, customData, extraHeaders) {
1190
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1191
- if (!request.TitleId) throw this.errorTitleId;
1192
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1193
- return this.ExecuteRequestWrapper("/Client/LoginWithGooglePlayGamesServices", request, null, customData, extraHeaders).then((result) => {
1194
- var _a;
1195
- if (result) {
1196
- if (result == null ? void 0 : result.SessionTicket) {
1197
- this.sessionTicket = result.SessionTicket;
1198
- }
1199
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1200
- this.entityToken = result.EntityToken.EntityToken;
1201
- }
1202
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1203
- }
1204
- return result;
1205
- });
1206
- }
1207
- /**
1208
- * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
1209
- * be used for API calls which require an authenticated user
1210
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid
1211
- */
1212
- LoginWithIOSDeviceID(request, customData, extraHeaders) {
1213
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1214
- if (!request.TitleId) throw this.errorTitleId;
1215
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1216
- return this.ExecuteRequestWrapper("/Client/LoginWithIOSDeviceID", request, null, customData, extraHeaders).then((result) => {
1217
- var _a;
1218
- if (result) {
1219
- if (result == null ? void 0 : result.SessionTicket) {
1220
- this.sessionTicket = result.SessionTicket;
1221
- }
1222
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1223
- this.entityToken = result.EntityToken.EntityToken;
1224
- }
1225
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1226
- }
1227
- return result;
1228
- });
1229
- }
1230
- /**
1231
- * Signs the user in using a Kongregate player account.
1232
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate
1233
- */
1234
- LoginWithKongregate(request, customData, extraHeaders) {
1235
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1236
- if (!request.TitleId) throw this.errorTitleId;
1237
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1238
- return this.ExecuteRequestWrapper("/Client/LoginWithKongregate", request, null, customData, extraHeaders).then((result) => {
1239
- var _a;
1240
- if (result) {
1241
- if (result == null ? void 0 : result.SessionTicket) {
1242
- this.sessionTicket = result.SessionTicket;
1243
- }
1244
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1245
- this.entityToken = result.EntityToken.EntityToken;
1246
- }
1247
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1248
- }
1249
- return result;
1250
- });
1251
- }
1252
- /**
1253
- * Signs in the user with a Nintendo service account token.
1254
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount
1255
- */
1256
- LoginWithNintendoServiceAccount(request, customData, extraHeaders) {
1257
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1258
- if (!request.TitleId) throw this.errorTitleId;
1259
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1260
- return this.ExecuteRequestWrapper("/Client/LoginWithNintendoServiceAccount", request, null, customData, extraHeaders).then((result) => {
1261
- var _a;
1262
- if (result) {
1263
- if (result == null ? void 0 : result.SessionTicket) {
1264
- this.sessionTicket = result.SessionTicket;
1265
- }
1266
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1267
- this.entityToken = result.EntityToken.EntityToken;
1268
- }
1269
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1270
- }
1271
- return result;
1272
- });
1273
- }
1274
- /**
1275
- * Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
1276
- * API calls which require an authenticated user
1277
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid
1278
- */
1279
- LoginWithNintendoSwitchDeviceId(request, customData, extraHeaders) {
1280
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1281
- if (!request.TitleId) throw this.errorTitleId;
1282
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1283
- return this.ExecuteRequestWrapper("/Client/LoginWithNintendoSwitchDeviceId", request, null, customData, extraHeaders).then((result) => {
1284
- var _a;
1285
- if (result) {
1286
- if (result == null ? void 0 : result.SessionTicket) {
1287
- this.sessionTicket = result.SessionTicket;
1288
- }
1289
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1290
- this.entityToken = result.EntityToken.EntityToken;
1291
- }
1292
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1293
- }
1294
- return result;
1295
- });
1296
- }
1297
- /**
1298
- * Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
1299
- * provider.
1300
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect
1301
- */
1302
- LoginWithOpenIdConnect(request, customData, extraHeaders) {
1303
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1304
- if (!request.TitleId) throw this.errorTitleId;
1305
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1306
- return this.ExecuteRequestWrapper("/Client/LoginWithOpenIdConnect", request, null, customData, extraHeaders).then((result) => {
1307
- var _a;
1308
- if (result) {
1309
- if (result == null ? void 0 : result.SessionTicket) {
1310
- this.sessionTicket = result.SessionTicket;
1311
- }
1312
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1313
- this.entityToken = result.EntityToken.EntityToken;
1314
- }
1315
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1316
- }
1317
- return result;
1318
- });
1319
- }
1320
- /**
1321
- * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
1322
- * which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
1323
- * new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via
1324
- * RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
1325
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab
1326
- */
1327
- LoginWithPlayFab(request, customData, extraHeaders) {
1328
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1329
- if (!request.TitleId) throw this.errorTitleId;
1330
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1331
- return this.ExecuteRequestWrapper("/Client/LoginWithPlayFab", request, null, customData, extraHeaders).then((result) => {
1332
- var _a;
1333
- if (result) {
1334
- if (result == null ? void 0 : result.SessionTicket) {
1335
- this.sessionTicket = result.SessionTicket;
1336
- }
1337
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1338
- this.entityToken = result.EntityToken.EntityToken;
1339
- }
1340
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1341
- }
1342
- return result;
1343
- });
1344
- }
1345
- /**
1346
- * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
1347
- * subsequently be used for API calls which require an authenticated user
1348
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn
1349
- */
1350
- LoginWithPSN(request, customData, extraHeaders) {
1351
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1352
- if (!request.TitleId) throw this.errorTitleId;
1353
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1354
- return this.ExecuteRequestWrapper("/Client/LoginWithPSN", request, null, customData, extraHeaders).then((result) => {
1355
- var _a;
1356
- if (result) {
1357
- if (result == null ? void 0 : result.SessionTicket) {
1358
- this.sessionTicket = result.SessionTicket;
1359
- }
1360
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1361
- this.entityToken = result.EntityToken.EntityToken;
1362
- }
1363
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1364
- }
1365
- return result;
1366
- });
1367
- }
1368
- /**
1369
- * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
1370
- * API calls which require an authenticated user
1371
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam
1372
- */
1373
- LoginWithSteam(request, customData, extraHeaders) {
1374
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1375
- if (!request.TitleId) throw this.errorTitleId;
1376
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1377
- return this.ExecuteRequestWrapper("/Client/LoginWithSteam", request, null, customData, extraHeaders).then((result) => {
1378
- var _a;
1379
- if (result) {
1380
- if (result == null ? void 0 : result.SessionTicket) {
1381
- this.sessionTicket = result.SessionTicket;
1382
- }
1383
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1384
- this.entityToken = result.EntityToken.EntityToken;
1385
- }
1386
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1387
- }
1388
- return result;
1389
- });
1390
- }
1391
- /**
1392
- * Signs the user in using a Twitch access token.
1393
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch
1394
- */
1395
- LoginWithTwitch(request, customData, extraHeaders) {
1396
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1397
- if (!request.TitleId) throw this.errorTitleId;
1398
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1399
- return this.ExecuteRequestWrapper("/Client/LoginWithTwitch", request, null, customData, extraHeaders).then((result) => {
1400
- var _a;
1401
- if (result) {
1402
- if (result == null ? void 0 : result.SessionTicket) {
1403
- this.sessionTicket = result.SessionTicket;
1404
- }
1405
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1406
- this.entityToken = result.EntityToken.EntityToken;
1407
- }
1408
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1409
- }
1410
- return result;
1411
- });
1412
- }
1413
- /**
1414
- * Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
1415
- * which require an authenticated user
1416
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox
1417
- */
1418
- LoginWithXbox(request, customData, extraHeaders) {
1419
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1420
- if (!request.TitleId) throw this.errorTitleId;
1421
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1422
- return this.ExecuteRequestWrapper("/Client/LoginWithXbox", request, null, customData, extraHeaders).then((result) => {
1423
- var _a;
1424
- if (result) {
1425
- if (result == null ? void 0 : result.SessionTicket) {
1426
- this.sessionTicket = result.SessionTicket;
1427
- }
1428
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1429
- this.entityToken = result.EntityToken.EntityToken;
1430
- }
1431
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1432
- }
1433
- return result;
1434
- });
1435
- }
1436
- /**
1437
- * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
1438
- * https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade
1439
- */
1440
- OpenTrade(request, customData, extraHeaders) {
1441
- return this.ExecuteRequestWrapper("/Client/OpenTrade", request, "X-Authorization", customData, extraHeaders);
1442
- }
1443
- /**
1444
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1445
- * version 2._ Selects a payment option for purchase order created via StartPurchase
1446
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase
1447
- */
1448
- PayForPurchase(request, customData, extraHeaders) {
1449
- return this.ExecuteRequestWrapper("/Client/PayForPurchase", request, "X-Authorization", customData, extraHeaders);
1450
- }
1451
- /**
1452
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1453
- * version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
1454
- * well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
1455
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem
1456
- */
1457
- PurchaseItem(request, customData, extraHeaders) {
1458
- return this.ExecuteRequestWrapper("/Client/PurchaseItem", request, "X-Authorization", customData, extraHeaders);
1459
- }
1460
- /**
1461
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1462
- * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
1463
- * Economy->Catalogs tab in the PlayFab Game Manager.
1464
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon
1465
- */
1466
- RedeemCoupon(request, customData, extraHeaders) {
1467
- return this.ExecuteRequestWrapper("/Client/RedeemCoupon", request, "X-Authorization", customData, extraHeaders);
1468
- }
1469
- /**
1470
- * Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
1471
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken
1472
- */
1473
- RefreshPSNAuthToken(request, customData, extraHeaders) {
1474
- return this.ExecuteRequestWrapper("/Client/RefreshPSNAuthToken", request, "X-Authorization", customData, extraHeaders);
1475
- }
1476
- /**
1477
- * Registers the iOS device to receive push notifications
1478
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification
1479
- */
1480
- RegisterForIOSPushNotification(request, customData, extraHeaders) {
1481
- return this.ExecuteRequestWrapper("/Client/RegisterForIOSPushNotification", request, "X-Authorization", customData, extraHeaders);
1482
- }
1483
- /**
1484
- * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
1485
- * require an authenticated user. You must supply a username and an email address.
1486
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser
1487
- */
1488
- RegisterPlayFabUser(request, customData, extraHeaders) {
1489
- request.TitleId = this.settings.titleId ? this.settings.titleId : request.TitleId;
1490
- if (!request.TitleId) throw this.errorTitleId;
1491
- var authenticationContext = JSON.parse(JSON.stringify(this.authenticationContext));
1492
- return this.ExecuteRequestWrapper("/Client/RegisterPlayFabUser", request, null, customData, extraHeaders).then((result) => {
1493
- var _a;
1494
- if (result) {
1495
- if (result == null ? void 0 : result.SessionTicket) {
1496
- this.sessionTicket = result.SessionTicket;
1497
- }
1498
- if ((_a = result == null ? void 0 : result.EntityToken) == null ? void 0 : _a.EntityToken) {
1499
- this.entityToken = result.EntityToken.EntityToken;
1500
- }
1501
- authenticationContext = this.UpdateAuthenticationContext(authenticationContext, result);
1502
- }
1503
- return result;
1504
- });
1505
- }
1506
- /**
1507
- * Removes a contact email from the player's profile.
1508
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail
1509
- */
1510
- RemoveContactEmail(request, customData, extraHeaders) {
1511
- return this.ExecuteRequestWrapper("/Client/RemoveContactEmail", request, "X-Authorization", customData, extraHeaders);
1512
- }
1513
- /**
1514
- * Removes a specified user from the friend list of the local user
1515
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend
1516
- */
1517
- RemoveFriend(request, customData, extraHeaders) {
1518
- return this.ExecuteRequestWrapper("/Client/RemoveFriend", request, "X-Authorization", customData, extraHeaders);
1519
- }
1520
- /**
1521
- * Removes the specified generic service identifier from the player's PlayFab account.
1522
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid
1523
- */
1524
- RemoveGenericID(request, customData, extraHeaders) {
1525
- return this.ExecuteRequestWrapper("/Client/RemoveGenericID", request, "X-Authorization", customData, extraHeaders);
1526
- }
1527
- /**
1528
- * Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the
1529
- * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
1530
- * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
1531
- * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1532
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers
1533
- */
1534
- RemoveSharedGroupMembers(request, customData, extraHeaders) {
1535
- return this.ExecuteRequestWrapper("/Client/RemoveSharedGroupMembers", request, "X-Authorization", customData, extraHeaders);
1536
- }
1537
- /**
1538
- * Report player's ad activity
1539
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity
1540
- */
1541
- ReportAdActivity(request, customData, extraHeaders) {
1542
- return this.ExecuteRequestWrapper("/Client/ReportAdActivity", request, "X-Authorization", customData, extraHeaders);
1543
- }
1544
- /**
1545
- * Write a PlayStream event to describe the provided player device information. This API method is not designed to be
1546
- * called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
1547
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo
1548
- */
1549
- ReportDeviceInfo(request, customData, extraHeaders) {
1550
- return this.ExecuteRequestWrapper("/Client/ReportDeviceInfo", request, "X-Authorization", customData, extraHeaders);
1551
- }
1552
- /**
1553
- * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
1554
- * can take action concerning potentially toxic players.
1555
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer
1556
- */
1557
- ReportPlayer(request, customData, extraHeaders) {
1558
- return this.ExecuteRequestWrapper("/Client/ReportPlayer", request, "X-Authorization", customData, extraHeaders);
1559
- }
1560
- /**
1561
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1562
- * version 2._ Restores all in-app purchases based on the given restore receipt
1563
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases
1564
- */
1565
- RestoreIOSPurchases(request, customData, extraHeaders) {
1566
- return this.ExecuteRequestWrapper("/Client/RestoreIOSPurchases", request, "X-Authorization", customData, extraHeaders);
1567
- }
1568
- /**
1569
- * Reward player's ad activity
1570
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity
1571
- */
1572
- RewardAdActivity(request, customData, extraHeaders) {
1573
- return this.ExecuteRequestWrapper("/Client/RewardAdActivity", request, "X-Authorization", customData, extraHeaders);
1574
- }
1575
- /**
1576
- * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
1577
- * change the password.If an account recovery email template ID is provided, an email using the custom email template will
1578
- * be used.
1579
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail
1580
- */
1581
- SendAccountRecoveryEmail(request, customData, extraHeaders) {
1582
- return this.ExecuteRequestWrapper("/Client/SendAccountRecoveryEmail", request, null, customData, extraHeaders);
1583
- }
1584
- /**
1585
- * Updates the tag list for a specified user in the friend list of the local user
1586
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags
1587
- */
1588
- SetFriendTags(request, customData, extraHeaders) {
1589
- return this.ExecuteRequestWrapper("/Client/SetFriendTags", request, "X-Authorization", customData, extraHeaders);
1590
- }
1591
- /**
1592
- * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
1593
- * secret use the Admin or Server API method SetPlayerSecret.
1594
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret
1595
- */
1596
- SetPlayerSecret(request, customData, extraHeaders) {
1597
- return this.ExecuteRequestWrapper("/Client/SetPlayerSecret", request, "X-Authorization", customData, extraHeaders);
1598
- }
1599
- /**
1600
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1601
- * version 2._ Creates an order for a list of items from the title catalog
1602
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase
1603
- */
1604
- StartPurchase(request, customData, extraHeaders) {
1605
- return this.ExecuteRequestWrapper("/Client/StartPurchase", request, "X-Authorization", customData, extraHeaders);
1606
- }
1607
- /**
1608
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1609
- * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
1610
- * a VC balance negative with this API.
1611
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency
1612
- */
1613
- SubtractUserVirtualCurrency(request, customData, extraHeaders) {
1614
- return this.ExecuteRequestWrapper("/Client/SubtractUserVirtualCurrency", request, "X-Authorization", customData, extraHeaders);
1615
- }
1616
- /**
1617
- * Unlinks the related Android device identifier from the user's PlayFab account
1618
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid
1619
- */
1620
- UnlinkAndroidDeviceID(request, customData, extraHeaders) {
1621
- return this.ExecuteRequestWrapper("/Client/UnlinkAndroidDeviceID", request, "X-Authorization", customData, extraHeaders);
1622
- }
1623
- /**
1624
- * Unlinks the related Apple account from the user's PlayFab account.
1625
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple
1626
- */
1627
- UnlinkApple(request, customData, extraHeaders) {
1628
- return this.ExecuteRequestWrapper("/Client/UnlinkApple", request, "X-Authorization", customData, extraHeaders);
1629
- }
1630
- /**
1631
- * Unlinks the related Battle.net account from the user's PlayFab account.
1632
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount
1633
- */
1634
- UnlinkBattleNetAccount(request, customData, extraHeaders) {
1635
- return this.ExecuteRequestWrapper("/Client/UnlinkBattleNetAccount", request, "X-Authorization", customData, extraHeaders);
1636
- }
1637
- /**
1638
- * Unlinks the related custom identifier from the user's PlayFab account
1639
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid
1640
- */
1641
- UnlinkCustomID(request, customData, extraHeaders) {
1642
- return this.ExecuteRequestWrapper("/Client/UnlinkCustomID", request, "X-Authorization", customData, extraHeaders);
1643
- }
1644
- /**
1645
- * Unlinks the related Facebook account from the user's PlayFab account
1646
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount
1647
- */
1648
- UnlinkFacebookAccount(request, customData, extraHeaders) {
1649
- return this.ExecuteRequestWrapper("/Client/UnlinkFacebookAccount", request, "X-Authorization", customData, extraHeaders);
1650
- }
1651
- /**
1652
- * Unlinks the related Facebook Instant Game Ids from the user's PlayFab account
1653
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid
1654
- */
1655
- UnlinkFacebookInstantGamesId(request, customData, extraHeaders) {
1656
- return this.ExecuteRequestWrapper("/Client/UnlinkFacebookInstantGamesId", request, "X-Authorization", customData, extraHeaders);
1657
- }
1658
- /**
1659
- * Unlinks the related Game Center account from the user's PlayFab account
1660
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount
1661
- */
1662
- UnlinkGameCenterAccount(request, customData, extraHeaders) {
1663
- return this.ExecuteRequestWrapper("/Client/UnlinkGameCenterAccount", request, "X-Authorization", customData, extraHeaders);
1664
- }
1665
- /**
1666
- * Unlinks the related Google account from the user's PlayFab account
1667
- * (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
1668
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount
1669
- */
1670
- UnlinkGoogleAccount(request, customData, extraHeaders) {
1671
- return this.ExecuteRequestWrapper("/Client/UnlinkGoogleAccount", request, "X-Authorization", customData, extraHeaders);
1672
- }
1673
- /**
1674
- * Unlinks the related Google Play Games account from the user's PlayFab account.
1675
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount
1676
- */
1677
- UnlinkGooglePlayGamesServicesAccount(request, customData, extraHeaders) {
1678
- return this.ExecuteRequestWrapper("/Client/UnlinkGooglePlayGamesServicesAccount", request, "X-Authorization", customData, extraHeaders);
1679
- }
1680
- /**
1681
- * Unlinks the related iOS device identifier from the user's PlayFab account
1682
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid
1683
- */
1684
- UnlinkIOSDeviceID(request, customData, extraHeaders) {
1685
- return this.ExecuteRequestWrapper("/Client/UnlinkIOSDeviceID", request, "X-Authorization", customData, extraHeaders);
1686
- }
1687
- /**
1688
- * Unlinks the related Kongregate identifier from the user's PlayFab account
1689
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate
1690
- */
1691
- UnlinkKongregate(request, customData, extraHeaders) {
1692
- return this.ExecuteRequestWrapper("/Client/UnlinkKongregate", request, "X-Authorization", customData, extraHeaders);
1693
- }
1694
- /**
1695
- * Unlinks the related Nintendo account from the user's PlayFab account.
1696
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount
1697
- */
1698
- UnlinkNintendoServiceAccount(request, customData, extraHeaders) {
1699
- return this.ExecuteRequestWrapper("/Client/UnlinkNintendoServiceAccount", request, "X-Authorization", customData, extraHeaders);
1700
- }
1701
- /**
1702
- * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
1703
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid
1704
- */
1705
- UnlinkNintendoSwitchDeviceId(request, customData, extraHeaders) {
1706
- return this.ExecuteRequestWrapper("/Client/UnlinkNintendoSwitchDeviceId", request, "X-Authorization", customData, extraHeaders);
1707
- }
1708
- /**
1709
- * Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
1710
- * between a title and an Open ID Connect provider.
1711
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect
1712
- */
1713
- UnlinkOpenIdConnect(request, customData, extraHeaders) {
1714
- return this.ExecuteRequestWrapper("/Client/UnlinkOpenIdConnect", request, "X-Authorization", customData, extraHeaders);
1715
- }
1716
- /**
1717
- * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
1718
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount
1719
- */
1720
- UnlinkPSNAccount(request, customData, extraHeaders) {
1721
- return this.ExecuteRequestWrapper("/Client/UnlinkPSNAccount", request, "X-Authorization", customData, extraHeaders);
1722
- }
1723
- /**
1724
- * Unlinks the related Steam account from the user's PlayFab account
1725
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount
1726
- */
1727
- UnlinkSteamAccount(request, customData, extraHeaders) {
1728
- return this.ExecuteRequestWrapper("/Client/UnlinkSteamAccount", request, "X-Authorization", customData, extraHeaders);
1729
- }
1730
- /**
1731
- * Unlinks the related Twitch account from the user's PlayFab account.
1732
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch
1733
- */
1734
- UnlinkTwitch(request, customData, extraHeaders) {
1735
- return this.ExecuteRequestWrapper("/Client/UnlinkTwitch", request, "X-Authorization", customData, extraHeaders);
1736
- }
1737
- /**
1738
- * Unlinks the related Xbox Live account from the user's PlayFab account
1739
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount
1740
- */
1741
- UnlinkXboxAccount(request, customData, extraHeaders) {
1742
- return this.ExecuteRequestWrapper("/Client/UnlinkXboxAccount", request, "X-Authorization", customData, extraHeaders);
1743
- }
1744
- /**
1745
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1746
- * version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
1747
- * opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will
1748
- * be decremented, consistent with the operation of ConsumeItem.
1749
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance
1750
- */
1751
- UnlockContainerInstance(request, customData, extraHeaders) {
1752
- return this.ExecuteRequestWrapper("/Client/UnlockContainerInstance", request, "X-Authorization", customData, extraHeaders);
1753
- }
1754
- /**
1755
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1756
- * version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
1757
- * using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are
1758
- * consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
1759
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem
1760
- */
1761
- UnlockContainerItem(request, customData, extraHeaders) {
1762
- return this.ExecuteRequestWrapper("/Client/UnlockContainerItem", request, "X-Authorization", customData, extraHeaders);
1763
- }
1764
- /**
1765
- * Update the avatar URL of the player
1766
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl
1767
- */
1768
- UpdateAvatarUrl(request, customData, extraHeaders) {
1769
- return this.ExecuteRequestWrapper("/Client/UpdateAvatarUrl", request, "X-Authorization", customData, extraHeaders);
1770
- }
1771
- /**
1772
- * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
1773
- * https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata
1774
- */
1775
- UpdateCharacterData(request, customData, extraHeaders) {
1776
- return this.ExecuteRequestWrapper("/Client/UpdateCharacterData", request, "X-Authorization", customData, extraHeaders);
1777
- }
1778
- /**
1779
- * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
1780
- * permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
1781
- * https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics
1782
- */
1783
- UpdateCharacterStatistics(request, customData, extraHeaders) {
1784
- return this.ExecuteRequestWrapper("/Client/UpdateCharacterStatistics", request, "X-Authorization", customData, extraHeaders);
1785
- }
1786
- /**
1787
- * Updates the title-specific custom property values for a player
1788
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties
1789
- */
1790
- UpdatePlayerCustomProperties(request, customData, extraHeaders) {
1791
- return this.ExecuteRequestWrapper("/Client/UpdatePlayerCustomProperties", request, "X-Authorization", customData, extraHeaders);
1792
- }
1793
- /**
1794
- * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
1795
- * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
1796
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics
1797
- */
1798
- UpdatePlayerStatistics(request, customData, extraHeaders) {
1799
- return this.ExecuteRequestWrapper("/Client/UpdatePlayerStatistics", request, "X-Authorization", customData, extraHeaders);
1800
- }
1801
- /**
1802
- * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
1803
- * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
1804
- * Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for
1805
- * sharing data between a very small number of players, please see our guide:
1806
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1807
- * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata
1808
- */
1809
- UpdateSharedGroupData(request, customData, extraHeaders) {
1810
- return this.ExecuteRequestWrapper("/Client/UpdateSharedGroupData", request, "X-Authorization", customData, extraHeaders);
1811
- }
1812
- /**
1813
- * Creates and updates the title-specific custom data for the user which is readable and writable by the client
1814
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata
1815
- */
1816
- UpdateUserData(request, customData, extraHeaders) {
1817
- return this.ExecuteRequestWrapper("/Client/UpdateUserData", request, "X-Authorization", customData, extraHeaders);
1818
- }
1819
- /**
1820
- * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client
1821
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata
1822
- */
1823
- UpdateUserPublisherData(request, customData, extraHeaders) {
1824
- return this.ExecuteRequestWrapper("/Client/UpdateUserPublisherData", request, "X-Authorization", customData, extraHeaders);
1825
- }
1826
- /**
1827
- * Updates the title specific display name for the user
1828
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname
1829
- */
1830
- UpdateUserTitleDisplayName(request, customData, extraHeaders) {
1831
- return this.ExecuteRequestWrapper("/Client/UpdateUserTitleDisplayName", request, "X-Authorization", customData, extraHeaders);
1832
- }
1833
- /**
1834
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1835
- * version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
1836
- * the purchased catalog item
1837
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt
1838
- */
1839
- ValidateAmazonIAPReceipt(request, customData, extraHeaders) {
1840
- return this.ExecuteRequestWrapper("/Client/ValidateAmazonIAPReceipt", request, "X-Authorization", customData, extraHeaders);
1841
- }
1842
- /**
1843
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1844
- * version 2._ Validates a Google Play purchase and gives the corresponding item to the player.
1845
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase
1846
- */
1847
- ValidateGooglePlayPurchase(request, customData, extraHeaders) {
1848
- return this.ExecuteRequestWrapper("/Client/ValidateGooglePlayPurchase", request, "X-Authorization", customData, extraHeaders);
1849
- }
1850
- /**
1851
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1852
- * version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
1853
- * purchased catalog item
1854
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt
1855
- */
1856
- ValidateIOSReceipt(request, customData, extraHeaders) {
1857
- return this.ExecuteRequestWrapper("/Client/ValidateIOSReceipt", request, "X-Authorization", customData, extraHeaders);
1858
- }
1859
- /**
1860
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1861
- * version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
1862
- * matches the purchased catalog item
1863
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt
1864
- */
1865
- ValidateWindowsStoreReceipt(request, customData, extraHeaders) {
1866
- return this.ExecuteRequestWrapper("/Client/ValidateWindowsStoreReceipt", request, "X-Authorization", customData, extraHeaders);
1867
- }
1868
- /**
1869
- * Writes a character-based event into PlayStream.
1870
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent
1871
- */
1872
- WriteCharacterEvent(request, customData, extraHeaders) {
1873
- return this.ExecuteRequestWrapper("/Client/WriteCharacterEvent", request, "X-Authorization", customData, extraHeaders);
1874
- }
1875
- /**
1876
- * Writes a player-based event into PlayStream.
1877
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent
1878
- */
1879
- WritePlayerEvent(request, customData, extraHeaders) {
1880
- return this.ExecuteRequestWrapper("/Client/WritePlayerEvent", request, "X-Authorization", customData, extraHeaders);
1881
- }
1882
- /**
1883
- * Writes a title-based event into PlayStream.
1884
- * https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent
1885
- */
1886
- WriteTitleEvent(request, customData, extraHeaders) {
1887
- return this.ExecuteRequestWrapper("/Client/WriteTitleEvent", request, "X-Authorization", customData, extraHeaders);
1888
- }
1889
- };
1
+ import {
2
+ PlayFabClientApi
3
+ } from "./chunk-JGDO2ZE3.js";
4
+ import "./chunk-62SULWOK.js";
1890
5
  export {
1891
6
  PlayFabClientApi as default
1892
7
  };