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

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 (69) hide show
  1. package/dist/Addon.js +4 -448
  2. package/dist/Addon.js.map +1 -1
  3. package/dist/Admin.js +4 -1108
  4. package/dist/Admin.js.map +1 -1
  5. package/dist/Authentication.js +4 -286
  6. package/dist/Authentication.js.map +1 -1
  7. package/dist/Client.js +4 -1889
  8. package/dist/Client.js.map +1 -1
  9. package/dist/CloudScript.js +4 -345
  10. package/dist/CloudScript.js.map +1 -1
  11. package/dist/Data.js +4 -287
  12. package/dist/Data.js.map +1 -1
  13. package/dist/Economy.js +4 -610
  14. package/dist/Economy.js.map +1 -1
  15. package/dist/Events.js +4 -323
  16. package/dist/Events.js.map +1 -1
  17. package/dist/Experimentation.js +4 -329
  18. package/dist/Experimentation.js.map +1 -1
  19. package/dist/Groups.js +4 -413
  20. package/dist/Groups.js.map +1 -1
  21. package/dist/Insights.js +4 -282
  22. package/dist/Insights.js.map +1 -1
  23. package/dist/Localization.js +4 -245
  24. package/dist/Localization.js.map +1 -1
  25. package/dist/Multiplayer.js +4 -858
  26. package/dist/Multiplayer.js.map +1 -1
  27. package/dist/Profiles.js +4 -302
  28. package/dist/Profiles.js.map +1 -1
  29. package/dist/Progression.js +4 -400
  30. package/dist/Progression.js.map +1 -1
  31. package/dist/Server.js +4 -1373
  32. package/dist/Server.js.map +1 -1
  33. package/dist/chunk-2NRPVFSH.js +632 -0
  34. package/dist/chunk-2NRPVFSH.js.map +1 -0
  35. package/dist/chunk-42AWSTMK.js +103 -0
  36. package/dist/chunk-42AWSTMK.js.map +1 -0
  37. package/dist/chunk-5AAYYQU7.js +119 -0
  38. package/dist/chunk-5AAYYQU7.js.map +1 -0
  39. package/dist/chunk-7VP4SIOQ.js +76 -0
  40. package/dist/chunk-7VP4SIOQ.js.map +1 -0
  41. package/dist/chunk-BZECCU2H.js +1147 -0
  42. package/dist/chunk-BZECCU2H.js.map +1 -0
  43. package/dist/chunk-CDBIRT6V.js +187 -0
  44. package/dist/chunk-CDBIRT6V.js.map +1 -0
  45. package/dist/chunk-CY3H2GBI.js +239 -0
  46. package/dist/chunk-CY3H2GBI.js.map +1 -0
  47. package/dist/chunk-D53KEX67.js +19 -0
  48. package/dist/chunk-D53KEX67.js.map +1 -0
  49. package/dist/chunk-EY77H23H.js +174 -0
  50. package/dist/chunk-EY77H23H.js.map +1 -0
  51. package/dist/chunk-FPCXHDA7.js +882 -0
  52. package/dist/chunk-FPCXHDA7.js.map +1 -0
  53. package/dist/chunk-JRE75IDS.js +97 -0
  54. package/dist/chunk-JRE75IDS.js.map +1 -0
  55. package/dist/chunk-QCCQJDCR.js +1663 -0
  56. package/dist/chunk-QCCQJDCR.js.map +1 -0
  57. package/dist/chunk-RHQFG2EP.js +384 -0
  58. package/dist/chunk-RHQFG2EP.js.map +1 -0
  59. package/dist/chunk-RODJAJP2.js +56 -0
  60. package/dist/chunk-RODJAJP2.js.map +1 -0
  61. package/dist/chunk-V56QSAWL.js +60 -0
  62. package/dist/chunk-V56QSAWL.js.map +1 -0
  63. package/dist/chunk-VTCQRNBL.js +61 -0
  64. package/dist/chunk-VTCQRNBL.js.map +1 -0
  65. package/dist/chunk-ZY56RXKC.js +222 -0
  66. package/dist/chunk-ZY56RXKC.js.map +1 -0
  67. package/dist/index.js +49 -5988
  68. package/dist/index.js.map +1 -1
  69. package/package.json +1 -1
package/dist/Server.js CHANGED
@@ -1,1376 +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/PlayFabServerApi.ts
237
- var PlayFabServerApi = class extends PlayFabCommon {
238
- /**
239
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
240
- * version 2._ Increments the character's balance of the specified virtual currency by the stated amount
241
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency
242
- */
243
- AddCharacterVirtualCurrency(request, customData, extraHeaders) {
244
- return this.ExecuteRequestWrapper("/Server/AddCharacterVirtualCurrency", request, "X-SecretKey", customData, extraHeaders);
245
- }
246
- /**
247
- * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
248
- * FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
249
- * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend
250
- */
251
- AddFriend(request, customData, extraHeaders) {
252
- return this.ExecuteRequestWrapper("/Server/AddFriend", request, "X-SecretKey", customData, extraHeaders);
253
- }
254
- /**
255
- * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
256
- * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
257
- * authentication credentials, as the intent is that it is easily accessible by other players.
258
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid
259
- */
260
- AddGenericID(request, customData, extraHeaders) {
261
- return this.ExecuteRequestWrapper("/Server/AddGenericID", request, "X-SecretKey", customData, extraHeaders);
262
- }
263
- /**
264
- * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
265
- * https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag
266
- */
267
- AddPlayerTag(request, customData, extraHeaders) {
268
- return this.ExecuteRequestWrapper("/Server/AddPlayerTag", request, "X-SecretKey", customData, extraHeaders);
269
- }
270
- /**
271
- * 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
272
- * in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small
273
- * number of players, please see our guide:
274
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
275
- * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers
276
- */
277
- AddSharedGroupMembers(request, customData, extraHeaders) {
278
- return this.ExecuteRequestWrapper("/Server/AddSharedGroupMembers", request, "X-SecretKey", customData, extraHeaders);
279
- }
280
- /**
281
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
282
- * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
283
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency
284
- */
285
- AddUserVirtualCurrency(request, customData, extraHeaders) {
286
- return this.ExecuteRequestWrapper("/Server/AddUserVirtualCurrency", request, "X-SecretKey", customData, extraHeaders);
287
- }
288
- /**
289
- * Validated a client's session ticket, and if successful, returns details for that user
290
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket
291
- */
292
- AuthenticateSessionTicket(request, customData, extraHeaders) {
293
- return this.ExecuteRequestWrapper("/Server/AuthenticateSessionTicket", request, "X-SecretKey", customData, extraHeaders);
294
- }
295
- /**
296
- * Awards the specified users the specified Steam achievements
297
- * https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement
298
- */
299
- AwardSteamAchievement(request, customData, extraHeaders) {
300
- return this.ExecuteRequestWrapper("/Server/AwardSteamAchievement", request, "X-SecretKey", customData, extraHeaders);
301
- }
302
- /**
303
- * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
304
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers
305
- */
306
- BanUsers(request, customData, extraHeaders) {
307
- return this.ExecuteRequestWrapper("/Server/BanUsers", request, "X-SecretKey", customData, extraHeaders);
308
- }
309
- /**
310
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
311
- * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
312
- * inventory.
313
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem
314
- */
315
- ConsumeItem(request, customData, extraHeaders) {
316
- return this.ExecuteRequestWrapper("/Server/ConsumeItem", request, "X-SecretKey", customData, extraHeaders);
317
- }
318
- /**
319
- * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
320
- * group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data
321
- * between a very small number of players, please see our guide:
322
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
323
- * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup
324
- */
325
- CreateSharedGroup(request, customData, extraHeaders) {
326
- return this.ExecuteRequestWrapper("/Server/CreateSharedGroup", request, "X-SecretKey", customData, extraHeaders);
327
- }
328
- /**
329
- * Deletes the specific character ID from the specified user.
330
- * https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser
331
- */
332
- DeleteCharacterFromUser(request, customData, extraHeaders) {
333
- return this.ExecuteRequestWrapper("/Server/DeleteCharacterFromUser", request, "X-SecretKey", customData, extraHeaders);
334
- }
335
- /**
336
- * Removes a user's player account from a title and deletes all associated data
337
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer
338
- */
339
- DeletePlayer(request, customData, extraHeaders) {
340
- return this.ExecuteRequestWrapper("/Server/DeletePlayer", request, "X-SecretKey", customData, extraHeaders);
341
- }
342
- /**
343
- * Deletes title-specific custom properties for a player
344
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties
345
- */
346
- DeletePlayerCustomProperties(request, customData, extraHeaders) {
347
- return this.ExecuteRequestWrapper("/Server/DeletePlayerCustomProperties", request, "X-SecretKey", customData, extraHeaders);
348
- }
349
- /**
350
- * Deletes push notification template for title
351
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate
352
- */
353
- DeletePushNotificationTemplate(request, customData, extraHeaders) {
354
- return this.ExecuteRequestWrapper("/Server/DeletePushNotificationTemplate", request, "X-SecretKey", customData, extraHeaders);
355
- }
356
- /**
357
- * Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for
358
- * sharing data between a very small number of players, please see our guide:
359
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
360
- * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup
361
- */
362
- DeleteSharedGroup(request, customData, extraHeaders) {
363
- return this.ExecuteRequestWrapper("/Server/DeleteSharedGroup", request, "X-SecretKey", customData, extraHeaders);
364
- }
365
- /**
366
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
367
- * version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
368
- * have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to
369
- * UnlockContainer.
370
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable
371
- */
372
- EvaluateRandomResultTable(request, customData, extraHeaders) {
373
- return this.ExecuteRequestWrapper("/Server/EvaluateRandomResultTable", request, "X-SecretKey", customData, extraHeaders);
374
- }
375
- /**
376
- * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
377
- * PlayFab ID is the entity ID of the player's master_player_account entity.
378
- * https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript
379
- */
380
- ExecuteCloudScript(request, customData, extraHeaders) {
381
- return this.ExecuteRequestWrapper("/Server/ExecuteCloudScript", request, "X-SecretKey", customData, extraHeaders);
382
- }
383
- /**
384
- * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
385
- * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
386
- * https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments
387
- */
388
- GetAllSegments(request, customData, extraHeaders) {
389
- return this.ExecuteRequestWrapper("/Server/GetAllSegments", request, "X-SecretKey", customData, extraHeaders);
390
- }
391
- /**
392
- * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
393
- * evaluated with the parent PlayFabId to guarantee uniqueness.
394
- * https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters
395
- */
396
- GetAllUsersCharacters(request, customData, extraHeaders) {
397
- return this.ExecuteRequestWrapper("/Server/GetAllUsersCharacters", request, "X-SecretKey", customData, extraHeaders);
398
- }
399
- /**
400
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
401
- * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
402
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems
403
- */
404
- GetCatalogItems(request, customData, extraHeaders) {
405
- return this.ExecuteRequestWrapper("/Server/GetCatalogItems", request, "X-SecretKey", customData, extraHeaders);
406
- }
407
- /**
408
- * Retrieves the title-specific custom data for the user which is readable and writable by the client
409
- * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata
410
- */
411
- GetCharacterData(request, customData, extraHeaders) {
412
- return this.ExecuteRequestWrapper("/Server/GetCharacterData", request, "X-SecretKey", customData, extraHeaders);
413
- }
414
- /**
415
- * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
416
- * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata
417
- */
418
- GetCharacterInternalData(request, customData, extraHeaders) {
419
- return this.ExecuteRequestWrapper("/Server/GetCharacterInternalData", request, "X-SecretKey", customData, extraHeaders);
420
- }
421
- /**
422
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
423
- * version 2._ Retrieves the specified character's current inventory of virtual goods
424
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory
425
- */
426
- GetCharacterInventory(request, customData, extraHeaders) {
427
- return this.ExecuteRequestWrapper("/Server/GetCharacterInventory", request, "X-SecretKey", customData, extraHeaders);
428
- }
429
- /**
430
- * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
431
- * https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard
432
- */
433
- GetCharacterLeaderboard(request, customData, extraHeaders) {
434
- return this.ExecuteRequestWrapper("/Server/GetCharacterLeaderboard", request, "X-SecretKey", customData, extraHeaders);
435
- }
436
- /**
437
- * Retrieves the title-specific custom data for the user's character which can only be read by the client
438
- * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata
439
- */
440
- GetCharacterReadOnlyData(request, customData, extraHeaders) {
441
- return this.ExecuteRequestWrapper("/Server/GetCharacterReadOnlyData", request, "X-SecretKey", customData, extraHeaders);
442
- }
443
- /**
444
- * Retrieves the details of all title-specific statistics for the specific character
445
- * https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics
446
- */
447
- GetCharacterStatistics(request, customData, extraHeaders) {
448
- return this.ExecuteRequestWrapper("/Server/GetCharacterStatistics", request, "X-SecretKey", customData, extraHeaders);
449
- }
450
- /**
451
- * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
452
- * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
453
- * content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
454
- * the query to retrieve the data will fail. See this post for more information:
455
- * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
456
- * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
457
- * https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl
458
- */
459
- GetContentDownloadUrl(request, customData, extraHeaders) {
460
- return this.ExecuteRequestWrapper("/Server/GetContentDownloadUrl", request, "X-SecretKey", customData, extraHeaders);
461
- }
462
- /**
463
- * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
464
- * leaderboard
465
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard
466
- */
467
- GetFriendLeaderboard(request, customData, extraHeaders) {
468
- return this.ExecuteRequestWrapper("/Server/GetFriendLeaderboard", request, "X-SecretKey", customData, extraHeaders);
469
- }
470
- /**
471
- * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from
472
- * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
473
- * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist
474
- */
475
- GetFriendsList(request, customData, extraHeaders) {
476
- return this.ExecuteRequestWrapper("/Server/GetFriendsList", request, "X-SecretKey", customData, extraHeaders);
477
- }
478
- /**
479
- * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
480
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard
481
- */
482
- GetLeaderboard(request, customData, extraHeaders) {
483
- return this.ExecuteRequestWrapper("/Server/GetLeaderboard", request, "X-SecretKey", customData, extraHeaders);
484
- }
485
- /**
486
- * Retrieves a list of ranked characters for the given statistic, centered on the requested user
487
- * https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter
488
- */
489
- GetLeaderboardAroundCharacter(request, customData, extraHeaders) {
490
- return this.ExecuteRequestWrapper("/Server/GetLeaderboardAroundCharacter", request, "X-SecretKey", customData, extraHeaders);
491
- }
492
- /**
493
- * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
494
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser
495
- */
496
- GetLeaderboardAroundUser(request, customData, extraHeaders) {
497
- return this.ExecuteRequestWrapper("/Server/GetLeaderboardAroundUser", request, "X-SecretKey", customData, extraHeaders);
498
- }
499
- /**
500
- * Retrieves a list of all of the user's characters for the given statistic.
501
- * https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters
502
- */
503
- GetLeaderboardForUserCharacters(request, customData, extraHeaders) {
504
- return this.ExecuteRequestWrapper("/Server/GetLeaderboardForUserCharacters", request, "X-SecretKey", customData, extraHeaders);
505
- }
506
- /**
507
- * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
508
- * returned. All parameters default to false.
509
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo
510
- */
511
- GetPlayerCombinedInfo(request, customData, extraHeaders) {
512
- return this.ExecuteRequestWrapper("/Server/GetPlayerCombinedInfo", request, "X-SecretKey", customData, extraHeaders);
513
- }
514
- /**
515
- * Retrieves a title-specific custom property value for a player.
516
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty
517
- */
518
- GetPlayerCustomProperty(request, customData, extraHeaders) {
519
- return this.ExecuteRequestWrapper("/Server/GetPlayerCustomProperty", request, "X-SecretKey", customData, extraHeaders);
520
- }
521
- /**
522
- * Retrieves the player's profile
523
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile
524
- */
525
- GetPlayerProfile(request, customData, extraHeaders) {
526
- return this.ExecuteRequestWrapper("/Server/GetPlayerProfile", request, "X-SecretKey", customData, extraHeaders);
527
- }
528
- /**
529
- * List all segments that a player currently belongs to at this moment in time.
530
- * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments
531
- */
532
- GetPlayerSegments(request, customData, extraHeaders) {
533
- return this.ExecuteRequestWrapper("/Server/GetPlayerSegments", request, "X-SecretKey", customData, extraHeaders);
534
- }
535
- /**
536
- * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
537
- * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
538
- * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
539
- * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
540
- * called 30 times in one minute. You will be returned an error if you exceed this threshold.
541
- * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment
542
- */
543
- GetPlayersInSegment(request, customData, extraHeaders) {
544
- return this.ExecuteRequestWrapper("/Server/GetPlayersInSegment", request, "X-SecretKey", customData, extraHeaders);
545
- }
546
- /**
547
- * Retrieves the current version and values for the indicated statistics, for the local player.
548
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics
549
- */
550
- GetPlayerStatistics(request, customData, extraHeaders) {
551
- return this.ExecuteRequestWrapper("/Server/GetPlayerStatistics", request, "X-SecretKey", customData, extraHeaders);
552
- }
553
- /**
554
- * Retrieves the information on the available versions of the specified statistic.
555
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions
556
- */
557
- GetPlayerStatisticVersions(request, customData, extraHeaders) {
558
- return this.ExecuteRequestWrapper("/Server/GetPlayerStatisticVersions", request, "X-SecretKey", customData, extraHeaders);
559
- }
560
- /**
561
- * Get all tags with a given Namespace (optional) from a player profile.
562
- * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags
563
- */
564
- GetPlayerTags(request, customData, extraHeaders) {
565
- return this.ExecuteRequestWrapper("/Server/GetPlayerTags", request, "X-SecretKey", customData, extraHeaders);
566
- }
567
- /**
568
- * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
569
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids
570
- */
571
- GetPlayFabIDsFromBattleNetAccountIds(request, customData, extraHeaders) {
572
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromBattleNetAccountIds", request, "X-SecretKey", customData, extraHeaders);
573
- }
574
- /**
575
- * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
576
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids
577
- */
578
- GetPlayFabIDsFromFacebookIDs(request, customData, extraHeaders) {
579
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromFacebookIDs", request, "X-SecretKey", customData, extraHeaders);
580
- }
581
- /**
582
- * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.
583
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids
584
- */
585
- GetPlayFabIDsFromFacebookInstantGamesIds(request, customData, extraHeaders) {
586
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromFacebookInstantGamesIds", request, "X-SecretKey", customData, extraHeaders);
587
- }
588
- /**
589
- * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
590
- * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
591
- * added to the player account.
592
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids
593
- */
594
- GetPlayFabIDsFromGenericIDs(request, customData, extraHeaders) {
595
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromGenericIDs", request, "X-SecretKey", customData, extraHeaders);
596
- }
597
- /**
598
- * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
599
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids
600
- */
601
- GetPlayFabIDsFromNintendoServiceAccountIds(request, customData, extraHeaders) {
602
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromNintendoServiceAccountIds", request, "X-SecretKey", customData, extraHeaders);
603
- }
604
- /**
605
- * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
606
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids
607
- */
608
- GetPlayFabIDsFromNintendoSwitchDeviceIds(request, customData, extraHeaders) {
609
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-SecretKey", customData, extraHeaders);
610
- }
611
- /**
612
- * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
613
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids
614
- */
615
- GetPlayFabIDsFromPSNAccountIDs(request, customData, extraHeaders) {
616
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNAccountIDs", request, "X-SecretKey", customData, extraHeaders);
617
- }
618
- /**
619
- * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
620
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids
621
- */
622
- GetPlayFabIDsFromPSNOnlineIDs(request, customData, extraHeaders) {
623
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNOnlineIDs", request, "X-SecretKey", customData, extraHeaders);
624
- }
625
- /**
626
- * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
627
- * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
628
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids
629
- */
630
- GetPlayFabIDsFromSteamIDs(request, customData, extraHeaders) {
631
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamIDs", request, "X-SecretKey", customData, extraHeaders);
632
- }
633
- /**
634
- * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
635
- * names.
636
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames
637
- */
638
- GetPlayFabIDsFromSteamNames(request, customData, extraHeaders) {
639
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamNames", request, "X-SecretKey", customData, extraHeaders);
640
- }
641
- /**
642
- * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
643
- * the user accounts, available as "_id" from the Twitch API methods (ex:
644
- * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
645
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids
646
- */
647
- GetPlayFabIDsFromTwitchIDs(request, customData, extraHeaders) {
648
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromTwitchIDs", request, "X-SecretKey", customData, extraHeaders);
649
- }
650
- /**
651
- * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
652
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids
653
- */
654
- GetPlayFabIDsFromXboxLiveIDs(request, customData, extraHeaders) {
655
- return this.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromXboxLiveIDs", request, "X-SecretKey", customData, extraHeaders);
656
- }
657
- /**
658
- * Retrieves the key-value store of custom publisher settings
659
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata
660
- */
661
- GetPublisherData(request, customData, extraHeaders) {
662
- return this.ExecuteRequestWrapper("/Server/GetPublisherData", request, "X-SecretKey", customData, extraHeaders);
663
- }
664
- /**
665
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
666
- * version 2._ Retrieves the configuration information for the specified random results tables for the title, including all
667
- * ItemId values and weights
668
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables
669
- */
670
- GetRandomResultTables(request, customData, extraHeaders) {
671
- return this.ExecuteRequestWrapper("/Server/GetRandomResultTables", request, "X-SecretKey", customData, extraHeaders);
672
- }
673
- /**
674
- * Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
675
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids
676
- */
677
- GetServerCustomIDsFromPlayFabIDs(request, customData, extraHeaders) {
678
- return this.ExecuteRequestWrapper("/Server/GetServerCustomIDsFromPlayFabIDs", request, "X-SecretKey", customData, extraHeaders);
679
- }
680
- /**
681
- * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
682
- * public and private group data. Shared Groups are designed for sharing data between a very small number of players,
683
- * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
684
- * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata
685
- */
686
- GetSharedGroupData(request, customData, extraHeaders) {
687
- return this.ExecuteRequestWrapper("/Server/GetSharedGroupData", request, "X-SecretKey", customData, extraHeaders);
688
- }
689
- /**
690
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
691
- * version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified
692
- * player
693
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems
694
- */
695
- GetStoreItems(request, customData, extraHeaders) {
696
- return this.ExecuteRequestWrapper("/Server/GetStoreItems", request, "X-SecretKey", customData, extraHeaders);
697
- }
698
- /**
699
- * Retrieves the current server time
700
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime
701
- */
702
- GetTime(request, customData, extraHeaders) {
703
- return this.ExecuteRequestWrapper("/Server/GetTime", request, "X-SecretKey", customData, extraHeaders);
704
- }
705
- /**
706
- * Retrieves the key-value store of custom title settings
707
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata
708
- */
709
- GetTitleData(request, customData, extraHeaders) {
710
- return this.ExecuteRequestWrapper("/Server/GetTitleData", request, "X-SecretKey", customData, extraHeaders);
711
- }
712
- /**
713
- * Retrieves the key-value store of custom internal title settings
714
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata
715
- */
716
- GetTitleInternalData(request, customData, extraHeaders) {
717
- return this.ExecuteRequestWrapper("/Server/GetTitleInternalData", request, "X-SecretKey", customData, extraHeaders);
718
- }
719
- /**
720
- * Retrieves the title news feed, as configured in the developer portal
721
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews
722
- */
723
- GetTitleNews(request, customData, extraHeaders) {
724
- return this.ExecuteRequestWrapper("/Server/GetTitleNews", request, "X-SecretKey", customData, extraHeaders);
725
- }
726
- /**
727
- * Retrieves the relevant details for a specified user
728
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo
729
- */
730
- GetUserAccountInfo(request, customData, extraHeaders) {
731
- return this.ExecuteRequestWrapper("/Server/GetUserAccountInfo", request, "X-SecretKey", customData, extraHeaders);
732
- }
733
- /**
734
- * Gets all bans for a user.
735
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans
736
- */
737
- GetUserBans(request, customData, extraHeaders) {
738
- return this.ExecuteRequestWrapper("/Server/GetUserBans", request, "X-SecretKey", customData, extraHeaders);
739
- }
740
- /**
741
- * Retrieves the title-specific custom data for the user which is readable and writable by the client
742
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata
743
- */
744
- GetUserData(request, customData, extraHeaders) {
745
- return this.ExecuteRequestWrapper("/Server/GetUserData", request, "X-SecretKey", customData, extraHeaders);
746
- }
747
- /**
748
- * Retrieves the title-specific custom data for the user which cannot be accessed by the client
749
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata
750
- */
751
- GetUserInternalData(request, customData, extraHeaders) {
752
- return this.ExecuteRequestWrapper("/Server/GetUserInternalData", request, "X-SecretKey", customData, extraHeaders);
753
- }
754
- /**
755
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
756
- * version 2._ Retrieves the specified user's current inventory of virtual goods
757
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory
758
- */
759
- GetUserInventory(request, customData, extraHeaders) {
760
- return this.ExecuteRequestWrapper("/Server/GetUserInventory", request, "X-SecretKey", customData, extraHeaders);
761
- }
762
- /**
763
- * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
764
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata
765
- */
766
- GetUserPublisherData(request, customData, extraHeaders) {
767
- return this.ExecuteRequestWrapper("/Server/GetUserPublisherData", request, "X-SecretKey", customData, extraHeaders);
768
- }
769
- /**
770
- * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
771
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata
772
- */
773
- GetUserPublisherInternalData(request, customData, extraHeaders) {
774
- return this.ExecuteRequestWrapper("/Server/GetUserPublisherInternalData", request, "X-SecretKey", customData, extraHeaders);
775
- }
776
- /**
777
- * Retrieves the publisher-specific custom data for the user which can only be read by the client
778
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata
779
- */
780
- GetUserPublisherReadOnlyData(request, customData, extraHeaders) {
781
- return this.ExecuteRequestWrapper("/Server/GetUserPublisherReadOnlyData", request, "X-SecretKey", customData, extraHeaders);
782
- }
783
- /**
784
- * Retrieves the title-specific custom data for the user which can only be read by the client
785
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata
786
- */
787
- GetUserReadOnlyData(request, customData, extraHeaders) {
788
- return this.ExecuteRequestWrapper("/Server/GetUserReadOnlyData", request, "X-SecretKey", customData, extraHeaders);
789
- }
790
- /**
791
- * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
792
- * with the parent PlayFabId to guarantee uniqueness.
793
- * https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser
794
- */
795
- GrantCharacterToUser(request, customData, extraHeaders) {
796
- return this.ExecuteRequestWrapper("/Server/GrantCharacterToUser", request, "X-SecretKey", customData, extraHeaders);
797
- }
798
- /**
799
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
800
- * version 2._ Adds the specified items to the specified character's inventory
801
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter
802
- */
803
- GrantItemsToCharacter(request, customData, extraHeaders) {
804
- return this.ExecuteRequestWrapper("/Server/GrantItemsToCharacter", request, "X-SecretKey", customData, extraHeaders);
805
- }
806
- /**
807
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
808
- * version 2._ Adds the specified items to the specified user's inventory
809
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser
810
- */
811
- GrantItemsToUser(request, customData, extraHeaders) {
812
- return this.ExecuteRequestWrapper("/Server/GrantItemsToUser", request, "X-SecretKey", customData, extraHeaders);
813
- }
814
- /**
815
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
816
- * version 2._ Adds the specified items to the specified user inventories
817
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers
818
- */
819
- GrantItemsToUsers(request, customData, extraHeaders) {
820
- return this.ExecuteRequestWrapper("/Server/GrantItemsToUsers", request, "X-SecretKey", customData, extraHeaders);
821
- }
822
- /**
823
- * Links the Battle.net account associated with the token to the user's PlayFab account.
824
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount
825
- */
826
- LinkBattleNetAccount(request, customData, extraHeaders) {
827
- return this.ExecuteRequestWrapper("/Server/LinkBattleNetAccount", request, "X-SecretKey", customData, extraHeaders);
828
- }
829
- /**
830
- * Links the Nintendo account associated with the token to the user's PlayFab account
831
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount
832
- */
833
- LinkNintendoServiceAccount(request, customData, extraHeaders) {
834
- return this.ExecuteRequestWrapper("/Server/LinkNintendoServiceAccount", request, "X-SecretKey", customData, extraHeaders);
835
- }
836
- /**
837
- * Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
838
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject
839
- */
840
- LinkNintendoServiceAccountSubject(request, customData, extraHeaders) {
841
- return this.ExecuteRequestWrapper("/Server/LinkNintendoServiceAccountSubject", request, "X-SecretKey", customData, extraHeaders);
842
- }
843
- /**
844
- * Links the NintendoSwitchDeviceId to the user's PlayFab account
845
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid
846
- */
847
- LinkNintendoSwitchDeviceId(request, customData, extraHeaders) {
848
- return this.ExecuteRequestWrapper("/Server/LinkNintendoSwitchDeviceId", request, "X-SecretKey", customData, extraHeaders);
849
- }
850
- /**
851
- * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
852
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount
853
- */
854
- LinkPSNAccount(request, customData, extraHeaders) {
855
- return this.ExecuteRequestWrapper("/Server/LinkPSNAccount", request, "X-SecretKey", customData, extraHeaders);
856
- }
857
- /**
858
- * Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
859
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid
860
- */
861
- LinkPSNId(request, customData, extraHeaders) {
862
- return this.ExecuteRequestWrapper("/Server/LinkPSNId", request, "X-SecretKey", customData, extraHeaders);
863
- }
864
- /**
865
- * Links the custom server identifier, generated by the title, to the user's PlayFab account.
866
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid
867
- */
868
- LinkServerCustomId(request, customData, extraHeaders) {
869
- return this.ExecuteRequestWrapper("/Server/LinkServerCustomId", request, "X-SecretKey", customData, extraHeaders);
870
- }
871
- /**
872
- * Links the Steam account associated with the provided Steam ID to the user's PlayFab account
873
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid
874
- */
875
- LinkSteamId(request, customData, extraHeaders) {
876
- return this.ExecuteRequestWrapper("/Server/LinkSteamId", request, "X-SecretKey", customData, extraHeaders);
877
- }
878
- /**
879
- * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
880
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount
881
- */
882
- LinkXboxAccount(request, customData, extraHeaders) {
883
- return this.ExecuteRequestWrapper("/Server/LinkXboxAccount", request, "X-SecretKey", customData, extraHeaders);
884
- }
885
- /**
886
- * Retrieves title-specific custom property values for a player.
887
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties
888
- */
889
- ListPlayerCustomProperties(request, customData, extraHeaders) {
890
- return this.ExecuteRequestWrapper("/Server/ListPlayerCustomProperties", request, "X-SecretKey", customData, extraHeaders);
891
- }
892
- /**
893
- * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
894
- * API calls which require an authenticated user
895
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid
896
- */
897
- LoginWithAndroidDeviceID(request, customData, extraHeaders) {
898
- return this.ExecuteRequestWrapper("/Server/LoginWithAndroidDeviceID", request, "X-SecretKey", customData, extraHeaders);
899
- }
900
- /**
901
- * Sign in the user with a Battle.net identity token
902
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet
903
- */
904
- LoginWithBattleNet(request, customData, extraHeaders) {
905
- return this.ExecuteRequestWrapper("/Server/LoginWithBattleNet", request, "X-SecretKey", customData, extraHeaders);
906
- }
907
- /**
908
- * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
909
- * subsequently be used for API calls which require an authenticated user
910
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid
911
- */
912
- LoginWithCustomID(request, customData, extraHeaders) {
913
- return this.ExecuteRequestWrapper("/Server/LoginWithCustomID", request, "X-SecretKey", customData, extraHeaders);
914
- }
915
- /**
916
- * Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API
917
- * calls which require an authenticated user
918
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid
919
- */
920
- LoginWithIOSDeviceID(request, customData, extraHeaders) {
921
- return this.ExecuteRequestWrapper("/Server/LoginWithIOSDeviceID", request, "X-SecretKey", customData, extraHeaders);
922
- }
923
- /**
924
- * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
925
- * subsequently be used for API calls which require an authenticated user
926
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn
927
- */
928
- LoginWithPSN(request, customData, extraHeaders) {
929
- return this.ExecuteRequestWrapper("/Server/LoginWithPSN", request, "X-SecretKey", customData, extraHeaders);
930
- }
931
- /**
932
- * Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
933
- * and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
934
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid
935
- */
936
- LoginWithServerCustomId(request, customData, extraHeaders) {
937
- return this.ExecuteRequestWrapper("/Server/LoginWithServerCustomId", request, "X-SecretKey", customData, extraHeaders);
938
- }
939
- /**
940
- * Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which
941
- * require an authenticated user
942
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid
943
- */
944
- LoginWithSteamId(request, customData, extraHeaders) {
945
- return this.ExecuteRequestWrapper("/Server/LoginWithSteamId", request, "X-SecretKey", customData, extraHeaders);
946
- }
947
- /**
948
- * Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
949
- * subsequently be used for API calls which require an authenticated user
950
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox
951
- */
952
- LoginWithXbox(request, customData, extraHeaders) {
953
- return this.ExecuteRequestWrapper("/Server/LoginWithXbox", request, "X-SecretKey", customData, extraHeaders);
954
- }
955
- /**
956
- * Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API
957
- * calls which require an authenticated user
958
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid
959
- */
960
- LoginWithXboxId(request, customData, extraHeaders) {
961
- return this.ExecuteRequestWrapper("/Server/LoginWithXboxId", request, "X-SecretKey", customData, extraHeaders);
962
- }
963
- /**
964
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
965
- * version 2._ Modifies the number of remaining uses of a player's inventory item
966
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses
967
- */
968
- ModifyItemUses(request, customData, extraHeaders) {
969
- return this.ExecuteRequestWrapper("/Server/ModifyItemUses", request, "X-SecretKey", customData, extraHeaders);
970
- }
971
- /**
972
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
973
- * version 2._ Moves an item from a character's inventory into another of the users's character's inventory.
974
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter
975
- */
976
- MoveItemToCharacterFromCharacter(request, customData, extraHeaders) {
977
- return this.ExecuteRequestWrapper("/Server/MoveItemToCharacterFromCharacter", request, "X-SecretKey", customData, extraHeaders);
978
- }
979
- /**
980
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
981
- * version 2._ Moves an item from a user's inventory into their character's inventory.
982
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser
983
- */
984
- MoveItemToCharacterFromUser(request, customData, extraHeaders) {
985
- return this.ExecuteRequestWrapper("/Server/MoveItemToCharacterFromUser", request, "X-SecretKey", customData, extraHeaders);
986
- }
987
- /**
988
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
989
- * version 2._ Moves an item from a character's inventory into the owning user's inventory.
990
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter
991
- */
992
- MoveItemToUserFromCharacter(request, customData, extraHeaders) {
993
- return this.ExecuteRequestWrapper("/Server/MoveItemToUserFromCharacter", request, "X-SecretKey", customData, extraHeaders);
994
- }
995
- /**
996
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
997
- * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
998
- * Economy->Catalogs tab in the PlayFab Game Manager.
999
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon
1000
- */
1001
- RedeemCoupon(request, customData, extraHeaders) {
1002
- return this.ExecuteRequestWrapper("/Server/RedeemCoupon", request, "X-SecretKey", customData, extraHeaders);
1003
- }
1004
- /**
1005
- * Removes the specified friend from the the user's friend list
1006
- * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend
1007
- */
1008
- RemoveFriend(request, customData, extraHeaders) {
1009
- return this.ExecuteRequestWrapper("/Server/RemoveFriend", request, "X-SecretKey", customData, extraHeaders);
1010
- }
1011
- /**
1012
- * Removes the specified generic service identifier from the player's PlayFab account.
1013
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid
1014
- */
1015
- RemoveGenericID(request, customData, extraHeaders) {
1016
- return this.ExecuteRequestWrapper("/Server/RemoveGenericID", request, "X-SecretKey", customData, extraHeaders);
1017
- }
1018
- /**
1019
- * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
1020
- * https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag
1021
- */
1022
- RemovePlayerTag(request, customData, extraHeaders) {
1023
- return this.ExecuteRequestWrapper("/Server/RemovePlayerTag", request, "X-SecretKey", customData, extraHeaders);
1024
- }
1025
- /**
1026
- * 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
1027
- * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
1028
- * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
1029
- * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1030
- * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers
1031
- */
1032
- RemoveSharedGroupMembers(request, customData, extraHeaders) {
1033
- return this.ExecuteRequestWrapper("/Server/RemoveSharedGroupMembers", request, "X-SecretKey", customData, extraHeaders);
1034
- }
1035
- /**
1036
- * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service
1037
- * representatives for the title can take action concerning potentially toxic players.
1038
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer
1039
- */
1040
- ReportPlayer(request, customData, extraHeaders) {
1041
- return this.ExecuteRequestWrapper("/Server/ReportPlayer", request, "X-SecretKey", customData, extraHeaders);
1042
- }
1043
- /**
1044
- * Revoke all active bans for a user.
1045
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser
1046
- */
1047
- RevokeAllBansForUser(request, customData, extraHeaders) {
1048
- return this.ExecuteRequestWrapper("/Server/RevokeAllBansForUser", request, "X-SecretKey", customData, extraHeaders);
1049
- }
1050
- /**
1051
- * Revoke all active bans specified with BanId.
1052
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans
1053
- */
1054
- RevokeBans(request, customData, extraHeaders) {
1055
- return this.ExecuteRequestWrapper("/Server/RevokeBans", request, "X-SecretKey", customData, extraHeaders);
1056
- }
1057
- /**
1058
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1059
- * version 2._ Revokes access to an item in a user's inventory
1060
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem
1061
- */
1062
- RevokeInventoryItem(request, customData, extraHeaders) {
1063
- return this.ExecuteRequestWrapper("/Server/RevokeInventoryItem", request, "X-SecretKey", customData, extraHeaders);
1064
- }
1065
- /**
1066
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1067
- * version 2._ Revokes access for up to 25 items across multiple users and characters.
1068
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems
1069
- */
1070
- RevokeInventoryItems(request, customData, extraHeaders) {
1071
- return this.ExecuteRequestWrapper("/Server/RevokeInventoryItems", request, "X-SecretKey", customData, extraHeaders);
1072
- }
1073
- /**
1074
- * Saves push notification template for title
1075
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate
1076
- */
1077
- SavePushNotificationTemplate(request, customData, extraHeaders) {
1078
- return this.ExecuteRequestWrapper("/Server/SavePushNotificationTemplate", request, "X-SecretKey", customData, extraHeaders);
1079
- }
1080
- /**
1081
- * Forces an email to be sent to the registered contact email address for the user's account based on an account recovery
1082
- * email template
1083
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail
1084
- */
1085
- SendCustomAccountRecoveryEmail(request, customData, extraHeaders) {
1086
- return this.ExecuteRequestWrapper("/Server/SendCustomAccountRecoveryEmail", request, "X-SecretKey", customData, extraHeaders);
1087
- }
1088
- /**
1089
- * Sends an email based on an email template to a player's contact email
1090
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate
1091
- */
1092
- SendEmailFromTemplate(request, customData, extraHeaders) {
1093
- return this.ExecuteRequestWrapper("/Server/SendEmailFromTemplate", request, "X-SecretKey", customData, extraHeaders);
1094
- }
1095
- /**
1096
- * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push
1097
- * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
1098
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification
1099
- */
1100
- SendPushNotification(request, customData, extraHeaders) {
1101
- return this.ExecuteRequestWrapper("/Server/SendPushNotification", request, "X-SecretKey", customData, extraHeaders);
1102
- }
1103
- /**
1104
- * Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push
1105
- * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
1106
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate
1107
- */
1108
- SendPushNotificationFromTemplate(request, customData, extraHeaders) {
1109
- return this.ExecuteRequestWrapper("/Server/SendPushNotificationFromTemplate", request, "X-SecretKey", customData, extraHeaders);
1110
- }
1111
- /**
1112
- * Updates the tag list for a specified user in the friend list of another user
1113
- * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags
1114
- */
1115
- SetFriendTags(request, customData, extraHeaders) {
1116
- return this.ExecuteRequestWrapper("/Server/SetFriendTags", request, "X-SecretKey", customData, extraHeaders);
1117
- }
1118
- /**
1119
- * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
1120
- * secret use the Admin or Server API method SetPlayerSecret.
1121
- * https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret
1122
- */
1123
- SetPlayerSecret(request, customData, extraHeaders) {
1124
- return this.ExecuteRequestWrapper("/Server/SetPlayerSecret", request, "X-SecretKey", customData, extraHeaders);
1125
- }
1126
- /**
1127
- * Updates the key-value store of custom publisher settings
1128
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata
1129
- */
1130
- SetPublisherData(request, customData, extraHeaders) {
1131
- return this.ExecuteRequestWrapper("/Server/SetPublisherData", request, "X-SecretKey", customData, extraHeaders);
1132
- }
1133
- /**
1134
- * Updates the key-value store of custom title settings
1135
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata
1136
- */
1137
- SetTitleData(request, customData, extraHeaders) {
1138
- return this.ExecuteRequestWrapper("/Server/SetTitleData", request, "X-SecretKey", customData, extraHeaders);
1139
- }
1140
- /**
1141
- * Updates the key-value store of custom title settings
1142
- * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata
1143
- */
1144
- SetTitleInternalData(request, customData, extraHeaders) {
1145
- return this.ExecuteRequestWrapper("/Server/SetTitleInternalData", request, "X-SecretKey", customData, extraHeaders);
1146
- }
1147
- /**
1148
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1149
- * version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to
1150
- * make a VC balance negative with this API.
1151
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency
1152
- */
1153
- SubtractCharacterVirtualCurrency(request, customData, extraHeaders) {
1154
- return this.ExecuteRequestWrapper("/Server/SubtractCharacterVirtualCurrency", request, "X-SecretKey", customData, extraHeaders);
1155
- }
1156
- /**
1157
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1158
- * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
1159
- * a VC balance negative with this API.
1160
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency
1161
- */
1162
- SubtractUserVirtualCurrency(request, customData, extraHeaders) {
1163
- return this.ExecuteRequestWrapper("/Server/SubtractUserVirtualCurrency", request, "X-SecretKey", customData, extraHeaders);
1164
- }
1165
- /**
1166
- * Unlinks the related Battle.net account from the user's PlayFab account.
1167
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount
1168
- */
1169
- UnlinkBattleNetAccount(request, customData, extraHeaders) {
1170
- return this.ExecuteRequestWrapper("/Server/UnlinkBattleNetAccount", request, "X-SecretKey", customData, extraHeaders);
1171
- }
1172
- /**
1173
- * Unlinks the related Nintendo account from the user's PlayFab account
1174
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount
1175
- */
1176
- UnlinkNintendoServiceAccount(request, customData, extraHeaders) {
1177
- return this.ExecuteRequestWrapper("/Server/UnlinkNintendoServiceAccount", request, "X-SecretKey", customData, extraHeaders);
1178
- }
1179
- /**
1180
- * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
1181
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid
1182
- */
1183
- UnlinkNintendoSwitchDeviceId(request, customData, extraHeaders) {
1184
- return this.ExecuteRequestWrapper("/Server/UnlinkNintendoSwitchDeviceId", request, "X-SecretKey", customData, extraHeaders);
1185
- }
1186
- /**
1187
- * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
1188
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount
1189
- */
1190
- UnlinkPSNAccount(request, customData, extraHeaders) {
1191
- return this.ExecuteRequestWrapper("/Server/UnlinkPSNAccount", request, "X-SecretKey", customData, extraHeaders);
1192
- }
1193
- /**
1194
- * Unlinks the custom server identifier from the user's PlayFab account.
1195
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid
1196
- */
1197
- UnlinkServerCustomId(request, customData, extraHeaders) {
1198
- return this.ExecuteRequestWrapper("/Server/UnlinkServerCustomId", request, "X-SecretKey", customData, extraHeaders);
1199
- }
1200
- /**
1201
- * Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account
1202
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid
1203
- */
1204
- UnlinkSteamId(request, customData, extraHeaders) {
1205
- return this.ExecuteRequestWrapper("/Server/UnlinkSteamId", request, "X-SecretKey", customData, extraHeaders);
1206
- }
1207
- /**
1208
- * Unlinks the related Xbox Live account from the user's PlayFab account
1209
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount
1210
- */
1211
- UnlinkXboxAccount(request, customData, extraHeaders) {
1212
- return this.ExecuteRequestWrapper("/Server/UnlinkXboxAccount", request, "X-SecretKey", customData, extraHeaders);
1213
- }
1214
- /**
1215
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1216
- * version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when
1217
- * required), and returns the contents of the opened container. If the container (and key when relevant) are consumable
1218
- * (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
1219
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance
1220
- */
1221
- UnlockContainerInstance(request, customData, extraHeaders) {
1222
- return this.ExecuteRequestWrapper("/Server/UnlockContainerInstance", request, "X-SecretKey", customData, extraHeaders);
1223
- }
1224
- /**
1225
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1226
- * version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary
1227
- * unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when
1228
- * relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of
1229
- * ConsumeItem.
1230
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem
1231
- */
1232
- UnlockContainerItem(request, customData, extraHeaders) {
1233
- return this.ExecuteRequestWrapper("/Server/UnlockContainerItem", request, "X-SecretKey", customData, extraHeaders);
1234
- }
1235
- /**
1236
- * Update the avatar URL of the specified player
1237
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl
1238
- */
1239
- UpdateAvatarUrl(request, customData, extraHeaders) {
1240
- return this.ExecuteRequestWrapper("/Server/UpdateAvatarUrl", request, "X-SecretKey", customData, extraHeaders);
1241
- }
1242
- /**
1243
- * Updates information of a list of existing bans specified with Ban Ids.
1244
- * https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans
1245
- */
1246
- UpdateBans(request, customData, extraHeaders) {
1247
- return this.ExecuteRequestWrapper("/Server/UpdateBans", request, "X-SecretKey", customData, extraHeaders);
1248
- }
1249
- /**
1250
- * Updates the title-specific custom data for the user's character which is readable and writable by the client
1251
- * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata
1252
- */
1253
- UpdateCharacterData(request, customData, extraHeaders) {
1254
- return this.ExecuteRequestWrapper("/Server/UpdateCharacterData", request, "X-SecretKey", customData, extraHeaders);
1255
- }
1256
- /**
1257
- * Updates the title-specific custom data for the user's character which cannot be accessed by the client
1258
- * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata
1259
- */
1260
- UpdateCharacterInternalData(request, customData, extraHeaders) {
1261
- return this.ExecuteRequestWrapper("/Server/UpdateCharacterInternalData", request, "X-SecretKey", customData, extraHeaders);
1262
- }
1263
- /**
1264
- * Updates the title-specific custom data for the user's character which can only be read by the client
1265
- * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata
1266
- */
1267
- UpdateCharacterReadOnlyData(request, customData, extraHeaders) {
1268
- return this.ExecuteRequestWrapper("/Server/UpdateCharacterReadOnlyData", request, "X-SecretKey", customData, extraHeaders);
1269
- }
1270
- /**
1271
- * Updates the values of the specified title-specific statistics for the specific character
1272
- * https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics
1273
- */
1274
- UpdateCharacterStatistics(request, customData, extraHeaders) {
1275
- return this.ExecuteRequestWrapper("/Server/UpdateCharacterStatistics", request, "X-SecretKey", customData, extraHeaders);
1276
- }
1277
- /**
1278
- * Updates the title-specific custom property values for a player
1279
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties
1280
- */
1281
- UpdatePlayerCustomProperties(request, customData, extraHeaders) {
1282
- return this.ExecuteRequestWrapper("/Server/UpdatePlayerCustomProperties", request, "X-SecretKey", customData, extraHeaders);
1283
- }
1284
- /**
1285
- * Updates the values of the specified title-specific statistics for the user
1286
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics
1287
- */
1288
- UpdatePlayerStatistics(request, customData, extraHeaders) {
1289
- return this.ExecuteRequestWrapper("/Server/UpdatePlayerStatistics", request, "X-SecretKey", customData, extraHeaders);
1290
- }
1291
- /**
1292
- * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
1293
- * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
1294
- * Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are
1295
- * designed for sharing data between a very small number of players, please see our guide:
1296
- * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
1297
- * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata
1298
- */
1299
- UpdateSharedGroupData(request, customData, extraHeaders) {
1300
- return this.ExecuteRequestWrapper("/Server/UpdateSharedGroupData", request, "X-SecretKey", customData, extraHeaders);
1301
- }
1302
- /**
1303
- * Updates the title-specific custom data for the user which is readable and writable by the client
1304
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata
1305
- */
1306
- UpdateUserData(request, customData, extraHeaders) {
1307
- return this.ExecuteRequestWrapper("/Server/UpdateUserData", request, "X-SecretKey", customData, extraHeaders);
1308
- }
1309
- /**
1310
- * Updates the title-specific custom data for the user which cannot be accessed by the client
1311
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata
1312
- */
1313
- UpdateUserInternalData(request, customData, extraHeaders) {
1314
- return this.ExecuteRequestWrapper("/Server/UpdateUserInternalData", request, "X-SecretKey", customData, extraHeaders);
1315
- }
1316
- /**
1317
- * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
1318
- * version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.
1319
- * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata
1320
- */
1321
- UpdateUserInventoryItemCustomData(request, customData, extraHeaders) {
1322
- return this.ExecuteRequestWrapper("/Server/UpdateUserInventoryItemCustomData", request, "X-SecretKey", customData, extraHeaders);
1323
- }
1324
- /**
1325
- * Updates the publisher-specific custom data for the user which is readable and writable by the client
1326
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata
1327
- */
1328
- UpdateUserPublisherData(request, customData, extraHeaders) {
1329
- return this.ExecuteRequestWrapper("/Server/UpdateUserPublisherData", request, "X-SecretKey", customData, extraHeaders);
1330
- }
1331
- /**
1332
- * Updates the publisher-specific custom data for the user which cannot be accessed by the client
1333
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata
1334
- */
1335
- UpdateUserPublisherInternalData(request, customData, extraHeaders) {
1336
- return this.ExecuteRequestWrapper("/Server/UpdateUserPublisherInternalData", request, "X-SecretKey", customData, extraHeaders);
1337
- }
1338
- /**
1339
- * Updates the publisher-specific custom data for the user which can only be read by the client
1340
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata
1341
- */
1342
- UpdateUserPublisherReadOnlyData(request, customData, extraHeaders) {
1343
- return this.ExecuteRequestWrapper("/Server/UpdateUserPublisherReadOnlyData", request, "X-SecretKey", customData, extraHeaders);
1344
- }
1345
- /**
1346
- * Updates the title-specific custom data for the user which can only be read by the client
1347
- * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata
1348
- */
1349
- UpdateUserReadOnlyData(request, customData, extraHeaders) {
1350
- return this.ExecuteRequestWrapper("/Server/UpdateUserReadOnlyData", request, "X-SecretKey", customData, extraHeaders);
1351
- }
1352
- /**
1353
- * Writes a character-based event into PlayStream.
1354
- * https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent
1355
- */
1356
- WriteCharacterEvent(request, customData, extraHeaders) {
1357
- return this.ExecuteRequestWrapper("/Server/WriteCharacterEvent", request, "X-SecretKey", customData, extraHeaders);
1358
- }
1359
- /**
1360
- * Writes a player-based event into PlayStream.
1361
- * https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent
1362
- */
1363
- WritePlayerEvent(request, customData, extraHeaders) {
1364
- return this.ExecuteRequestWrapper("/Server/WritePlayerEvent", request, "X-SecretKey", customData, extraHeaders);
1365
- }
1366
- /**
1367
- * Writes a title-based event into PlayStream.
1368
- * https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent
1369
- */
1370
- WriteTitleEvent(request, customData, extraHeaders) {
1371
- return this.ExecuteRequestWrapper("/Server/WriteTitleEvent", request, "X-SecretKey", customData, extraHeaders);
1372
- }
1373
- };
1
+ import {
2
+ PlayFabServerApi
3
+ } from "./chunk-BZECCU2H.js";
4
+ import "./chunk-CY3H2GBI.js";
1374
5
  export {
1375
6
  PlayFabServerApi as default
1376
7
  };