async-playfab-web-sdk 1.192.250526-1

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 (54) hide show
  1. package/dist/Addon.d.ts +591 -0
  2. package/dist/Addon.js +452 -0
  3. package/dist/Addon.js.map +1 -0
  4. package/dist/Admin.d.ts +3484 -0
  5. package/dist/Admin.js +1112 -0
  6. package/dist/Admin.js.map +1 -0
  7. package/dist/Authentication.d.ts +109 -0
  8. package/dist/Authentication.js +290 -0
  9. package/dist/Authentication.js.map +1 -0
  10. package/dist/Client.d.ts +4482 -0
  11. package/dist/Client.js +1893 -0
  12. package/dist/Client.js.map +1 -0
  13. package/dist/CloudScript.d.ts +511 -0
  14. package/dist/CloudScript.js +349 -0
  15. package/dist/CloudScript.js.map +1 -0
  16. package/dist/Data.d.ts +228 -0
  17. package/dist/Data.js +291 -0
  18. package/dist/Data.js.map +1 -0
  19. package/dist/Economy.d.ts +1865 -0
  20. package/dist/Economy.js +614 -0
  21. package/dist/Economy.js.map +1 -0
  22. package/dist/Events.d.ts +307 -0
  23. package/dist/Events.js +327 -0
  24. package/dist/Events.js.map +1 -0
  25. package/dist/Experimentation.d.ts +357 -0
  26. package/dist/Experimentation.js +333 -0
  27. package/dist/Experimentation.js.map +1 -0
  28. package/dist/Groups.d.ts +546 -0
  29. package/dist/Groups.js +417 -0
  30. package/dist/Groups.js.map +1 -0
  31. package/dist/Insights.d.ts +141 -0
  32. package/dist/Insights.js +286 -0
  33. package/dist/Insights.js.map +1 -0
  34. package/dist/Localization.d.ts +20 -0
  35. package/dist/Localization.js +249 -0
  36. package/dist/Localization.js.map +1 -0
  37. package/dist/Multiplayer.d.ts +3059 -0
  38. package/dist/Multiplayer.js +862 -0
  39. package/dist/Multiplayer.js.map +1 -0
  40. package/dist/PlayFabCommon-BUv4zqXf.d.ts +72 -0
  41. package/dist/Profiles.d.ts +278 -0
  42. package/dist/Profiles.js +306 -0
  43. package/dist/Profiles.js.map +1 -0
  44. package/dist/Progression.d.ts +598 -0
  45. package/dist/Progression.js +404 -0
  46. package/dist/Progression.js.map +1 -0
  47. package/dist/Server.d.ts +3889 -0
  48. package/dist/Server.js +1377 -0
  49. package/dist/Server.js.map +1 -0
  50. package/dist/index.d.ts +17 -0
  51. package/dist/index.js +6007 -0
  52. package/dist/index.js.map +1 -0
  53. package/package.json +23 -0
  54. package/readme.md +25 -0
@@ -0,0 +1,3889 @@
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
2
+
3
+ interface AdCampaignAttribution {
4
+ /** UTC time stamp of attribution */
5
+ AttributedAt: string;
6
+ /** Attribution campaign identifier */
7
+ CampaignId?: string;
8
+ /** Attribution network name */
9
+ Platform?: string;
10
+ }
11
+ interface AdCampaignAttributionModel {
12
+ /** UTC time stamp of attribution */
13
+ AttributedAt: string;
14
+ /** Attribution campaign identifier */
15
+ CampaignId?: string;
16
+ /** Attribution network name */
17
+ Platform?: string;
18
+ }
19
+ interface AddCharacterVirtualCurrencyRequest extends IPlayFabRequestCommon {
20
+ /**
21
+ * Amount to be added to the character balance of the specified virtual currency. Maximum VC balance is Int32
22
+ * (2,147,483,647). Any increase over this value will be discarded.
23
+ */
24
+ Amount: number;
25
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
26
+ CharacterId: string;
27
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
28
+ CustomTags?: Record<string, string | null>;
29
+ /** PlayFab unique identifier of the user whose virtual currency balance is to be incremented. */
30
+ PlayFabId: string;
31
+ /** Name of the virtual currency which is to be incremented. */
32
+ VirtualCurrency: string;
33
+ }
34
+ interface AddFriendRequest extends IPlayFabRequestCommon {
35
+ /** Email address of the user being added. */
36
+ FriendEmail?: string;
37
+ /** The PlayFab identifier of the user being added. */
38
+ FriendPlayFabId?: string;
39
+ /** Title-specific display name of the user to being added. */
40
+ FriendTitleDisplayName?: string;
41
+ /** The PlayFab username of the user being added */
42
+ FriendUsername?: string;
43
+ /** PlayFab identifier of the player to add a new friend. */
44
+ PlayFabId: string;
45
+ }
46
+ interface AddGenericIDRequest extends IPlayFabRequestCommon {
47
+ /** Generic service identifier to add to the player account. */
48
+ GenericId: GenericServiceId;
49
+ /** PlayFabId of the user to link. */
50
+ PlayFabId: string;
51
+ }
52
+ interface AddPlayerTagRequest extends IPlayFabRequestCommon {
53
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
54
+ CustomTags?: Record<string, string | null>;
55
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
56
+ PlayFabId: string;
57
+ /** Unique tag for player profile. */
58
+ TagName: string;
59
+ }
60
+ interface AddPlayerTagResult extends IPlayFabResultCommon {
61
+ }
62
+ interface AddSharedGroupMembersRequest extends IPlayFabRequestCommon {
63
+ /** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
64
+ PlayFabIds: string[];
65
+ /** Unique identifier for the shared group. */
66
+ SharedGroupId: string;
67
+ }
68
+ interface AddSharedGroupMembersResult extends IPlayFabResultCommon {
69
+ }
70
+ interface AddUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
71
+ /**
72
+ * Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647).
73
+ * Any increase over this value will be discarded.
74
+ */
75
+ Amount: number;
76
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
77
+ CustomTags?: Record<string, string | null>;
78
+ /** PlayFab unique identifier of the user whose virtual currency balance is to be increased. */
79
+ PlayFabId: string;
80
+ /** Name of the virtual currency which is to be incremented. */
81
+ VirtualCurrency: string;
82
+ }
83
+ interface AdvancedPushPlatformMsg {
84
+ /**
85
+ * Stops GoogleCloudMessaging notifications from including both notification and data properties and instead only sends the
86
+ * data property.
87
+ */
88
+ GCMDataOnly?: boolean;
89
+ /** The Json the platform should receive. */
90
+ Json: string;
91
+ /** The platform that should receive the Json. */
92
+ Platform: string;
93
+ }
94
+ interface AuthenticateSessionTicketRequest extends IPlayFabRequestCommon {
95
+ /** Session ticket as issued by a PlayFab client login API. */
96
+ SessionTicket: string;
97
+ }
98
+ interface AuthenticateSessionTicketResult extends IPlayFabResultCommon {
99
+ /** Indicates if token was expired at request time. */
100
+ IsSessionTicketExpired?: boolean;
101
+ /** Account info for the user whose session ticket was supplied. */
102
+ UserInfo?: UserAccountInfo;
103
+ }
104
+ interface AwardSteamAchievementItem {
105
+ /** Unique Steam achievement name. */
106
+ AchievementName: string;
107
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
108
+ PlayFabId: string;
109
+ /** Result of the award attempt (only valid on response, not on request). */
110
+ Result: boolean;
111
+ }
112
+ interface AwardSteamAchievementRequest extends IPlayFabRequestCommon {
113
+ /** Array of achievements to grant and the users to whom they are to be granted. */
114
+ Achievements: AwardSteamAchievementItem[];
115
+ }
116
+ interface AwardSteamAchievementResult extends IPlayFabResultCommon {
117
+ /** Array of achievements granted. */
118
+ AchievementResults?: AwardSteamAchievementItem[];
119
+ }
120
+ interface BanInfo {
121
+ /** The active state of this ban. Expired bans may still have this value set to true but they will have no effect. */
122
+ Active: boolean;
123
+ /** The unique Ban Id associated with this ban. */
124
+ BanId?: string;
125
+ /** The time when this ban was applied. */
126
+ Created?: string;
127
+ /** The time when this ban expires. Permanent bans do not have expiration date. */
128
+ Expires?: string;
129
+ /** The IP address on which the ban was applied. May affect multiple players. */
130
+ IPAddress?: string;
131
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
132
+ PlayFabId?: string;
133
+ /** The reason why this ban was applied. */
134
+ Reason?: string;
135
+ /** The family type of the user that is included in the ban. */
136
+ UserFamilyType?: string;
137
+ }
138
+ interface BanRequest {
139
+ /** The duration in hours for the ban. Leave this blank for a permanent ban. */
140
+ DurationInHours?: number;
141
+ /** IP address to be banned. May affect multiple players. */
142
+ IPAddress?: string;
143
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
144
+ PlayFabId: string;
145
+ /** The reason for this ban. Maximum 140 characters. */
146
+ Reason?: string;
147
+ /** The family type of the user that should be included in the ban if applicable. May affect multiple players. */
148
+ UserFamilyType?: string;
149
+ }
150
+ interface BanUsersRequest extends IPlayFabRequestCommon {
151
+ /** List of ban requests to be applied. Maximum 100. */
152
+ Bans: BanRequest[];
153
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
154
+ CustomTags?: Record<string, string | null>;
155
+ }
156
+ interface BanUsersResult extends IPlayFabResultCommon {
157
+ /** Information on the bans that were applied */
158
+ BanData?: BanInfo[];
159
+ }
160
+ interface BattleNetAccountPlayFabIdPair {
161
+ /** Unique Battle.net account identifier for a user. */
162
+ BattleNetAccountId?: string;
163
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Battle.net account identifier. */
164
+ PlayFabId?: string;
165
+ }
166
+ interface CatalogItem {
167
+ /**
168
+ * defines the bundle properties for the item - bundles are items which contain other items, including random drop tables
169
+ * and virtual currencies
170
+ */
171
+ Bundle?: CatalogItemBundleInfo;
172
+ /** if true, then an item instance of this type can be used to grant a character to a user. */
173
+ CanBecomeCharacter: boolean;
174
+ /** catalog version for this item */
175
+ CatalogVersion?: string;
176
+ /** defines the consumable properties (number of uses, timeout) for the item */
177
+ Consumable?: CatalogItemConsumableInfo;
178
+ /**
179
+ * defines the container properties for the item - what items it contains, including random drop tables and virtual
180
+ * currencies, and what item (if any) is required to open it via the UnlockContainerItem API
181
+ */
182
+ Container?: CatalogItemContainerInfo;
183
+ /** game specific custom data */
184
+ CustomData?: string;
185
+ /** text description of item, to show in-game */
186
+ Description?: string;
187
+ /** text name for the item, to show in-game */
188
+ DisplayName?: string;
189
+ /**
190
+ * If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited
191
+ * edition item, this value determines the total number of instances to allocate for the title. Once this limit has been
192
+ * reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of
193
+ * false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less
194
+ * than zero, it will be ignored.
195
+ */
196
+ InitialLimitedEditionCount: number;
197
+ /** BETA: If true, then only a fixed number can ever be granted. */
198
+ IsLimitedEdition: boolean;
199
+ /**
200
+ * if true, then only one item instance of this type will exist and its remaininguses will be incremented instead.
201
+ * RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded
202
+ */
203
+ IsStackable: boolean;
204
+ /** if true, then an item instance of this type can be traded between players using the trading APIs */
205
+ IsTradable: boolean;
206
+ /** class to which the item belongs */
207
+ ItemClass?: string;
208
+ /** unique identifier for this item */
209
+ ItemId: string;
210
+ /**
211
+ * URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP
212
+ * URL.
213
+ */
214
+ ItemImageUrl?: string;
215
+ /** override prices for this item for specific currencies */
216
+ RealCurrencyPrices?: Record<string, number>;
217
+ /** list of item tags */
218
+ Tags?: string[];
219
+ /** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
220
+ VirtualCurrencyPrices?: Record<string, number>;
221
+ }
222
+ interface CatalogItemBundleInfo {
223
+ /** unique ItemId values for all items which will be added to the player inventory when the bundle is added */
224
+ BundledItems?: string[];
225
+ /**
226
+ * unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and
227
+ * add the relevant items to the player inventory when the bundle is added)
228
+ */
229
+ BundledResultTables?: string[];
230
+ /** virtual currency types and balances which will be added to the player inventory when the bundle is added */
231
+ BundledVirtualCurrencies?: Record<string, number>;
232
+ }
233
+ interface CatalogItemConsumableInfo {
234
+ /** number of times this object can be used, after which it will be removed from the player inventory */
235
+ UsageCount?: number;
236
+ /**
237
+ * duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
238
+ * (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
239
+ * this item's details have completed)
240
+ */
241
+ UsagePeriod?: number;
242
+ /**
243
+ * all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values
244
+ * added together, and share the result - when that period has elapsed, all the items in the group will be removed
245
+ */
246
+ UsagePeriodGroup?: string;
247
+ }
248
+ interface CatalogItemContainerInfo {
249
+ /** unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked */
250
+ ItemContents?: string[];
251
+ /**
252
+ * ItemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will
253
+ * open the container, adding the contents to the player inventory and currency balances)
254
+ */
255
+ KeyItemId?: string;
256
+ /**
257
+ * unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables
258
+ * will be resolved and add the relevant items to the player inventory)
259
+ */
260
+ ResultTableContents?: string[];
261
+ /** virtual currency types and balances which will be added to the player inventory when the container is unlocked */
262
+ VirtualCurrencyContents?: Record<string, number>;
263
+ }
264
+ interface CharacterInventory {
265
+ /** The id of this character. */
266
+ CharacterId?: string;
267
+ /** The inventory of this character. */
268
+ Inventory?: ItemInstance[];
269
+ }
270
+ interface CharacterLeaderboardEntry {
271
+ /** PlayFab unique identifier of the character that belongs to the user for this leaderboard entry. */
272
+ CharacterId?: string;
273
+ /** Title-specific display name of the character for this leaderboard entry. */
274
+ CharacterName?: string;
275
+ /** Name of the character class for this entry. */
276
+ CharacterType?: string;
277
+ /** Title-specific display name of the user for this leaderboard entry. */
278
+ DisplayName?: string;
279
+ /** PlayFab unique identifier of the user for this leaderboard entry. */
280
+ PlayFabId?: string;
281
+ /** User's overall position in the leaderboard. */
282
+ Position: number;
283
+ /** Specific value of the user's statistic. */
284
+ StatValue: number;
285
+ }
286
+ interface CharacterResult {
287
+ /** The id for this character on this player. */
288
+ CharacterId?: string;
289
+ /** The name of this character. */
290
+ CharacterName?: string;
291
+ /** The type-string that was given to this character on creation. */
292
+ CharacterType?: string;
293
+ }
294
+ interface ConsumeItemRequest extends IPlayFabRequestCommon {
295
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
296
+ CharacterId?: string;
297
+ /** Number of uses to consume from the item. */
298
+ ConsumeCount: number;
299
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
300
+ CustomTags?: Record<string, string | null>;
301
+ /** Unique instance identifier of the item to be consumed. */
302
+ ItemInstanceId: string;
303
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
304
+ PlayFabId: string;
305
+ }
306
+ interface ConsumeItemResult extends IPlayFabResultCommon {
307
+ /** Unique instance identifier of the item with uses consumed. */
308
+ ItemInstanceId?: string;
309
+ /** Number of uses remaining on the item. */
310
+ RemainingUses: number;
311
+ }
312
+ interface ContactEmailInfo {
313
+ /** The email address */
314
+ EmailAddress?: string;
315
+ /** The name of the email info data */
316
+ Name?: string;
317
+ /** The verification status of the email */
318
+ VerificationStatus?: string;
319
+ }
320
+ interface ContactEmailInfoModel {
321
+ /** The email address */
322
+ EmailAddress?: string;
323
+ /** The name of the email info data */
324
+ Name?: string;
325
+ /** The verification status of the email */
326
+ VerificationStatus?: string;
327
+ }
328
+ interface CreateSharedGroupRequest extends IPlayFabRequestCommon {
329
+ /** Unique identifier for the shared group (a random identifier will be assigned, if one is not specified). */
330
+ SharedGroupId?: string;
331
+ }
332
+ interface CreateSharedGroupResult extends IPlayFabResultCommon {
333
+ /** Unique identifier for the shared group. */
334
+ SharedGroupId?: string;
335
+ }
336
+ interface CustomPropertyDetails {
337
+ /** The custom property's name. */
338
+ Name?: string;
339
+ /** The custom property's value. */
340
+ Value?: any;
341
+ }
342
+ interface DeleteCharacterFromUserRequest extends IPlayFabRequestCommon {
343
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
344
+ CharacterId: string;
345
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
346
+ CustomTags?: Record<string, string | null>;
347
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
348
+ PlayFabId: string;
349
+ /**
350
+ * If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those
351
+ * items.
352
+ */
353
+ SaveCharacterInventory: boolean;
354
+ }
355
+ interface DeleteCharacterFromUserResult extends IPlayFabResultCommon {
356
+ }
357
+ interface DeletedPropertyDetails {
358
+ /** The name of the property which was requested to be deleted. */
359
+ Name?: string;
360
+ /** Indicates whether or not the property was deleted. If false, no property with that name existed. */
361
+ WasDeleted: boolean;
362
+ }
363
+ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
364
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
365
+ CustomTags?: Record<string, string | null>;
366
+ /**
367
+ * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the
368
+ * player's properties have not been updated by any other clients since the last version.
369
+ */
370
+ ExpectedPropertiesVersion?: number;
371
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
372
+ PlayFabId: string;
373
+ /** A list of property names denoting which properties should be deleted. */
374
+ PropertyNames: string[];
375
+ }
376
+ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
377
+ /** The list of properties requested to be deleted. */
378
+ DeletedProperties?: DeletedPropertyDetails[];
379
+ /** PlayFab unique identifier of the user whose properties were deleted. */
380
+ PlayFabId?: string;
381
+ /**
382
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
383
+ * deletes. This version can be provided in update and delete calls for concurrency control.
384
+ */
385
+ PropertiesVersion: number;
386
+ }
387
+ interface DeletePlayerRequest extends IPlayFabRequestCommon {
388
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
389
+ PlayFabId: string;
390
+ }
391
+ interface DeletePlayerResult extends IPlayFabResultCommon {
392
+ }
393
+ interface DeletePushNotificationTemplateRequest extends IPlayFabRequestCommon {
394
+ /** Id of the push notification template to be deleted. */
395
+ PushNotificationTemplateId: string;
396
+ }
397
+ interface DeletePushNotificationTemplateResult extends IPlayFabResultCommon {
398
+ }
399
+ interface DeleteSharedGroupRequest extends IPlayFabRequestCommon {
400
+ /** Unique identifier for the shared group. */
401
+ SharedGroupId: string;
402
+ }
403
+ interface EmptyResult extends IPlayFabResultCommon {
404
+ }
405
+ interface EntityKey {
406
+ /** Unique ID of the entity. */
407
+ Id: string;
408
+ /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
409
+ Type?: string;
410
+ }
411
+ interface EntityTokenResponse {
412
+ /** The entity id and type. */
413
+ Entity?: EntityKey;
414
+ /** The token used to set X-EntityToken for all entity based API calls. */
415
+ EntityToken?: string;
416
+ /** The time the token will expire, if it is an expiring token, in UTC. */
417
+ TokenExpiration?: string;
418
+ }
419
+ interface EvaluateRandomResultTableRequest extends IPlayFabRequestCommon {
420
+ /**
421
+ * Specifies the catalog version that should be used to evaluate the Random Result Table. If unspecified, uses
422
+ * default/primary catalog.
423
+ */
424
+ CatalogVersion?: string;
425
+ /** The unique identifier of the Random Result Table to use. */
426
+ TableId: string;
427
+ }
428
+ interface EvaluateRandomResultTableResult extends IPlayFabResultCommon {
429
+ /** Unique identifier for the item returned from the Random Result Table evaluation, for the given catalog. */
430
+ ResultItemId?: string;
431
+ }
432
+ interface ExecuteCloudScriptResult extends IPlayFabResultCommon {
433
+ /** Number of PlayFab API requests issued by the CloudScript function */
434
+ APIRequestsIssued: number;
435
+ /** Information about the error, if any, that occurred during execution */
436
+ Error?: ScriptExecutionError;
437
+ ExecutionTimeSeconds: number;
438
+ /** The name of the function that executed */
439
+ FunctionName?: string;
440
+ /** The object returned from the CloudScript function, if any */
441
+ FunctionResult?: any;
442
+ /**
443
+ * Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if
444
+ * the total event size is larger than 350KB.
445
+ */
446
+ FunctionResultTooLarge?: boolean;
447
+ /** Number of external HTTP requests issued by the CloudScript function */
448
+ HttpRequestsIssued: number;
449
+ /**
450
+ * Entries logged during the function execution. These include both entries logged in the function code using log.info()
451
+ * and log.error() and error entries for API and HTTP request failures.
452
+ */
453
+ Logs?: LogStatement[];
454
+ /**
455
+ * Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total
456
+ * event size is larger than 350KB after the FunctionResult was removed.
457
+ */
458
+ LogsTooLarge?: boolean;
459
+ MemoryConsumedBytes: number;
460
+ /**
461
+ * Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP
462
+ * requests.
463
+ */
464
+ ProcessorTimeSeconds: number;
465
+ /** The revision of the CloudScript that executed */
466
+ Revision: number;
467
+ }
468
+ interface ExecuteCloudScriptServerRequest extends IPlayFabRequestCommon {
469
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
470
+ CustomTags?: Record<string, string | null>;
471
+ /** The name of the CloudScript function to execute */
472
+ FunctionName: string;
473
+ /** Object that is passed in to the function as the first argument */
474
+ FunctionParameter?: any;
475
+ /**
476
+ * Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other
477
+ * contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
478
+ */
479
+ GeneratePlayStreamEvent?: boolean;
480
+ /** The unique user identifier for the player on whose behalf the script is being run */
481
+ PlayFabId: string;
482
+ /**
483
+ * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
484
+ * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
485
+ * 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.
486
+ */
487
+ RevisionSelection?: string;
488
+ /** The specivic revision to execute, when RevisionSelection is set to 'Specific' */
489
+ SpecificRevision?: number;
490
+ }
491
+ interface FacebookInstantGamesPlayFabIdPair {
492
+ /** Unique Facebook Instant Games identifier for a user. */
493
+ FacebookInstantGamesId?: string;
494
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook Instant Games identifier. */
495
+ PlayFabId?: string;
496
+ }
497
+ interface FacebookPlayFabIdPair {
498
+ /** Unique Facebook identifier for a user. */
499
+ FacebookId?: string;
500
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook identifier. */
501
+ PlayFabId?: string;
502
+ }
503
+ interface FriendInfo {
504
+ /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */
505
+ FacebookInfo?: UserFacebookInfo;
506
+ /** PlayFab unique identifier for this friend. */
507
+ FriendPlayFabId?: string;
508
+ /**
509
+ * Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same
510
+ * title).
511
+ */
512
+ GameCenterInfo?: UserGameCenterInfo;
513
+ /** The profile of the user, if requested. */
514
+ Profile?: PlayerProfileModel;
515
+ /**
516
+ * Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab
517
+ * Accounts in the same title.
518
+ */
519
+ PSNInfo?: UserPsnInfo;
520
+ /** Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). */
521
+ SteamInfo?: UserSteamInfo;
522
+ /** Tags which have been associated with this friend. */
523
+ Tags?: string[];
524
+ /** Title-specific display name for this friend. */
525
+ TitleDisplayName?: string;
526
+ /** PlayFab unique username for this friend. */
527
+ Username?: string;
528
+ /** Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). */
529
+ XboxInfo?: UserXboxInfo;
530
+ }
531
+ interface GenericPlayFabIdPair {
532
+ /** Unique generic service identifier for a user. */
533
+ GenericId?: GenericServiceId;
534
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the given generic identifier. */
535
+ PlayFabId?: string;
536
+ }
537
+ interface GenericServiceId {
538
+ /** Name of the service for which the player has a unique identifier. */
539
+ ServiceName: string;
540
+ /** Unique identifier of the player in that service. */
541
+ UserId: string;
542
+ }
543
+ interface GetAllSegmentsRequest extends IPlayFabRequestCommon {
544
+ }
545
+ interface GetAllSegmentsResult extends IPlayFabResultCommon {
546
+ /** Array of segments for this title. */
547
+ Segments?: GetSegmentResult[];
548
+ }
549
+ interface GetCatalogItemsRequest extends IPlayFabRequestCommon {
550
+ /** Which catalog is being requested. If null, uses the default catalog. */
551
+ CatalogVersion?: string;
552
+ }
553
+ interface GetCatalogItemsResult extends IPlayFabResultCommon {
554
+ /** Array of items which can be purchased. */
555
+ Catalog?: CatalogItem[];
556
+ }
557
+ interface GetCharacterDataRequest extends IPlayFabRequestCommon {
558
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
559
+ CharacterId: string;
560
+ /**
561
+ * The version that currently exists according to the caller. The call will return the data for all of the keys if the
562
+ * version in the system is greater than this.
563
+ */
564
+ IfChangedFromDataVersion?: number;
565
+ /** Specific keys to search for in the custom user data. */
566
+ Keys?: string[];
567
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
568
+ PlayFabId: string;
569
+ }
570
+ interface GetCharacterDataResult extends IPlayFabResultCommon {
571
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
572
+ CharacterId?: string;
573
+ /** User specific data for this title. */
574
+ Data?: Record<string, UserDataRecord>;
575
+ /**
576
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
577
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
578
+ */
579
+ DataVersion: number;
580
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
581
+ PlayFabId?: string;
582
+ }
583
+ interface GetCharacterInventoryRequest extends IPlayFabRequestCommon {
584
+ /** Used to limit results to only those from a specific catalog version. */
585
+ CatalogVersion?: string;
586
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
587
+ CharacterId: string;
588
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
589
+ CustomTags?: Record<string, string | null>;
590
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
591
+ PlayFabId: string;
592
+ }
593
+ interface GetCharacterInventoryResult extends IPlayFabResultCommon {
594
+ /** Unique identifier of the character for this inventory. */
595
+ CharacterId?: string;
596
+ /** Array of inventory items belonging to the character. */
597
+ Inventory?: ItemInstance[];
598
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
599
+ PlayFabId?: string;
600
+ /** Array of virtual currency balance(s) belonging to the character. */
601
+ VirtualCurrency?: Record<string, number>;
602
+ /** Array of remaining times and timestamps for virtual currencies. */
603
+ VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
604
+ }
605
+ interface GetCharacterLeaderboardRequest extends IPlayFabRequestCommon {
606
+ /** Maximum number of entries to retrieve. */
607
+ MaxResultsCount: number;
608
+ /** First entry in the leaderboard to be retrieved. */
609
+ StartPosition: number;
610
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
611
+ StatisticName: string;
612
+ }
613
+ interface GetCharacterLeaderboardResult extends IPlayFabResultCommon {
614
+ /** Ordered list of leaderboard entries. */
615
+ Leaderboard?: CharacterLeaderboardEntry[];
616
+ }
617
+ interface GetCharacterStatisticsRequest extends IPlayFabRequestCommon {
618
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
619
+ CharacterId: string;
620
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
621
+ PlayFabId: string;
622
+ }
623
+ interface GetCharacterStatisticsResult extends IPlayFabResultCommon {
624
+ /** Unique identifier of the character for the statistics. */
625
+ CharacterId?: string;
626
+ /** Character statistics for the requested user. */
627
+ CharacterStatistics?: Record<string, number>;
628
+ /** PlayFab unique identifier of the user whose character statistics are being returned. */
629
+ PlayFabId?: string;
630
+ }
631
+ interface GetContentDownloadUrlRequest extends IPlayFabRequestCommon {
632
+ /** HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET. */
633
+ HttpMethod?: string;
634
+ /** Key of the content item to fetch, usually formatted as a path, e.g. images/a.png */
635
+ Key: string;
636
+ /**
637
+ * True to download through CDN. CDN provides higher download bandwidth and lower latency. However, if you want the latest,
638
+ * non-cached version of the content during development, set this to false. Default is true.
639
+ */
640
+ ThruCDN?: boolean;
641
+ }
642
+ interface GetContentDownloadUrlResult extends IPlayFabResultCommon {
643
+ /** URL for downloading content via HTTP GET or HEAD method. The URL will expire in approximately one hour. */
644
+ URL?: string;
645
+ }
646
+ interface GetFriendLeaderboardRequest extends IPlayFabRequestCommon {
647
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
648
+ CustomTags?: Record<string, string | null>;
649
+ /**
650
+ * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
651
+ * comma-separated list of platforms.
652
+ */
653
+ ExternalPlatformFriends?: string;
654
+ /** Maximum number of entries to retrieve. */
655
+ MaxResultsCount: number;
656
+ /** The player whose friend leaderboard to get */
657
+ PlayFabId: string;
658
+ /**
659
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
660
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
661
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
662
+ */
663
+ ProfileConstraints?: PlayerProfileViewConstraints;
664
+ /** Position in the leaderboard to start this listing (defaults to the first entry). */
665
+ StartPosition: number;
666
+ /** Statistic used to rank friends for this leaderboard. */
667
+ StatisticName: string;
668
+ /** The version of the leaderboard to get. */
669
+ Version?: number;
670
+ /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
671
+ XboxToken?: string;
672
+ }
673
+ interface GetFriendsListRequest extends IPlayFabRequestCommon {
674
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
675
+ CustomTags?: Record<string, string | null>;
676
+ /**
677
+ * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
678
+ * comma-separated list of platforms.
679
+ */
680
+ ExternalPlatformFriends?: string;
681
+ /** PlayFab identifier of the player whose friend list to get. */
682
+ PlayFabId: string;
683
+ /**
684
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
685
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
686
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
687
+ */
688
+ ProfileConstraints?: PlayerProfileViewConstraints;
689
+ /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
690
+ XboxToken?: string;
691
+ }
692
+ interface GetFriendsListResult extends IPlayFabResultCommon {
693
+ /** Array of friends found. */
694
+ Friends?: FriendInfo[];
695
+ }
696
+ interface GetLeaderboardAroundCharacterRequest extends IPlayFabRequestCommon {
697
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
698
+ CharacterId: string;
699
+ /** Maximum number of entries to retrieve. */
700
+ MaxResultsCount: number;
701
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
702
+ PlayFabId: string;
703
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
704
+ StatisticName: string;
705
+ }
706
+ interface GetLeaderboardAroundCharacterResult extends IPlayFabResultCommon {
707
+ /** Ordered list of leaderboard entries. */
708
+ Leaderboard?: CharacterLeaderboardEntry[];
709
+ }
710
+ interface GetLeaderboardAroundUserRequest extends IPlayFabRequestCommon {
711
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
712
+ CustomTags?: Record<string, string | null>;
713
+ /** Maximum number of entries to retrieve. */
714
+ MaxResultsCount: number;
715
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
716
+ PlayFabId: string;
717
+ /**
718
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
719
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
720
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
721
+ */
722
+ ProfileConstraints?: PlayerProfileViewConstraints;
723
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
724
+ StatisticName: string;
725
+ /** The version of the leaderboard to get. */
726
+ Version?: number;
727
+ }
728
+ interface GetLeaderboardAroundUserResult extends IPlayFabResultCommon {
729
+ /** Ordered listing of users and their positions in the requested leaderboard. */
730
+ Leaderboard?: PlayerLeaderboardEntry[];
731
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
732
+ NextReset?: string;
733
+ /** The version of the leaderboard returned. */
734
+ Version: number;
735
+ }
736
+ interface GetLeaderboardForUsersCharactersRequest extends IPlayFabRequestCommon {
737
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
738
+ PlayFabId: string;
739
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
740
+ StatisticName: string;
741
+ }
742
+ interface GetLeaderboardForUsersCharactersResult extends IPlayFabResultCommon {
743
+ /** Ordered list of leaderboard entries. */
744
+ Leaderboard?: CharacterLeaderboardEntry[];
745
+ }
746
+ interface GetLeaderboardRequest extends IPlayFabRequestCommon {
747
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
748
+ CustomTags?: Record<string, string | null>;
749
+ /** Maximum number of entries to retrieve. */
750
+ MaxResultsCount: number;
751
+ /**
752
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
753
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
754
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
755
+ */
756
+ ProfileConstraints?: PlayerProfileViewConstraints;
757
+ /** First entry in the leaderboard to be retrieved. */
758
+ StartPosition: number;
759
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
760
+ StatisticName: string;
761
+ /** The version of the leaderboard to get. */
762
+ Version?: number;
763
+ }
764
+ interface GetLeaderboardResult extends IPlayFabResultCommon {
765
+ /** Ordered listing of users and their positions in the requested leaderboard. */
766
+ Leaderboard?: PlayerLeaderboardEntry[];
767
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
768
+ NextReset?: string;
769
+ /** The version of the leaderboard returned. */
770
+ Version: number;
771
+ }
772
+ interface GetPlayerCombinedInfoRequest extends IPlayFabRequestCommon {
773
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
774
+ CustomTags?: Record<string, string | null>;
775
+ /** Flags for which pieces of info to return for the user. */
776
+ InfoRequestParameters: GetPlayerCombinedInfoRequestParams;
777
+ /** PlayFabId of the user whose data will be returned */
778
+ PlayFabId: string;
779
+ }
780
+ interface GetPlayerCombinedInfoRequestParams {
781
+ /** Whether to get character inventories. Defaults to false. */
782
+ GetCharacterInventories: boolean;
783
+ /** Whether to get the list of characters. Defaults to false. */
784
+ GetCharacterList: boolean;
785
+ /** Whether to get player profile. Defaults to false. Has no effect for a new player. */
786
+ GetPlayerProfile: boolean;
787
+ /** Whether to get player statistics. Defaults to false. */
788
+ GetPlayerStatistics: boolean;
789
+ /** Whether to get title data. Defaults to false. */
790
+ GetTitleData: boolean;
791
+ /** Whether to get the player's account Info. Defaults to false */
792
+ GetUserAccountInfo: boolean;
793
+ /** Whether to get the player's custom data. Defaults to false */
794
+ GetUserData: boolean;
795
+ /** Whether to get the player's inventory. Defaults to false */
796
+ GetUserInventory: boolean;
797
+ /** Whether to get the player's read only data. Defaults to false */
798
+ GetUserReadOnlyData: boolean;
799
+ /** Whether to get the player's virtual currency balances. Defaults to false */
800
+ GetUserVirtualCurrency: boolean;
801
+ /** Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false */
802
+ PlayerStatisticNames?: string[];
803
+ /** Specifies the properties to return from the player profile. Defaults to returning the player's display name. */
804
+ ProfileConstraints?: PlayerProfileViewConstraints;
805
+ /** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false */
806
+ TitleDataKeys?: string[];
807
+ /** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false */
808
+ UserDataKeys?: string[];
809
+ /**
810
+ * Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is
811
+ * false
812
+ */
813
+ UserReadOnlyDataKeys?: string[];
814
+ }
815
+ interface GetPlayerCombinedInfoResult extends IPlayFabResultCommon {
816
+ /** Results for requested info. */
817
+ InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
818
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
819
+ PlayFabId?: string;
820
+ }
821
+ interface GetPlayerCombinedInfoResultPayload {
822
+ /** Account information for the user. This is always retrieved. */
823
+ AccountInfo?: UserAccountInfo;
824
+ /** Inventories for each character for the user. */
825
+ CharacterInventories?: CharacterInventory[];
826
+ /** List of characters for the user. */
827
+ CharacterList?: CharacterResult[];
828
+ /**
829
+ * The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
830
+ * exist.
831
+ */
832
+ PlayerProfile?: PlayerProfileModel;
833
+ /** List of statistics for this player. */
834
+ PlayerStatistics?: StatisticValue[];
835
+ /** Title data for this title. */
836
+ TitleData?: Record<string, string | null>;
837
+ /** User specific custom data. */
838
+ UserData?: Record<string, UserDataRecord>;
839
+ /** The version of the UserData that was returned. */
840
+ UserDataVersion: number;
841
+ /** Array of inventory items in the user's current inventory. */
842
+ UserInventory?: ItemInstance[];
843
+ /** User specific read-only data. */
844
+ UserReadOnlyData?: Record<string, UserDataRecord>;
845
+ /** The version of the Read-Only UserData that was returned. */
846
+ UserReadOnlyDataVersion: number;
847
+ /** Dictionary of virtual currency balance(s) belonging to the user. */
848
+ UserVirtualCurrency?: Record<string, number>;
849
+ /** Dictionary of remaining times and timestamps for virtual currencies. */
850
+ UserVirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
851
+ }
852
+ interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
853
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
854
+ PlayFabId: string;
855
+ /** Specific property name to search for in the player's properties. */
856
+ PropertyName: string;
857
+ }
858
+ interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
859
+ /** PlayFab unique identifier of the user whose properties are being returned. */
860
+ PlayFabId?: string;
861
+ /**
862
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
863
+ * deletes. This version can be provided in update and delete calls for concurrency control.
864
+ */
865
+ PropertiesVersion: number;
866
+ /** Player specific property and its corresponding value. */
867
+ Property?: CustomPropertyDetails;
868
+ }
869
+ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
870
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
871
+ CustomTags?: Record<string, string | null>;
872
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
873
+ PlayFabId: string;
874
+ /**
875
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
876
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
877
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
878
+ */
879
+ ProfileConstraints?: PlayerProfileViewConstraints;
880
+ }
881
+ interface GetPlayerProfileResult extends IPlayFabResultCommon {
882
+ /**
883
+ * The profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
884
+ * exist.
885
+ */
886
+ PlayerProfile?: PlayerProfileModel;
887
+ }
888
+ interface GetPlayerSegmentsResult extends IPlayFabResultCommon {
889
+ /** Array of segments the requested player currently belongs to. */
890
+ Segments?: GetSegmentResult[];
891
+ }
892
+ interface GetPlayersInSegmentRequest extends IPlayFabRequestCommon {
893
+ /** Continuation token if retrieving subsequent pages of results. */
894
+ ContinuationToken?: string;
895
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
896
+ CustomTags?: Record<string, string | null>;
897
+ /**
898
+ * If set to true, the profiles are loaded asynchronously and the response will include a continuation token and
899
+ * approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network
900
+ * timeouts.
901
+ */
902
+ GetProfilesAsync?: boolean;
903
+ /**
904
+ * Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this
905
+ * segment.
906
+ */
907
+ MaxBatchSize?: number;
908
+ /**
909
+ * Number of seconds to keep the continuation token active. After token expiration it is not possible to continue paging
910
+ * results. Default is 300 (5 minutes). Maximum is 5,400 (90 minutes).
911
+ */
912
+ SecondsToLive?: number;
913
+ /** Unique identifier for this segment. */
914
+ SegmentId: string;
915
+ }
916
+ interface GetPlayersInSegmentResult extends IPlayFabResultCommon {
917
+ /** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */
918
+ ContinuationToken?: string;
919
+ /** Array of player profiles in this segment. */
920
+ PlayerProfiles?: PlayerProfile[];
921
+ /** Count of profiles matching this segment. */
922
+ ProfilesInSegment: number;
923
+ }
924
+ interface GetPlayersSegmentsRequest extends IPlayFabRequestCommon {
925
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
926
+ CustomTags?: Record<string, string | null>;
927
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
928
+ PlayFabId: string;
929
+ }
930
+ interface GetPlayerStatisticsRequest extends IPlayFabRequestCommon {
931
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
932
+ CustomTags?: Record<string, string | null>;
933
+ /** user for whom statistics are being requested */
934
+ PlayFabId: string;
935
+ /** statistics to return */
936
+ StatisticNames?: string[];
937
+ /**
938
+ * statistics to return, if StatisticNames is not set (only statistics which have a version matching that provided will be
939
+ * returned)
940
+ */
941
+ StatisticNameVersions?: StatisticNameVersion[];
942
+ }
943
+ interface GetPlayerStatisticsResult extends IPlayFabResultCommon {
944
+ /** PlayFab unique identifier of the user whose statistics are being returned */
945
+ PlayFabId?: string;
946
+ /** User statistics for the requested user. */
947
+ Statistics?: StatisticValue[];
948
+ }
949
+ interface GetPlayerStatisticVersionsRequest extends IPlayFabRequestCommon {
950
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
951
+ CustomTags?: Record<string, string | null>;
952
+ /** unique name of the statistic */
953
+ StatisticName?: string;
954
+ }
955
+ interface GetPlayerStatisticVersionsResult extends IPlayFabResultCommon {
956
+ /** version change history of the statistic */
957
+ StatisticVersions?: PlayerStatisticVersion[];
958
+ }
959
+ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
960
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
961
+ CustomTags?: Record<string, string | null>;
962
+ /** Optional namespace to filter results by */
963
+ Namespace?: string;
964
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
965
+ PlayFabId: string;
966
+ }
967
+ interface GetPlayerTagsResult extends IPlayFabResultCommon {
968
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
969
+ PlayFabId: string;
970
+ /** Canonical tags (including namespace and tag's name) for the requested user */
971
+ Tags: string[];
972
+ }
973
+ interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends IPlayFabRequestCommon {
974
+ /**
975
+ * Array of unique Battle.net account identifiers for which the title needs to get PlayFab identifiers. The array cannot
976
+ * exceed 10 in length.
977
+ */
978
+ BattleNetAccountIds: string[];
979
+ }
980
+ interface GetPlayFabIDsFromBattleNetAccountIdsResult extends IPlayFabResultCommon {
981
+ /** Mapping of Battle.net account identifiers to PlayFab identifiers. */
982
+ Data?: BattleNetAccountPlayFabIdPair[];
983
+ }
984
+ interface GetPlayFabIDsFromFacebookIDsRequest extends IPlayFabRequestCommon {
985
+ /**
986
+ * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000
987
+ * in length.
988
+ */
989
+ FacebookIDs: string[];
990
+ }
991
+ interface GetPlayFabIDsFromFacebookIDsResult extends IPlayFabResultCommon {
992
+ /** Mapping of Facebook identifiers to PlayFab identifiers. */
993
+ Data?: FacebookPlayFabIdPair[];
994
+ }
995
+ interface GetPlayFabIDsFromFacebookInstantGamesIdsRequest extends IPlayFabRequestCommon {
996
+ /**
997
+ * Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array
998
+ * cannot exceed 25 in length.
999
+ */
1000
+ FacebookInstantGamesIds: string[];
1001
+ }
1002
+ interface GetPlayFabIDsFromFacebookInstantGamesIdsResult extends IPlayFabResultCommon {
1003
+ /** Mapping of Facebook Instant Games identifiers to PlayFab identifiers. */
1004
+ Data?: FacebookInstantGamesPlayFabIdPair[];
1005
+ }
1006
+ interface GetPlayFabIDsFromGenericIDsRequest extends IPlayFabRequestCommon {
1007
+ /**
1008
+ * Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a
1009
+ * maximum of 10 in a single request.
1010
+ */
1011
+ GenericIDs: GenericServiceId[];
1012
+ }
1013
+ interface GetPlayFabIDsFromGenericIDsResult extends IPlayFabResultCommon {
1014
+ /** Mapping of generic service identifiers to PlayFab identifiers. */
1015
+ Data?: GenericPlayFabIdPair[];
1016
+ }
1017
+ interface GetPlayFabIDsFromNintendoServiceAccountIdsRequest extends IPlayFabRequestCommon {
1018
+ /**
1019
+ * Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array
1020
+ * cannot exceed 2,000 in length.
1021
+ */
1022
+ NintendoAccountIds: string[];
1023
+ }
1024
+ interface GetPlayFabIDsFromNintendoServiceAccountIdsResult extends IPlayFabResultCommon {
1025
+ /** Mapping of Nintendo Switch Service Account identifiers to PlayFab identifiers. */
1026
+ Data?: NintendoServiceAccountPlayFabIdPair[];
1027
+ }
1028
+ interface GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest extends IPlayFabRequestCommon {
1029
+ /**
1030
+ * Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array
1031
+ * cannot exceed 2,000 in length.
1032
+ */
1033
+ NintendoSwitchDeviceIds: string[];
1034
+ }
1035
+ interface GetPlayFabIDsFromNintendoSwitchDeviceIdsResult extends IPlayFabResultCommon {
1036
+ /** Mapping of Nintendo Switch Device identifiers to PlayFab identifiers. */
1037
+ Data?: NintendoSwitchPlayFabIdPair[];
1038
+ }
1039
+ interface GetPlayFabIDsFromPSNAccountIDsRequest extends IPlayFabRequestCommon {
1040
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1041
+ IssuerId?: number;
1042
+ /**
1043
+ * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array
1044
+ * cannot exceed 2,000 in length.
1045
+ */
1046
+ PSNAccountIDs: string[];
1047
+ }
1048
+ interface GetPlayFabIDsFromPSNAccountIDsResult extends IPlayFabResultCommon {
1049
+ /** Mapping of PlayStation :tm: Network identifiers to PlayFab identifiers. */
1050
+ Data?: PSNAccountPlayFabIdPair[];
1051
+ }
1052
+ interface GetPlayFabIDsFromPSNOnlineIDsRequest extends IPlayFabRequestCommon {
1053
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1054
+ IssuerId?: number;
1055
+ /**
1056
+ * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array
1057
+ * cannot exceed 2,000 in length.
1058
+ */
1059
+ PSNOnlineIDs: string[];
1060
+ }
1061
+ interface GetPlayFabIDsFromPSNOnlineIDsResult extends IPlayFabResultCommon {
1062
+ /** Mapping of PlayStation :tm: Network identifiers to PlayFab identifiers. */
1063
+ Data?: PSNOnlinePlayFabIdPair[];
1064
+ }
1065
+ interface GetPlayFabIDsFromSteamIDsRequest extends IPlayFabRequestCommon {
1066
+ /**
1067
+ * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array
1068
+ * cannot exceed 2,000 in length.
1069
+ */
1070
+ SteamStringIDs?: string[];
1071
+ }
1072
+ interface GetPlayFabIDsFromSteamIDsResult extends IPlayFabResultCommon {
1073
+ /** Mapping of Steam identifiers to PlayFab identifiers. */
1074
+ Data?: SteamPlayFabIdPair[];
1075
+ }
1076
+ interface GetPlayFabIDsFromSteamNamesRequest extends IPlayFabRequestCommon {
1077
+ /**
1078
+ * Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in
1079
+ * length.
1080
+ */
1081
+ SteamNames: string[];
1082
+ }
1083
+ interface GetPlayFabIDsFromSteamNamesResult extends IPlayFabResultCommon {
1084
+ /** Mapping of Steam identifiers to PlayFab identifiers. */
1085
+ Data?: SteamNamePlayFabIdPair[];
1086
+ }
1087
+ interface GetPlayFabIDsFromTwitchIDsRequest extends IPlayFabRequestCommon {
1088
+ /**
1089
+ * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot
1090
+ * exceed 2,000 in length.
1091
+ */
1092
+ TwitchIds: string[];
1093
+ }
1094
+ interface GetPlayFabIDsFromTwitchIDsResult extends IPlayFabResultCommon {
1095
+ /** Mapping of Twitch identifiers to PlayFab identifiers. */
1096
+ Data?: TwitchPlayFabIdPair[];
1097
+ }
1098
+ interface GetPlayFabIDsFromXboxLiveIDsRequest extends IPlayFabRequestCommon {
1099
+ /** The ID of Xbox Live sandbox. */
1100
+ Sandbox?: string;
1101
+ /**
1102
+ * Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot
1103
+ * exceed 2,000 in length.
1104
+ */
1105
+ XboxLiveAccountIDs: string[];
1106
+ }
1107
+ interface GetPlayFabIDsFromXboxLiveIDsResult extends IPlayFabResultCommon {
1108
+ /** Mapping of Xbox Live identifiers to PlayFab identifiers. */
1109
+ Data?: XboxLiveAccountPlayFabIdPair[];
1110
+ }
1111
+ interface GetPublisherDataRequest extends IPlayFabRequestCommon {
1112
+ /** array of keys to get back data from the Publisher data blob, set by the admin tools */
1113
+ Keys: string[];
1114
+ }
1115
+ interface GetPublisherDataResult extends IPlayFabResultCommon {
1116
+ /** a dictionary object of key / value pairs */
1117
+ Data?: Record<string, string | null>;
1118
+ }
1119
+ interface GetRandomResultTablesRequest extends IPlayFabRequestCommon {
1120
+ /**
1121
+ * Specifies the catalog version that should be used to retrieve the Random Result Tables. If unspecified, uses
1122
+ * default/primary catalog.
1123
+ */
1124
+ CatalogVersion?: string;
1125
+ /** The unique identifier of the Random Result Table to use. */
1126
+ TableIDs: string[];
1127
+ }
1128
+ interface GetRandomResultTablesResult extends IPlayFabResultCommon {
1129
+ /** array of random result tables currently available */
1130
+ Tables?: Record<string, RandomResultTableListing>;
1131
+ }
1132
+ interface GetSegmentResult {
1133
+ /** Identifier of the segments AB Test, if it is attached to one. */
1134
+ ABTestParent?: string;
1135
+ /** Unique identifier for this segment. */
1136
+ Id: string;
1137
+ /** Segment name. */
1138
+ Name?: string;
1139
+ }
1140
+ interface GetServerCustomIDsFromPlayFabIDsRequest extends IPlayFabRequestCommon {
1141
+ /**
1142
+ * Array of unique PlayFab player identifiers for which the title needs to get server custom identifiers. Cannot contain
1143
+ * more than 25 identifiers.
1144
+ */
1145
+ PlayFabIDs: string[];
1146
+ }
1147
+ interface GetServerCustomIDsFromPlayFabIDsResult extends IPlayFabResultCommon {
1148
+ /** Mapping of server custom player identifiers to PlayFab identifiers. */
1149
+ Data?: ServerCustomIDPlayFabIDPair[];
1150
+ }
1151
+ interface GetSharedGroupDataRequest extends IPlayFabRequestCommon {
1152
+ /** If true, return the list of all members of the shared group. */
1153
+ GetMembers?: boolean;
1154
+ /**
1155
+ * Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array
1156
+ * indicates that no keys should be returned).
1157
+ */
1158
+ Keys?: string[];
1159
+ /** Unique identifier for the shared group. */
1160
+ SharedGroupId: string;
1161
+ }
1162
+ interface GetSharedGroupDataResult extends IPlayFabResultCommon {
1163
+ /** Data for the requested keys. */
1164
+ Data?: Record<string, SharedGroupDataRecord>;
1165
+ /** List of PlayFabId identifiers for the members of this group, if requested. */
1166
+ Members?: string[];
1167
+ }
1168
+ interface GetStoreItemsResult extends IPlayFabResultCommon {
1169
+ /** The base catalog that this store is a part of. */
1170
+ CatalogVersion?: string;
1171
+ /** Additional data about the store. */
1172
+ MarketingData?: StoreMarketingModel;
1173
+ /** How the store was last updated (Admin or a third party). */
1174
+ Source?: string;
1175
+ /** Array of items which can be purchased from this store. */
1176
+ Store?: StoreItem[];
1177
+ /** The ID of this store. */
1178
+ StoreId?: string;
1179
+ }
1180
+ interface GetStoreItemsServerRequest extends IPlayFabRequestCommon {
1181
+ /** Catalog version to store items from. Use default catalog version if null */
1182
+ CatalogVersion?: string;
1183
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1184
+ CustomTags?: Record<string, string | null>;
1185
+ /**
1186
+ * Optional identifier for the player to use in requesting the store information - if used, segment overrides will be
1187
+ * applied
1188
+ */
1189
+ PlayFabId?: string;
1190
+ /** Unqiue identifier for the store which is being requested */
1191
+ StoreId: string;
1192
+ }
1193
+ interface GetTimeRequest extends IPlayFabRequestCommon {
1194
+ }
1195
+ interface GetTimeResult extends IPlayFabResultCommon {
1196
+ /** Current server time when the request was received, in UTC */
1197
+ Time: string;
1198
+ }
1199
+ interface GetTitleDataRequest extends IPlayFabRequestCommon {
1200
+ /** Specific keys to search for in the title data (leave null to get all keys) */
1201
+ Keys?: string[];
1202
+ /**
1203
+ * Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise,
1204
+ * the overrides are applied automatically to the title data.
1205
+ */
1206
+ OverrideLabel?: string;
1207
+ }
1208
+ interface GetTitleDataResult extends IPlayFabResultCommon {
1209
+ /** a dictionary object of key / value pairs */
1210
+ Data?: Record<string, string | null>;
1211
+ }
1212
+ interface GetTitleNewsRequest extends IPlayFabRequestCommon {
1213
+ /** Limits the results to the last n entries. Defaults to 10 if not set. */
1214
+ Count?: number;
1215
+ }
1216
+ interface GetTitleNewsResult extends IPlayFabResultCommon {
1217
+ /** Array of localized news items. */
1218
+ News?: TitleNewsItem[];
1219
+ }
1220
+ interface GetUserAccountInfoRequest extends IPlayFabRequestCommon {
1221
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1222
+ PlayFabId: string;
1223
+ }
1224
+ interface GetUserAccountInfoResult extends IPlayFabResultCommon {
1225
+ /** Account details for the user whose information was requested. */
1226
+ UserInfo?: UserAccountInfo;
1227
+ }
1228
+ interface GetUserBansRequest extends IPlayFabRequestCommon {
1229
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1230
+ PlayFabId: string;
1231
+ }
1232
+ interface GetUserBansResult extends IPlayFabResultCommon {
1233
+ /** Information about the bans */
1234
+ BanData?: BanInfo[];
1235
+ }
1236
+ interface GetUserDataRequest extends IPlayFabRequestCommon {
1237
+ /**
1238
+ * The version that currently exists according to the caller. The call will return the data for all of the keys if the
1239
+ * version in the system is greater than this.
1240
+ */
1241
+ IfChangedFromDataVersion?: number;
1242
+ /** Specific keys to search for in the custom user data. */
1243
+ Keys?: string[];
1244
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1245
+ PlayFabId: string;
1246
+ }
1247
+ interface GetUserDataResult extends IPlayFabResultCommon {
1248
+ /** User specific data for this title. */
1249
+ Data?: Record<string, UserDataRecord>;
1250
+ /**
1251
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
1252
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
1253
+ */
1254
+ DataVersion: number;
1255
+ /** PlayFab unique identifier of the user whose custom data is being returned. */
1256
+ PlayFabId?: string;
1257
+ }
1258
+ interface GetUserInventoryRequest extends IPlayFabRequestCommon {
1259
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1260
+ CustomTags?: Record<string, string | null>;
1261
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1262
+ PlayFabId: string;
1263
+ }
1264
+ interface GetUserInventoryResult extends IPlayFabResultCommon {
1265
+ /** Array of inventory items belonging to the user. */
1266
+ Inventory?: ItemInstance[];
1267
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1268
+ PlayFabId?: string;
1269
+ /** Array of virtual currency balance(s) belonging to the user. */
1270
+ VirtualCurrency?: Record<string, number>;
1271
+ /** Array of remaining times and timestamps for virtual currencies. */
1272
+ VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
1273
+ }
1274
+ interface GrantCharacterToUserRequest extends IPlayFabRequestCommon {
1275
+ /** Non-unique display name of the character being granted (1-40 characters in length). */
1276
+ CharacterName: string;
1277
+ /** Type of the character being granted; statistics can be sliced based on this value. */
1278
+ CharacterType: string;
1279
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1280
+ CustomTags?: Record<string, string | null>;
1281
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1282
+ PlayFabId: string;
1283
+ }
1284
+ interface GrantCharacterToUserResult extends IPlayFabResultCommon {
1285
+ /** Unique identifier tagged to this character. */
1286
+ CharacterId?: string;
1287
+ }
1288
+ interface GrantedItemInstance {
1289
+ /** Game specific comment associated with this instance when it was added to the user inventory. */
1290
+ Annotation?: string;
1291
+ /** Array of unique items that were awarded when this catalog item was purchased. */
1292
+ BundleContents?: string[];
1293
+ /**
1294
+ * Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
1295
+ * container.
1296
+ */
1297
+ BundleParent?: string;
1298
+ /** Catalog version for the inventory item, when this instance was created. */
1299
+ CatalogVersion?: string;
1300
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1301
+ CharacterId?: string;
1302
+ /**
1303
+ * A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
1304
+ * item's custom data.
1305
+ */
1306
+ CustomData?: Record<string, string | null>;
1307
+ /** CatalogItem.DisplayName at the time this item was purchased. */
1308
+ DisplayName?: string;
1309
+ /** Timestamp for when this instance will expire. */
1310
+ Expiration?: string;
1311
+ /** Class name for the inventory item, as defined in the catalog. */
1312
+ ItemClass?: string;
1313
+ /** Unique identifier for the inventory item, as defined in the catalog. */
1314
+ ItemId?: string;
1315
+ /** Unique item identifier for this specific instance of the item. */
1316
+ ItemInstanceId?: string;
1317
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1318
+ PlayFabId?: string;
1319
+ /** Timestamp for when this instance was purchased. */
1320
+ PurchaseDate?: string;
1321
+ /** Total number of remaining uses, if this is a consumable item. */
1322
+ RemainingUses?: number;
1323
+ /** Result of this operation. */
1324
+ Result: boolean;
1325
+ /** Currency type for the cost of the catalog item. Not available when granting items. */
1326
+ UnitCurrency?: string;
1327
+ /** Cost of the catalog item in the given currency. Not available when granting items. */
1328
+ UnitPrice: number;
1329
+ /** The number of uses that were added or removed to this item in this call. */
1330
+ UsesIncrementedBy?: number;
1331
+ }
1332
+ interface GrantItemsToCharacterRequest extends IPlayFabRequestCommon {
1333
+ /** String detailing any additional information concerning this operation. */
1334
+ Annotation?: string;
1335
+ /** Catalog version from which items are to be granted. */
1336
+ CatalogVersion?: string;
1337
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1338
+ CharacterId: string;
1339
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1340
+ CustomTags?: Record<string, string | null>;
1341
+ /** Array of itemIds to grant to the user. */
1342
+ ItemIds?: string[];
1343
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1344
+ PlayFabId: string;
1345
+ }
1346
+ interface GrantItemsToCharacterResult extends IPlayFabResultCommon {
1347
+ /** Array of items granted to users. */
1348
+ ItemGrantResults?: GrantedItemInstance[];
1349
+ }
1350
+ interface GrantItemsToUserRequest extends IPlayFabRequestCommon {
1351
+ /** String detailing any additional information concerning this operation. */
1352
+ Annotation?: string;
1353
+ /** Catalog version from which items are to be granted. */
1354
+ CatalogVersion?: string;
1355
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1356
+ CustomTags?: Record<string, string | null>;
1357
+ /** Array of itemIds to grant to the user. */
1358
+ ItemIds: string[];
1359
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1360
+ PlayFabId: string;
1361
+ }
1362
+ interface GrantItemsToUserResult extends IPlayFabResultCommon {
1363
+ /** Array of items granted to users. */
1364
+ ItemGrantResults?: GrantedItemInstance[];
1365
+ }
1366
+ interface GrantItemsToUsersRequest extends IPlayFabRequestCommon {
1367
+ /** Catalog version from which items are to be granted. */
1368
+ CatalogVersion?: string;
1369
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1370
+ CustomTags?: Record<string, string | null>;
1371
+ /** Array of items to grant and the users to whom the items are to be granted. */
1372
+ ItemGrants: ItemGrant[];
1373
+ }
1374
+ interface GrantItemsToUsersResult extends IPlayFabResultCommon {
1375
+ /** Array of items granted to users. */
1376
+ ItemGrantResults?: GrantedItemInstance[];
1377
+ }
1378
+ interface ItemGrant {
1379
+ /** String detailing any additional information concerning this operation. */
1380
+ Annotation?: string;
1381
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1382
+ CharacterId?: string;
1383
+ /**
1384
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
1385
+ * not begin with a '!' character or be null.
1386
+ */
1387
+ Data?: Record<string, string | null>;
1388
+ /** Unique identifier of the catalog item to be granted to the user. */
1389
+ ItemId: string;
1390
+ /**
1391
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
1392
+ * constraints. Use this to delete the keys directly.
1393
+ */
1394
+ KeysToRemove?: string[];
1395
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1396
+ PlayFabId: string;
1397
+ }
1398
+ interface ItemInstance {
1399
+ /** Game specific comment associated with this instance when it was added to the user inventory. */
1400
+ Annotation?: string;
1401
+ /** Array of unique items that were awarded when this catalog item was purchased. */
1402
+ BundleContents?: string[];
1403
+ /**
1404
+ * Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
1405
+ * container.
1406
+ */
1407
+ BundleParent?: string;
1408
+ /** Catalog version for the inventory item, when this instance was created. */
1409
+ CatalogVersion?: string;
1410
+ /**
1411
+ * A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
1412
+ * item's custom data.
1413
+ */
1414
+ CustomData?: Record<string, string | null>;
1415
+ /** CatalogItem.DisplayName at the time this item was purchased. */
1416
+ DisplayName?: string;
1417
+ /** Timestamp for when this instance will expire. */
1418
+ Expiration?: string;
1419
+ /** Class name for the inventory item, as defined in the catalog. */
1420
+ ItemClass?: string;
1421
+ /** Unique identifier for the inventory item, as defined in the catalog. */
1422
+ ItemId?: string;
1423
+ /** Unique item identifier for this specific instance of the item. */
1424
+ ItemInstanceId?: string;
1425
+ /** Timestamp for when this instance was purchased. */
1426
+ PurchaseDate?: string;
1427
+ /** Total number of remaining uses, if this is a consumable item. */
1428
+ RemainingUses?: number;
1429
+ /** Currency type for the cost of the catalog item. Not available when granting items. */
1430
+ UnitCurrency?: string;
1431
+ /** Cost of the catalog item in the given currency. Not available when granting items. */
1432
+ UnitPrice: number;
1433
+ /** The number of uses that were added or removed to this item in this call. */
1434
+ UsesIncrementedBy?: number;
1435
+ }
1436
+ interface LinkBattleNetAccountRequest extends IPlayFabRequestCommon {
1437
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1438
+ CustomTags?: Record<string, string | null>;
1439
+ /** If another user is already linked to a specific Battle.net account, unlink the other user and re-link. */
1440
+ ForceLink?: boolean;
1441
+ /** The JSON Web Token (JWT) returned by Battle.net after login */
1442
+ IdentityToken: string;
1443
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1444
+ PlayFabId: string;
1445
+ }
1446
+ interface LinkedPlatformAccountModel {
1447
+ /** Linked account email of the user on the platform, if available */
1448
+ Email?: string;
1449
+ /** Authentication platform */
1450
+ Platform?: string;
1451
+ /** Unique account identifier of the user on the platform */
1452
+ PlatformUserId?: string;
1453
+ /** Linked account username of the user on the platform, if available */
1454
+ Username?: string;
1455
+ }
1456
+ interface LinkNintendoServiceAccountRequest extends IPlayFabRequestCommon {
1457
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1458
+ CustomTags?: Record<string, string | null>;
1459
+ /** If another user is already linked to a specific Nintendo Switch account, unlink the other user and re-link. */
1460
+ ForceLink?: boolean;
1461
+ /**
1462
+ * The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo
1463
+ * Switch subject) to link with.
1464
+ */
1465
+ IdentityToken: string;
1466
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1467
+ PlayFabId: string;
1468
+ }
1469
+ interface LinkNintendoServiceAccountSubjectRequest extends IPlayFabRequestCommon {
1470
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1471
+ CustomTags?: Record<string, string | null>;
1472
+ /** If another user is already linked to a specific Nintendo Service Account, unlink the other user and re-link. */
1473
+ ForceLink?: boolean;
1474
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1475
+ PlayFabId: string;
1476
+ /** The Nintendo Service Account subject or id to link to the PlayFab user. */
1477
+ Subject: string;
1478
+ }
1479
+ interface LinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
1480
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1481
+ CustomTags?: Record<string, string | null>;
1482
+ /** If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link. */
1483
+ ForceLink?: boolean;
1484
+ /** Nintendo Switch unique identifier for the user's device. */
1485
+ NintendoSwitchDeviceId: string;
1486
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1487
+ PlayFabId: string;
1488
+ }
1489
+ interface LinkNintendoSwitchDeviceIdResult extends IPlayFabResultCommon {
1490
+ }
1491
+ interface LinkPSNAccountRequest extends IPlayFabRequestCommon {
1492
+ /** Authentication code provided by the PlayStation :tm: Network. */
1493
+ AuthCode: string;
1494
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1495
+ CustomTags?: Record<string, string | null>;
1496
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1497
+ ForceLink?: boolean;
1498
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1499
+ IssuerId?: number;
1500
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1501
+ PlayFabId: string;
1502
+ /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
1503
+ RedirectUri: string;
1504
+ }
1505
+ interface LinkPSNAccountResult extends IPlayFabResultCommon {
1506
+ }
1507
+ interface LinkPSNIdRequest extends IPlayFabRequestCommon {
1508
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1509
+ CustomTags?: Record<string, string | null>;
1510
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1511
+ ForceLink?: boolean;
1512
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1513
+ IssuerId?: number;
1514
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1515
+ PlayFabId: string;
1516
+ /** Id of the PlayStation :tm: Network user. Also known as the PSN Account Id. */
1517
+ PSNUserId: string;
1518
+ }
1519
+ interface LinkPSNIdResponse extends IPlayFabResultCommon {
1520
+ }
1521
+ interface LinkServerCustomIdRequest extends IPlayFabRequestCommon {
1522
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1523
+ CustomTags?: Record<string, string | null>;
1524
+ /** If another user is already linked to the custom ID, unlink the other user and re-link. */
1525
+ ForceLink?: boolean;
1526
+ /** Unique PlayFab identifier. */
1527
+ PlayFabId: string;
1528
+ /** Unique server custom identifier for this player. */
1529
+ ServerCustomId: string;
1530
+ }
1531
+ interface LinkServerCustomIdResult extends IPlayFabResultCommon {
1532
+ }
1533
+ interface LinkSteamIdRequest extends IPlayFabRequestCommon {
1534
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1535
+ CustomTags?: Record<string, string | null>;
1536
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1537
+ ForceLink?: boolean;
1538
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
1539
+ PlayFabId: string;
1540
+ /** Unique Steam identifier for a user. */
1541
+ SteamId: string;
1542
+ }
1543
+ interface LinkSteamIdResult extends IPlayFabResultCommon {
1544
+ }
1545
+ interface LinkXboxAccountRequest extends IPlayFabRequestCommon {
1546
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1547
+ CustomTags?: Record<string, string | null>;
1548
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1549
+ ForceLink?: boolean;
1550
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
1551
+ PlayFabId: string;
1552
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
1553
+ XboxToken: string;
1554
+ }
1555
+ interface LinkXboxAccountResult extends IPlayFabResultCommon {
1556
+ }
1557
+ interface ListPlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
1558
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1559
+ PlayFabId: string;
1560
+ }
1561
+ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
1562
+ /** PlayFab unique identifier of the user whose properties are being returned. */
1563
+ PlayFabId?: string;
1564
+ /** Player specific properties and their corresponding values for this title. */
1565
+ Properties?: CustomPropertyDetails[];
1566
+ /**
1567
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
1568
+ * deletes. This version can be provided in update and delete calls for concurrency control.
1569
+ */
1570
+ PropertiesVersion: number;
1571
+ }
1572
+ interface ListUsersCharactersRequest extends IPlayFabRequestCommon {
1573
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1574
+ PlayFabId: string;
1575
+ }
1576
+ interface ListUsersCharactersResult extends IPlayFabResultCommon {
1577
+ /** The requested list of characters. */
1578
+ Characters?: CharacterResult[];
1579
+ }
1580
+ interface LocalizedPushNotificationProperties {
1581
+ /** Message of the localized push notification template. */
1582
+ Message?: string;
1583
+ /** Subject of the localized push notification template. */
1584
+ Subject?: string;
1585
+ }
1586
+ interface LocationModel {
1587
+ /** City name. */
1588
+ City?: string;
1589
+ /** The two-character continent code for this location */
1590
+ ContinentCode?: string;
1591
+ /** The two-character ISO 3166-1 country code for the country associated with the location */
1592
+ CountryCode?: string;
1593
+ /** Latitude coordinate of the geographic location. */
1594
+ Latitude?: number;
1595
+ /** Longitude coordinate of the geographic location. */
1596
+ Longitude?: number;
1597
+ }
1598
+ interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
1599
+ /** Specific model of the user's device. */
1600
+ AndroidDevice?: string;
1601
+ /** Android device identifier for the user's device. */
1602
+ AndroidDeviceId: string;
1603
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1604
+ CreateAccount?: boolean;
1605
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1606
+ CustomTags?: Record<string, string | null>;
1607
+ /** Flags for which pieces of info to return for the user. */
1608
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1609
+ /** Specific Operating System version for the user's device. */
1610
+ OS?: string;
1611
+ }
1612
+ interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
1613
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1614
+ CreateAccount?: boolean;
1615
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1616
+ CustomTags?: Record<string, string | null>;
1617
+ /** The JSON Web Token (JWT) returned by Battle.net after login */
1618
+ IdentityToken: string;
1619
+ /** Flags for which pieces of info to return for the user. */
1620
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1621
+ }
1622
+ interface LoginWithCustomIDRequest extends IPlayFabRequestCommon {
1623
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1624
+ CreateAccount?: boolean;
1625
+ /** Custom unique identifier for the user, generated by the title. */
1626
+ CustomId: string;
1627
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1628
+ CustomTags?: Record<string, string | null>;
1629
+ /** Flags for which pieces of info to return for the user. */
1630
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1631
+ }
1632
+ interface LoginWithIOSDeviceIDRequest extends IPlayFabRequestCommon {
1633
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1634
+ CreateAccount?: boolean;
1635
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1636
+ CustomTags?: Record<string, string | null>;
1637
+ /** Vendor-specific iOS identifier for the user's device. */
1638
+ DeviceId: string;
1639
+ /** Specific model of the user's device. */
1640
+ DeviceModel?: string;
1641
+ /** Flags for which pieces of info to return for the user. */
1642
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1643
+ /** Specific Operating System version for the user's device. */
1644
+ OS?: string;
1645
+ }
1646
+ interface LoginWithPSNRequest extends IPlayFabRequestCommon {
1647
+ /** Auth code provided by the PlayStation :tm: Network OAuth provider. */
1648
+ AuthCode: string;
1649
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1650
+ CreateAccount?: boolean;
1651
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1652
+ CustomTags?: Record<string, string | null>;
1653
+ /** Flags for which pieces of info to return for the user. */
1654
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1655
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1656
+ IssuerId?: number;
1657
+ /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
1658
+ RedirectUri: string;
1659
+ }
1660
+ interface LoginWithServerCustomIdRequest extends IPlayFabRequestCommon {
1661
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1662
+ CreateAccount?: boolean;
1663
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1664
+ CustomTags?: Record<string, string | null>;
1665
+ /** Flags for which pieces of info to return for the user. */
1666
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1667
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1668
+ PlayerSecret?: string;
1669
+ /** The backend server identifier for this player. */
1670
+ ServerCustomId: string;
1671
+ }
1672
+ interface LoginWithSteamIdRequest extends IPlayFabRequestCommon {
1673
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1674
+ CreateAccount?: boolean;
1675
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1676
+ CustomTags?: Record<string, string | null>;
1677
+ /** Flags for which pieces of info to return for the user. */
1678
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1679
+ /** Unique Steam identifier for a user. */
1680
+ SteamId: string;
1681
+ }
1682
+ interface LoginWithXboxIdRequest extends IPlayFabRequestCommon {
1683
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1684
+ CreateAccount?: boolean;
1685
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1686
+ CustomTags?: Record<string, string | null>;
1687
+ /** Flags for which pieces of info to return for the user. */
1688
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1689
+ /** The id of Xbox Live sandbox. */
1690
+ Sandbox: string;
1691
+ /** Unique Xbox identifier for a user. */
1692
+ XboxId: string;
1693
+ }
1694
+ interface LoginWithXboxRequest extends IPlayFabRequestCommon {
1695
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1696
+ CreateAccount?: boolean;
1697
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1698
+ CustomTags?: Record<string, string | null>;
1699
+ /** Flags for which pieces of info to return for the user. */
1700
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1701
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
1702
+ XboxToken: string;
1703
+ }
1704
+ interface LogStatement {
1705
+ /** Optional object accompanying the message as contextual information */
1706
+ Data?: any;
1707
+ /** 'Debug', 'Info', or 'Error' */
1708
+ Level?: string;
1709
+ Message?: string;
1710
+ }
1711
+ interface MembershipModel {
1712
+ /** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
1713
+ IsActive: boolean;
1714
+ /** The time this membership expires */
1715
+ MembershipExpiration: string;
1716
+ /** The id of the membership */
1717
+ MembershipId?: string;
1718
+ /**
1719
+ * Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been
1720
+ * overridden, this will be the new expiration time.
1721
+ */
1722
+ OverrideExpiration?: string;
1723
+ /** The list of subscriptions that this player has for this membership */
1724
+ Subscriptions?: SubscriptionModel[];
1725
+ }
1726
+ interface ModifyCharacterVirtualCurrencyResult extends IPlayFabResultCommon {
1727
+ /** Balance of the virtual currency after modification. */
1728
+ Balance: number;
1729
+ /** Name of the virtual currency which was modified. */
1730
+ VirtualCurrency?: string;
1731
+ }
1732
+ interface ModifyItemUsesRequest extends IPlayFabRequestCommon {
1733
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1734
+ CustomTags?: Record<string, string | null>;
1735
+ /** Unique instance identifier of the item to be modified. */
1736
+ ItemInstanceId: string;
1737
+ /** PlayFab unique identifier of the user whose item is being modified. */
1738
+ PlayFabId: string;
1739
+ /** Number of uses to add to the item. Can be negative to remove uses. */
1740
+ UsesToAdd: number;
1741
+ }
1742
+ interface ModifyItemUsesResult extends IPlayFabResultCommon {
1743
+ /** Unique instance identifier of the item with uses consumed. */
1744
+ ItemInstanceId?: string;
1745
+ /** Number of uses remaining on the item. */
1746
+ RemainingUses: number;
1747
+ }
1748
+ interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
1749
+ /** Balance of the virtual currency after modification. */
1750
+ Balance: number;
1751
+ /**
1752
+ * Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
1753
+ * over this value will be discarded.
1754
+ */
1755
+ BalanceChange: number;
1756
+ /** User currency was subtracted from. */
1757
+ PlayFabId?: string;
1758
+ /** Name of the virtual currency which was modified. */
1759
+ VirtualCurrency?: string;
1760
+ }
1761
+ interface MoveItemToCharacterFromCharacterRequest extends IPlayFabRequestCommon {
1762
+ /** Unique identifier of the character that currently has the item. */
1763
+ GivingCharacterId: string;
1764
+ /** Unique PlayFab assigned instance identifier of the item */
1765
+ ItemInstanceId: string;
1766
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1767
+ PlayFabId: string;
1768
+ /** Unique identifier of the character that will be receiving the item. */
1769
+ ReceivingCharacterId: string;
1770
+ }
1771
+ interface MoveItemToCharacterFromCharacterResult extends IPlayFabResultCommon {
1772
+ }
1773
+ interface MoveItemToCharacterFromUserRequest extends IPlayFabRequestCommon {
1774
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1775
+ CharacterId: string;
1776
+ /** Unique PlayFab assigned instance identifier of the item */
1777
+ ItemInstanceId: string;
1778
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1779
+ PlayFabId: string;
1780
+ }
1781
+ interface MoveItemToCharacterFromUserResult extends IPlayFabResultCommon {
1782
+ }
1783
+ interface MoveItemToUserFromCharacterRequest extends IPlayFabRequestCommon {
1784
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
1785
+ CharacterId: string;
1786
+ /** Unique PlayFab assigned instance identifier of the item */
1787
+ ItemInstanceId: string;
1788
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1789
+ PlayFabId: string;
1790
+ }
1791
+ interface MoveItemToUserFromCharacterResult extends IPlayFabResultCommon {
1792
+ }
1793
+ interface NintendoServiceAccountPlayFabIdPair {
1794
+ /** Unique Nintendo Switch Service Account identifier for a user. */
1795
+ NintendoServiceAccountId?: string;
1796
+ /**
1797
+ * Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Service Account
1798
+ * identifier.
1799
+ */
1800
+ PlayFabId?: string;
1801
+ }
1802
+ interface NintendoSwitchPlayFabIdPair {
1803
+ /** Unique Nintendo Switch Device identifier for a user. */
1804
+ NintendoSwitchDeviceId?: string;
1805
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier. */
1806
+ PlayFabId?: string;
1807
+ }
1808
+ interface PlayerLeaderboardEntry {
1809
+ /** Title-specific display name of the user for this leaderboard entry. */
1810
+ DisplayName?: string;
1811
+ /** PlayFab unique identifier of the user for this leaderboard entry. */
1812
+ PlayFabId?: string;
1813
+ /** User's overall position in the leaderboard. */
1814
+ Position: number;
1815
+ /** The profile of the user, if requested. */
1816
+ Profile?: PlayerProfileModel;
1817
+ /** Specific value of the user's statistic. */
1818
+ StatValue: number;
1819
+ }
1820
+ interface PlayerLinkedAccount {
1821
+ /** Linked account's email */
1822
+ Email?: string;
1823
+ /** Authentication platform */
1824
+ Platform?: string;
1825
+ /** Platform user identifier */
1826
+ PlatformUserId?: string;
1827
+ /** Linked account's username */
1828
+ Username?: string;
1829
+ }
1830
+ interface PlayerLocation {
1831
+ /** City of the player's geographic location. */
1832
+ City?: string;
1833
+ /** The two-character continent code for this location */
1834
+ ContinentCode: string;
1835
+ /** The two-character ISO 3166-1 country code for the country associated with the location */
1836
+ CountryCode: string;
1837
+ /** Latitude coordinate of the player's geographic location. */
1838
+ Latitude?: number;
1839
+ /** Longitude coordinate of the player's geographic location. */
1840
+ Longitude?: number;
1841
+ }
1842
+ interface PlayerProfile {
1843
+ /** Array of ad campaigns player has been attributed to */
1844
+ AdCampaignAttributions?: AdCampaignAttribution[];
1845
+ /** Image URL of the player's avatar. */
1846
+ AvatarUrl?: string;
1847
+ /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */
1848
+ BannedUntil?: string;
1849
+ /** The prediction of the player to churn within the next seven days. */
1850
+ ChurnPrediction?: string;
1851
+ /** Array of contact email addresses associated with the player */
1852
+ ContactEmailAddresses?: ContactEmailInfo[];
1853
+ /** Player record created */
1854
+ Created?: string;
1855
+ /** Dictionary of player's custom properties. */
1856
+ CustomProperties?: Record<string, any>;
1857
+ /** Player Display Name */
1858
+ DisplayName?: string;
1859
+ /** Last login */
1860
+ LastLogin?: string;
1861
+ /** Array of third party accounts linked to this player */
1862
+ LinkedAccounts?: PlayerLinkedAccount[];
1863
+ /** Dictionary of player's locations by type. */
1864
+ Locations?: Record<string, PlayerLocation>;
1865
+ /** Player account origination */
1866
+ Origination?: string;
1867
+ /** List of player variants for experimentation */
1868
+ PlayerExperimentVariants?: string[];
1869
+ /** PlayFab Player ID */
1870
+ PlayerId?: string;
1871
+ /** Array of player statistics */
1872
+ PlayerStatistics?: PlayerStatistic[];
1873
+ /** Publisher this player belongs to */
1874
+ PublisherId?: string;
1875
+ /** Array of configured push notification end points */
1876
+ PushNotificationRegistrations?: PushNotificationRegistration[];
1877
+ /** Dictionary of player's statistics using only the latest version's value */
1878
+ Statistics?: Record<string, number>;
1879
+ /** List of player's tags for segmentation. */
1880
+ Tags?: string[];
1881
+ /** Title ID this profile applies to */
1882
+ TitleId?: string;
1883
+ /** A sum of player's total purchases in USD across all currencies. */
1884
+ TotalValueToDateInUSD?: number;
1885
+ /** Dictionary of player's total purchases by currency. */
1886
+ ValuesToDate?: Record<string, number>;
1887
+ /** Dictionary of player's virtual currency balances */
1888
+ VirtualCurrencyBalances?: Record<string, number>;
1889
+ }
1890
+ interface PlayerProfileModel {
1891
+ /** List of advertising campaigns the player has been attributed to */
1892
+ AdCampaignAttributions?: AdCampaignAttributionModel[];
1893
+ /** URL of the player's avatar image */
1894
+ AvatarUrl?: string;
1895
+ /** If the player is currently banned, the UTC Date when the ban expires */
1896
+ BannedUntil?: string;
1897
+ /** List of all contact email info associated with the player account */
1898
+ ContactEmailAddresses?: ContactEmailInfoModel[];
1899
+ /** Player record created */
1900
+ Created?: string;
1901
+ /** Player display name */
1902
+ DisplayName?: string;
1903
+ /**
1904
+ * List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned
1905
+ * during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment
1906
+ * property during login to get the correct variants and variables.
1907
+ */
1908
+ ExperimentVariants?: string[];
1909
+ /** UTC time when the player most recently logged in to the title */
1910
+ LastLogin?: string;
1911
+ /** List of all authentication systems linked to this player account */
1912
+ LinkedAccounts?: LinkedPlatformAccountModel[];
1913
+ /** List of geographic locations from which the player has logged in to the title */
1914
+ Locations?: LocationModel[];
1915
+ /** List of memberships for the player, along with whether are expired. */
1916
+ Memberships?: MembershipModel[];
1917
+ /** Player account origination */
1918
+ Origination?: string;
1919
+ /** PlayFab player account unique identifier */
1920
+ PlayerId?: string;
1921
+ /** Publisher this player belongs to */
1922
+ PublisherId?: string;
1923
+ /** List of configured end points registered for sending the player push notifications */
1924
+ PushNotificationRegistrations?: PushNotificationRegistrationModel[];
1925
+ /** List of leaderboard statistic values for the player */
1926
+ Statistics?: StatisticModel[];
1927
+ /** List of player's tags for segmentation */
1928
+ Tags?: TagModel[];
1929
+ /** Title ID this player profile applies to */
1930
+ TitleId?: string;
1931
+ /**
1932
+ * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
1933
+ * whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
1934
+ */
1935
+ TotalValueToDateInUSD?: number;
1936
+ /** List of the player's lifetime purchase totals, summed by real-money currency */
1937
+ ValuesToDate?: ValueToDateModel[];
1938
+ }
1939
+ interface PlayerProfileViewConstraints {
1940
+ /** Whether to show player's avatar URL. Defaults to false */
1941
+ ShowAvatarUrl: boolean;
1942
+ /** Whether to show the banned until time. Defaults to false */
1943
+ ShowBannedUntil: boolean;
1944
+ /** Whether to show campaign attributions. Defaults to false */
1945
+ ShowCampaignAttributions: boolean;
1946
+ /** Whether to show contact email addresses. Defaults to false */
1947
+ ShowContactEmailAddresses: boolean;
1948
+ /** Whether to show the created date. Defaults to false */
1949
+ ShowCreated: boolean;
1950
+ /** Whether to show the display name. Defaults to false */
1951
+ ShowDisplayName: boolean;
1952
+ /** Whether to show player's experiment variants. Defaults to false */
1953
+ ShowExperimentVariants: boolean;
1954
+ /** Whether to show the last login time. Defaults to false */
1955
+ ShowLastLogin: boolean;
1956
+ /** Whether to show the linked accounts. Defaults to false */
1957
+ ShowLinkedAccounts: boolean;
1958
+ /** Whether to show player's locations. Defaults to false */
1959
+ ShowLocations: boolean;
1960
+ /** Whether to show player's membership information. Defaults to false */
1961
+ ShowMemberships: boolean;
1962
+ /** Whether to show origination. Defaults to false */
1963
+ ShowOrigination: boolean;
1964
+ /** Whether to show push notification registrations. Defaults to false */
1965
+ ShowPushNotificationRegistrations: boolean;
1966
+ /** Reserved for future development */
1967
+ ShowStatistics: boolean;
1968
+ /** Whether to show tags. Defaults to false */
1969
+ ShowTags: boolean;
1970
+ /** Whether to show the total value to date in usd. Defaults to false */
1971
+ ShowTotalValueToDateInUsd: boolean;
1972
+ /** Whether to show the values to date. Defaults to false */
1973
+ ShowValuesToDate: boolean;
1974
+ }
1975
+ interface PlayerStatistic {
1976
+ /** Statistic ID */
1977
+ Id?: string;
1978
+ /** Statistic name */
1979
+ Name?: string;
1980
+ /** Current statistic value */
1981
+ StatisticValue: number;
1982
+ /** Statistic version (0 if not a versioned statistic) */
1983
+ StatisticVersion: number;
1984
+ }
1985
+ interface PlayerStatisticVersion {
1986
+ /** time when the statistic version became active */
1987
+ ActivationTime: string;
1988
+ /** time when the statistic version became inactive due to statistic version incrementing */
1989
+ DeactivationTime?: string;
1990
+ /** time at which the statistic version was scheduled to become active, based on the configured ResetInterval */
1991
+ ScheduledActivationTime?: string;
1992
+ /** time at which the statistic version was scheduled to become inactive, based on the configured ResetInterval */
1993
+ ScheduledDeactivationTime?: string;
1994
+ /** name of the statistic when the version became active */
1995
+ StatisticName?: string;
1996
+ /** version of the statistic */
1997
+ Version: number;
1998
+ }
1999
+ interface PSNAccountPlayFabIdPair {
2000
+ /**
2001
+ * Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation :tm: Network
2002
+ * identifier.
2003
+ */
2004
+ PlayFabId?: string;
2005
+ /** Unique PlayStation :tm: Network identifier for a user. */
2006
+ PSNAccountId?: string;
2007
+ }
2008
+ interface PSNOnlinePlayFabIdPair {
2009
+ /**
2010
+ * Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation :tm: Network
2011
+ * identifier.
2012
+ */
2013
+ PlayFabId?: string;
2014
+ /** Unique PlayStation :tm: Network identifier for a user. */
2015
+ PSNOnlineId?: string;
2016
+ }
2017
+ interface PushNotificationPackage {
2018
+ /** Numerical badge to display on App icon (iOS only) */
2019
+ Badge: number;
2020
+ /** This must be a JSON formatted object. For use with developer-created custom Push Notification plugins */
2021
+ CustomData?: string;
2022
+ /** Icon file to display with the message (Not supported for iOS) */
2023
+ Icon?: string;
2024
+ /** Content of the message (all platforms) */
2025
+ Message: string;
2026
+ /** Sound file to play with the message (all platforms) */
2027
+ Sound?: string;
2028
+ /** Title/Subject of the message. Not supported for iOS */
2029
+ Title: string;
2030
+ }
2031
+ interface PushNotificationRegistration {
2032
+ /** Notification configured endpoint */
2033
+ NotificationEndpointARN?: string;
2034
+ /** Push notification platform */
2035
+ Platform?: string;
2036
+ }
2037
+ interface PushNotificationRegistrationModel {
2038
+ /** Notification configured endpoint */
2039
+ NotificationEndpointARN?: string;
2040
+ /** Push notification platform */
2041
+ Platform?: string;
2042
+ }
2043
+ interface RandomResultTableListing {
2044
+ /** Catalog version this table is associated with */
2045
+ CatalogVersion?: string;
2046
+ /** Child nodes that indicate what kind of drop table item this actually is. */
2047
+ Nodes: ResultTableNode[];
2048
+ /** Unique name for this drop table */
2049
+ TableId: string;
2050
+ }
2051
+ interface RedeemCouponRequest extends IPlayFabRequestCommon {
2052
+ /** Catalog version of the coupon. */
2053
+ CatalogVersion?: string;
2054
+ /** Optional identifier for the Character that should receive the item. If null, item is added to the player */
2055
+ CharacterId?: string;
2056
+ /** Generated coupon code to redeem. */
2057
+ CouponCode: string;
2058
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2059
+ CustomTags?: Record<string, string | null>;
2060
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2061
+ PlayFabId: string;
2062
+ }
2063
+ interface RedeemCouponResult extends IPlayFabResultCommon {
2064
+ /** Items granted to the player as a result of redeeming the coupon. */
2065
+ GrantedItems?: ItemInstance[];
2066
+ }
2067
+ interface RemoveFriendRequest extends IPlayFabRequestCommon {
2068
+ /** PlayFab identifier of the friend account which is to be removed. */
2069
+ FriendPlayFabId: string;
2070
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2071
+ PlayFabId: string;
2072
+ }
2073
+ interface RemoveGenericIDRequest extends IPlayFabRequestCommon {
2074
+ /** Generic service identifier to be removed from the player. */
2075
+ GenericId: GenericServiceId;
2076
+ /** PlayFabId of the user to remove. */
2077
+ PlayFabId: string;
2078
+ }
2079
+ interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
2080
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2081
+ CustomTags?: Record<string, string | null>;
2082
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2083
+ PlayFabId: string;
2084
+ /** Unique tag for player profile. */
2085
+ TagName: string;
2086
+ }
2087
+ interface RemovePlayerTagResult extends IPlayFabResultCommon {
2088
+ }
2089
+ interface RemoveSharedGroupMembersRequest extends IPlayFabRequestCommon {
2090
+ /** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
2091
+ PlayFabIds: string[];
2092
+ /** Unique identifier for the shared group. */
2093
+ SharedGroupId: string;
2094
+ }
2095
+ interface RemoveSharedGroupMembersResult extends IPlayFabResultCommon {
2096
+ }
2097
+ interface ReportPlayerServerRequest extends IPlayFabRequestCommon {
2098
+ /** Optional additional comment by reporting player. */
2099
+ Comment?: string;
2100
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2101
+ CustomTags?: Record<string, string | null>;
2102
+ /** Unique PlayFab identifier of the reported player. */
2103
+ ReporteeId: string;
2104
+ /** PlayFabId of the reporting player. */
2105
+ ReporterId: string;
2106
+ }
2107
+ interface ReportPlayerServerResult extends IPlayFabResultCommon {
2108
+ /** The number of remaining reports which may be filed today by this reporting player. */
2109
+ SubmissionsRemaining: number;
2110
+ }
2111
+ interface ResultTableNode {
2112
+ /** Either an ItemId, or the TableId of another random result table */
2113
+ ResultItem: string;
2114
+ /** Whether this entry in the table is an item or a link to another table */
2115
+ ResultItemType: string;
2116
+ /** How likely this is to be rolled - larger numbers add more weight */
2117
+ Weight: number;
2118
+ }
2119
+ interface RevokeAllBansForUserRequest extends IPlayFabRequestCommon {
2120
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2121
+ PlayFabId: string;
2122
+ }
2123
+ interface RevokeAllBansForUserResult extends IPlayFabResultCommon {
2124
+ /** Information on the bans that were revoked. */
2125
+ BanData?: BanInfo[];
2126
+ }
2127
+ interface RevokeBansRequest extends IPlayFabRequestCommon {
2128
+ /** Ids of the bans to be revoked. Maximum 100. */
2129
+ BanIds: string[];
2130
+ }
2131
+ interface RevokeBansResult extends IPlayFabResultCommon {
2132
+ /** Information on the bans that were revoked */
2133
+ BanData?: BanInfo[];
2134
+ }
2135
+ interface RevokeInventoryItem {
2136
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2137
+ CharacterId?: string;
2138
+ /** Unique PlayFab assigned instance identifier of the item */
2139
+ ItemInstanceId: string;
2140
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2141
+ PlayFabId: string;
2142
+ }
2143
+ interface RevokeInventoryItemRequest extends IPlayFabRequestCommon {
2144
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2145
+ CharacterId?: string;
2146
+ /** Unique PlayFab assigned instance identifier of the item */
2147
+ ItemInstanceId: string;
2148
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2149
+ PlayFabId: string;
2150
+ }
2151
+ interface RevokeInventoryItemsRequest extends IPlayFabRequestCommon {
2152
+ /** Array of player items to revoke, between 1 and 25 items. */
2153
+ Items: RevokeInventoryItem[];
2154
+ }
2155
+ interface RevokeInventoryItemsResult extends IPlayFabResultCommon {
2156
+ /** Collection of any errors that occurred during processing. */
2157
+ Errors?: RevokeItemError[];
2158
+ }
2159
+ interface RevokeInventoryResult extends IPlayFabResultCommon {
2160
+ }
2161
+ interface RevokeItemError {
2162
+ /** Specific error that was encountered. */
2163
+ Error?: string;
2164
+ /** Item information that failed to be revoked. */
2165
+ Item?: RevokeInventoryItem;
2166
+ }
2167
+ interface SavePushNotificationTemplateRequest extends IPlayFabRequestCommon {
2168
+ /** Android JSON for the notification template. */
2169
+ AndroidPayload?: string;
2170
+ /** Id of the push notification template. */
2171
+ Id?: string;
2172
+ /** IOS JSON for the notification template. */
2173
+ IOSPayload?: string;
2174
+ /** Dictionary of localized push notification templates with the language as the key. */
2175
+ LocalizedPushNotificationTemplates?: Record<string, LocalizedPushNotificationProperties>;
2176
+ /** Name of the push notification template. */
2177
+ Name: string;
2178
+ }
2179
+ interface SavePushNotificationTemplateResult extends IPlayFabResultCommon {
2180
+ /** Id of the push notification template that was saved. */
2181
+ PushNotificationTemplateId?: string;
2182
+ }
2183
+ interface ScriptExecutionError {
2184
+ /**
2185
+ * Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
2186
+ * CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, or CloudScriptHTTPRequestError
2187
+ */
2188
+ Error?: string;
2189
+ /** Details about the error */
2190
+ Message?: string;
2191
+ /** Point during the execution of the script at which the error occurred, if any */
2192
+ StackTrace?: string;
2193
+ }
2194
+ interface SendCustomAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
2195
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2196
+ CustomTags?: Record<string, string | null>;
2197
+ /** User email address attached to their account */
2198
+ Email?: string;
2199
+ /** The email template id of the account recovery email template to send. */
2200
+ EmailTemplateId: string;
2201
+ /** The user's username requesting an account recovery. */
2202
+ Username?: string;
2203
+ }
2204
+ interface SendCustomAccountRecoveryEmailResult extends IPlayFabResultCommon {
2205
+ }
2206
+ interface SendEmailFromTemplateRequest extends IPlayFabRequestCommon {
2207
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2208
+ CustomTags?: Record<string, string | null>;
2209
+ /** The email template id of the email template to send. */
2210
+ EmailTemplateId: string;
2211
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2212
+ PlayFabId: string;
2213
+ }
2214
+ interface SendEmailFromTemplateResult extends IPlayFabResultCommon {
2215
+ }
2216
+ interface SendPushNotificationFromTemplateRequest extends IPlayFabRequestCommon {
2217
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2218
+ CustomTags?: Record<string, string | null>;
2219
+ /** Id of the push notification template. */
2220
+ PushNotificationTemplateId: string;
2221
+ /** PlayFabId of the push notification recipient. */
2222
+ Recipient: string;
2223
+ }
2224
+ interface SendPushNotificationRequest extends IPlayFabRequestCommon {
2225
+ /**
2226
+ * Allows you to provide precisely formatted json to target devices. This is an advanced feature, allowing you to deliver
2227
+ * to custom plugin logic, fields, or functionality not natively supported by PlayFab.
2228
+ */
2229
+ AdvancedPlatformDelivery?: AdvancedPushPlatformMsg[];
2230
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2231
+ CustomTags?: Record<string, string | null>;
2232
+ /** Text of message to send. */
2233
+ Message?: string;
2234
+ /**
2235
+ * Defines all possible push attributes like message, title, icon, etc. Some parameters are device specific - please see
2236
+ * the PushNotificationPackage documentation for details.
2237
+ */
2238
+ Package?: PushNotificationPackage;
2239
+ /** PlayFabId of the recipient of the push notification. */
2240
+ Recipient: string;
2241
+ /** Subject of message to send (may not be displayed in all platforms) */
2242
+ Subject?: string;
2243
+ /** Target Platforms that should receive the Message or Package. If omitted, we will send to all available platforms. */
2244
+ TargetPlatforms?: string[];
2245
+ }
2246
+ interface SendPushNotificationResult extends IPlayFabResultCommon {
2247
+ }
2248
+ interface ServerCustomIDPlayFabIDPair {
2249
+ /** Unique PlayFab identifier. */
2250
+ PlayFabId?: string;
2251
+ /** Unique server custom identifier for this player. */
2252
+ ServerCustomId?: string;
2253
+ }
2254
+ interface ServerLoginResult extends IPlayFabResultCommon {
2255
+ /**
2256
+ * If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and
2257
+ * returned.
2258
+ */
2259
+ EntityToken?: EntityTokenResponse;
2260
+ /** Results for requested info. */
2261
+ InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
2262
+ /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */
2263
+ LastLoginTime?: string;
2264
+ /** True if the master_player_account was newly created on this login. */
2265
+ NewlyCreated: boolean;
2266
+ /** Player's unique PlayFabId. */
2267
+ PlayFabId?: string;
2268
+ /** Unique token authorizing the user and game at the server level, for the current session. */
2269
+ SessionTicket?: string;
2270
+ /** Settings specific to this user. */
2271
+ SettingsForUser?: UserSettings;
2272
+ /** The experimentation treatments for this user at the time of login. */
2273
+ TreatmentAssignment?: TreatmentAssignment;
2274
+ }
2275
+ interface SetFriendTagsRequest extends IPlayFabRequestCommon {
2276
+ /** PlayFab identifier of the friend account to which the tag(s) should be applied. */
2277
+ FriendPlayFabId: string;
2278
+ /** PlayFab identifier of the player whose friend is to be updated. */
2279
+ PlayFabId: string;
2280
+ /** Array of tags to set on the friend account. */
2281
+ Tags: string[];
2282
+ }
2283
+ interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
2284
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2285
+ PlayerSecret?: string;
2286
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2287
+ PlayFabId: string;
2288
+ }
2289
+ interface SetPlayerSecretResult extends IPlayFabResultCommon {
2290
+ }
2291
+ interface SetPublisherDataRequest extends IPlayFabRequestCommon {
2292
+ /**
2293
+ * key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
2294
+ * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
2295
+ */
2296
+ Key: string;
2297
+ /** new value to set. Set to null to remove a value */
2298
+ Value?: string;
2299
+ }
2300
+ interface SetPublisherDataResult extends IPlayFabResultCommon {
2301
+ }
2302
+ interface SetTitleDataRequest extends IPlayFabRequestCommon {
2303
+ /**
2304
+ * key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
2305
+ * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
2306
+ */
2307
+ Key: string;
2308
+ /** new value to set. Set to null to remove a value */
2309
+ Value?: string;
2310
+ }
2311
+ interface SetTitleDataResult extends IPlayFabResultCommon {
2312
+ }
2313
+ interface SharedGroupDataRecord {
2314
+ /** Timestamp for when this data was last updated. */
2315
+ LastUpdated: string;
2316
+ /** PlayFabId of the user to last update this value. */
2317
+ LastUpdatedBy?: string;
2318
+ /** Indicates whether this data can be read by all users (public) or only members of the group (private). */
2319
+ Permission?: string;
2320
+ /** Data stored for the specified group data key. */
2321
+ Value?: string;
2322
+ }
2323
+ interface StatisticModel {
2324
+ /** Statistic name */
2325
+ Name?: string;
2326
+ /** Statistic value */
2327
+ Value: number;
2328
+ /** Statistic version (0 if not a versioned statistic) */
2329
+ Version: number;
2330
+ }
2331
+ interface StatisticNameVersion {
2332
+ /** unique name of the statistic */
2333
+ StatisticName: string;
2334
+ /** the version of the statistic to be returned */
2335
+ Version: number;
2336
+ }
2337
+ interface StatisticUpdate {
2338
+ /** unique name of the statistic */
2339
+ StatisticName: string;
2340
+ /** statistic value for the player */
2341
+ Value: number;
2342
+ /**
2343
+ * for updates to an existing statistic value for a player, the version of the statistic when it was loaded. Null when
2344
+ * setting the statistic value for the first time.
2345
+ */
2346
+ Version?: number;
2347
+ }
2348
+ interface StatisticValue {
2349
+ /** unique name of the statistic */
2350
+ StatisticName?: string;
2351
+ /** statistic value for the player */
2352
+ Value: number;
2353
+ /** for updates to an existing statistic value for a player, the version of the statistic when it was loaded */
2354
+ Version: number;
2355
+ }
2356
+ interface SteamNamePlayFabIdPair {
2357
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
2358
+ PlayFabId?: string;
2359
+ /** Unique Steam identifier for a user, also known as Steam persona name. */
2360
+ SteamName?: string;
2361
+ }
2362
+ interface SteamPlayFabIdPair {
2363
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
2364
+ PlayFabId?: string;
2365
+ /** Unique Steam identifier for a user. */
2366
+ SteamStringId?: string;
2367
+ }
2368
+ interface StoreItem {
2369
+ /** Store specific custom data. The data only exists as part of this store; it is not transferred to item instances */
2370
+ CustomData?: any;
2371
+ /** Intended display position for this item. Note that 0 is the first position */
2372
+ DisplayPosition?: number;
2373
+ /**
2374
+ * Unique identifier of the item as it exists in the catalog - note that this must exactly match the ItemId from the
2375
+ * catalog
2376
+ */
2377
+ ItemId: string;
2378
+ /** Override prices for this item for specific currencies */
2379
+ RealCurrencyPrices?: Record<string, number>;
2380
+ /** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
2381
+ VirtualCurrencyPrices?: Record<string, number>;
2382
+ }
2383
+ interface StoreMarketingModel {
2384
+ /** Tagline for a store. */
2385
+ Description?: string;
2386
+ /** Display name of a store as it will appear to users. */
2387
+ DisplayName?: string;
2388
+ /** Custom data about a store. */
2389
+ Metadata?: any;
2390
+ }
2391
+ interface SubscriptionModel {
2392
+ /** When this subscription expires. */
2393
+ Expiration: string;
2394
+ /** The time the subscription was orignially purchased */
2395
+ InitialSubscriptionTime: string;
2396
+ /** Whether this subscription is currently active. That is, if Expiration > now. */
2397
+ IsActive: boolean;
2398
+ /** The status of this subscription, according to the subscription provider. */
2399
+ Status?: string;
2400
+ /** The id for this subscription */
2401
+ SubscriptionId?: string;
2402
+ /** The item id for this subscription from the primary catalog */
2403
+ SubscriptionItemId?: string;
2404
+ /** The provider for this subscription. Apple or Google Play are supported today. */
2405
+ SubscriptionProvider?: string;
2406
+ }
2407
+ interface SubtractCharacterVirtualCurrencyRequest extends IPlayFabRequestCommon {
2408
+ /** Amount to be subtracted from the user balance of the specified virtual currency. */
2409
+ Amount: number;
2410
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2411
+ CharacterId: string;
2412
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2413
+ CustomTags?: Record<string, string | null>;
2414
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2415
+ PlayFabId: string;
2416
+ /** Name of the virtual currency which is to be decremented. */
2417
+ VirtualCurrency: string;
2418
+ }
2419
+ interface SubtractUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
2420
+ /** Amount to be subtracted from the user balance of the specified virtual currency. */
2421
+ Amount: number;
2422
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2423
+ CustomTags?: Record<string, string | null>;
2424
+ /** PlayFab unique identifier of the user whose virtual currency balance is to be decreased. */
2425
+ PlayFabId: string;
2426
+ /** Name of the virtual currency which is to be decremented. */
2427
+ VirtualCurrency: string;
2428
+ }
2429
+ interface TagModel {
2430
+ /** Full value of the tag, including namespace */
2431
+ TagValue?: string;
2432
+ }
2433
+ interface TitleNewsItem {
2434
+ /** News item body. */
2435
+ Body?: string;
2436
+ /** Unique identifier of news item. */
2437
+ NewsId?: string;
2438
+ /** Date and time when the news item was posted. */
2439
+ Timestamp: string;
2440
+ /** Title of the news item. */
2441
+ Title?: string;
2442
+ }
2443
+ interface TreatmentAssignment {
2444
+ /** List of the experiment variables. */
2445
+ Variables?: Variable[];
2446
+ /** List of the experiment variants. */
2447
+ Variants?: string[];
2448
+ }
2449
+ interface TwitchPlayFabIdPair {
2450
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Twitch identifier. */
2451
+ PlayFabId?: string;
2452
+ /** Unique Twitch identifier for a user. */
2453
+ TwitchId?: string;
2454
+ }
2455
+ interface UnlinkBattleNetAccountRequest extends IPlayFabRequestCommon {
2456
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2457
+ CustomTags?: Record<string, string | null>;
2458
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2459
+ PlayFabId: string;
2460
+ }
2461
+ interface UnlinkNintendoServiceAccountRequest extends IPlayFabRequestCommon {
2462
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2463
+ CustomTags?: Record<string, string | null>;
2464
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2465
+ PlayFabId: string;
2466
+ }
2467
+ interface UnlinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
2468
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2469
+ CustomTags?: Record<string, string | null>;
2470
+ /** Nintendo Switch Device identifier for the user. If not specified, the most recently signed in device ID will be used. */
2471
+ NintendoSwitchDeviceId?: string;
2472
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2473
+ PlayFabId: string;
2474
+ }
2475
+ interface UnlinkNintendoSwitchDeviceIdResult extends IPlayFabResultCommon {
2476
+ }
2477
+ interface UnlinkPSNAccountRequest extends IPlayFabRequestCommon {
2478
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2479
+ CustomTags?: Record<string, string | null>;
2480
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2481
+ PlayFabId: string;
2482
+ }
2483
+ interface UnlinkPSNAccountResult extends IPlayFabResultCommon {
2484
+ }
2485
+ interface UnlinkServerCustomIdRequest extends IPlayFabRequestCommon {
2486
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2487
+ CustomTags?: Record<string, string | null>;
2488
+ /** Unique PlayFab identifier. */
2489
+ PlayFabId: string;
2490
+ /** Unique server custom identifier for this player. */
2491
+ ServerCustomId: string;
2492
+ }
2493
+ interface UnlinkServerCustomIdResult extends IPlayFabResultCommon {
2494
+ }
2495
+ interface UnlinkSteamIdRequest extends IPlayFabRequestCommon {
2496
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2497
+ CustomTags?: Record<string, string | null>;
2498
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam account. */
2499
+ PlayFabId: string;
2500
+ }
2501
+ interface UnlinkSteamIdResult extends IPlayFabResultCommon {
2502
+ }
2503
+ interface UnlinkXboxAccountRequest extends IPlayFabRequestCommon {
2504
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2505
+ CustomTags?: Record<string, string | null>;
2506
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
2507
+ PlayFabId: string;
2508
+ }
2509
+ interface UnlinkXboxAccountResult extends IPlayFabResultCommon {
2510
+ }
2511
+ interface UnlockContainerInstanceRequest extends IPlayFabRequestCommon {
2512
+ /**
2513
+ * Specifies the catalog version that should be used to determine container contents. If unspecified, uses catalog
2514
+ * associated with the item instance.
2515
+ */
2516
+ CatalogVersion?: string;
2517
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2518
+ CharacterId?: string;
2519
+ /** ItemInstanceId of the container to unlock. */
2520
+ ContainerItemInstanceId: string;
2521
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2522
+ CustomTags?: Record<string, string | null>;
2523
+ /**
2524
+ * ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this
2525
+ * parameter is required.
2526
+ */
2527
+ KeyItemInstanceId?: string;
2528
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2529
+ PlayFabId: string;
2530
+ }
2531
+ interface UnlockContainerItemRequest extends IPlayFabRequestCommon {
2532
+ /**
2533
+ * Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary
2534
+ * catalog.
2535
+ */
2536
+ CatalogVersion?: string;
2537
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2538
+ CharacterId?: string;
2539
+ /** Catalog ItemId of the container type to unlock. */
2540
+ ContainerItemId: string;
2541
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2542
+ CustomTags?: Record<string, string | null>;
2543
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2544
+ PlayFabId: string;
2545
+ }
2546
+ interface UnlockContainerItemResult extends IPlayFabResultCommon {
2547
+ /** Items granted to the player as a result of unlocking the container. */
2548
+ GrantedItems?: ItemInstance[];
2549
+ /** Unique instance identifier of the container unlocked. */
2550
+ UnlockedItemInstanceId?: string;
2551
+ /** Unique instance identifier of the key used to unlock the container, if applicable. */
2552
+ UnlockedWithItemInstanceId?: string;
2553
+ /** Virtual currency granted to the player as a result of unlocking the container. */
2554
+ VirtualCurrency?: Record<string, number>;
2555
+ }
2556
+ interface UpdateAvatarUrlRequest extends IPlayFabRequestCommon {
2557
+ /** URL of the avatar image. If empty, it removes the existing avatar URL. */
2558
+ ImageUrl: string;
2559
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2560
+ PlayFabId: string;
2561
+ }
2562
+ interface UpdateBanRequest {
2563
+ /** The updated active state for the ban. Null for no change. */
2564
+ Active?: boolean;
2565
+ /** The id of the ban to be updated. */
2566
+ BanId: string;
2567
+ /** The updated expiration date for the ban. Null for no change. */
2568
+ Expires?: string;
2569
+ /** The updated IP address for the ban. Null for no change. */
2570
+ IPAddress?: string;
2571
+ /** Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. */
2572
+ Permanent?: boolean;
2573
+ /** The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. */
2574
+ Reason?: string;
2575
+ /** The updated family type of the user that should be included in the ban. Null for no change. */
2576
+ UserFamilyType?: string;
2577
+ }
2578
+ interface UpdateBansRequest extends IPlayFabRequestCommon {
2579
+ /** List of bans to be updated. Maximum 100. */
2580
+ Bans: UpdateBanRequest[];
2581
+ }
2582
+ interface UpdateBansResult extends IPlayFabResultCommon {
2583
+ /** Information on the bans that were updated */
2584
+ BanData?: BanInfo[];
2585
+ }
2586
+ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
2587
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2588
+ CharacterId: string;
2589
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2590
+ CustomTags?: Record<string, string | null>;
2591
+ /**
2592
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2593
+ * not begin with a '!' character or be null.
2594
+ */
2595
+ Data?: Record<string, string | null>;
2596
+ /**
2597
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2598
+ * constraints. Use this to delete the keys directly.
2599
+ */
2600
+ KeysToRemove?: string[];
2601
+ /** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
2602
+ Permission?: string;
2603
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2604
+ PlayFabId: string;
2605
+ }
2606
+ interface UpdateCharacterDataResult extends IPlayFabResultCommon {
2607
+ /**
2608
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
2609
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
2610
+ */
2611
+ DataVersion: number;
2612
+ }
2613
+ interface UpdateCharacterStatisticsRequest extends IPlayFabRequestCommon {
2614
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2615
+ CharacterId: string;
2616
+ /** Statistics to be updated with the provided values. */
2617
+ CharacterStatistics?: Record<string, number>;
2618
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2619
+ CustomTags?: Record<string, string | null>;
2620
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2621
+ PlayFabId: string;
2622
+ }
2623
+ interface UpdateCharacterStatisticsResult extends IPlayFabResultCommon {
2624
+ }
2625
+ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
2626
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2627
+ CustomTags?: Record<string, string | null>;
2628
+ /**
2629
+ * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the
2630
+ * player's properties have not been updated by any other clients since last the version.
2631
+ */
2632
+ ExpectedPropertiesVersion?: number;
2633
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2634
+ PlayFabId: string;
2635
+ /** Collection of properties to be set for a player. */
2636
+ Properties: UpdateProperty[];
2637
+ }
2638
+ interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
2639
+ /** PlayFab unique identifier of the user whose properties were updated. */
2640
+ PlayFabId?: string;
2641
+ /**
2642
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
2643
+ * deletes. This version can be provided in update and delete calls for concurrency control.
2644
+ */
2645
+ PropertiesVersion: number;
2646
+ }
2647
+ interface UpdatePlayerStatisticsRequest extends IPlayFabRequestCommon {
2648
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2649
+ CustomTags?: Record<string, string | null>;
2650
+ /**
2651
+ * Indicates whether the statistics provided should be set, regardless of the aggregation method set on the statistic.
2652
+ * Default is false.
2653
+ */
2654
+ ForceUpdate?: boolean;
2655
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2656
+ PlayFabId: string;
2657
+ /** Statistics to be updated with the provided values */
2658
+ Statistics: StatisticUpdate[];
2659
+ }
2660
+ interface UpdatePlayerStatisticsResult extends IPlayFabResultCommon {
2661
+ }
2662
+ interface UpdateProperty {
2663
+ /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */
2664
+ Name: string;
2665
+ /** Value of the custom property. Limited to booleans, numbers, and strings. */
2666
+ Value: any;
2667
+ }
2668
+ interface UpdateSharedGroupDataRequest extends IPlayFabRequestCommon {
2669
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2670
+ CustomTags?: Record<string, string | null>;
2671
+ /**
2672
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2673
+ * not begin with a '!' character or be null.
2674
+ */
2675
+ Data?: Record<string, string | null>;
2676
+ /**
2677
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2678
+ * constraints. Use this to delete the keys directly.
2679
+ */
2680
+ KeysToRemove?: string[];
2681
+ /** Permission to be applied to all user data keys in this request. */
2682
+ Permission?: string;
2683
+ /** Unique identifier for the shared group. */
2684
+ SharedGroupId: string;
2685
+ }
2686
+ interface UpdateSharedGroupDataResult extends IPlayFabResultCommon {
2687
+ }
2688
+ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
2689
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2690
+ CustomTags?: Record<string, string | null>;
2691
+ /**
2692
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2693
+ * not begin with a '!' character or be null.
2694
+ */
2695
+ Data?: Record<string, string | null>;
2696
+ /**
2697
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2698
+ * constraints. Use this to delete the keys directly.
2699
+ */
2700
+ KeysToRemove?: string[];
2701
+ /** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
2702
+ Permission?: string;
2703
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2704
+ PlayFabId: string;
2705
+ }
2706
+ interface UpdateUserDataResult extends IPlayFabResultCommon {
2707
+ /**
2708
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
2709
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
2710
+ */
2711
+ DataVersion: number;
2712
+ }
2713
+ interface UpdateUserInternalDataRequest extends IPlayFabRequestCommon {
2714
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2715
+ CustomTags?: Record<string, string | null>;
2716
+ /**
2717
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2718
+ * not begin with a '!' character or be null.
2719
+ */
2720
+ Data?: Record<string, string | null>;
2721
+ /**
2722
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2723
+ * constraints. Use this to delete the keys directly.
2724
+ */
2725
+ KeysToRemove?: string[];
2726
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2727
+ PlayFabId: string;
2728
+ }
2729
+ interface UpdateUserInventoryItemDataRequest extends IPlayFabRequestCommon {
2730
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2731
+ CharacterId?: string;
2732
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2733
+ CustomTags?: Record<string, string | null>;
2734
+ /**
2735
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
2736
+ * not begin with a '!' character or be null.
2737
+ */
2738
+ Data?: Record<string, string | null>;
2739
+ /** Unique PlayFab assigned instance identifier of the item */
2740
+ ItemInstanceId: string;
2741
+ /**
2742
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
2743
+ * constraints. Use this to delete the keys directly.
2744
+ */
2745
+ KeysToRemove?: string[];
2746
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
2747
+ PlayFabId: string;
2748
+ }
2749
+ interface UserAccountInfo {
2750
+ /** User Android device information, if an Android device has been linked */
2751
+ AndroidDeviceInfo?: UserAndroidDeviceInfo;
2752
+ /** Sign in with Apple account information, if an Apple account has been linked */
2753
+ AppleAccountInfo?: UserAppleIdInfo;
2754
+ /** Battle.net account information, if a Battle.net account has been linked */
2755
+ BattleNetAccountInfo?: UserBattleNetInfo;
2756
+ /** Timestamp indicating when the user account was created */
2757
+ Created: string;
2758
+ /** Custom ID information, if a custom ID has been assigned */
2759
+ CustomIdInfo?: UserCustomIdInfo;
2760
+ /** User Facebook information, if a Facebook account has been linked */
2761
+ FacebookInfo?: UserFacebookInfo;
2762
+ /** Facebook Instant Games account information, if a Facebook Instant Games account has been linked */
2763
+ FacebookInstantGamesIdInfo?: UserFacebookInstantGamesIdInfo;
2764
+ /** User Gamecenter information, if a Gamecenter account has been linked */
2765
+ GameCenterInfo?: UserGameCenterInfo;
2766
+ /** User Google account information, if a Google account has been linked */
2767
+ GoogleInfo?: UserGoogleInfo;
2768
+ /** User Google Play Games account information, if a Google Play Games account has been linked */
2769
+ GooglePlayGamesInfo?: UserGooglePlayGamesInfo;
2770
+ /** User iOS device information, if an iOS device has been linked */
2771
+ IosDeviceInfo?: UserIosDeviceInfo;
2772
+ /** User Kongregate account information, if a Kongregate account has been linked */
2773
+ KongregateInfo?: UserKongregateInfo;
2774
+ /** Nintendo Switch account information, if a Nintendo Switch account has been linked */
2775
+ NintendoSwitchAccountInfo?: UserNintendoSwitchAccountIdInfo;
2776
+ /** Nintendo Switch device information, if a Nintendo Switch device has been linked */
2777
+ NintendoSwitchDeviceIdInfo?: UserNintendoSwitchDeviceIdInfo;
2778
+ /** OpenID Connect information, if any OpenID Connect accounts have been linked */
2779
+ OpenIdInfo?: UserOpenIdInfo[];
2780
+ /** Unique identifier for the user account */
2781
+ PlayFabId?: string;
2782
+ /** Personal information for the user which is considered more sensitive */
2783
+ PrivateInfo?: UserPrivateAccountInfo;
2784
+ /** User PlayStation :tm: Network account information, if a PlayStation :tm: Network account has been linked */
2785
+ PsnInfo?: UserPsnInfo;
2786
+ /** Server Custom ID information, if a server custom ID has been assigned */
2787
+ ServerCustomIdInfo?: UserServerCustomIdInfo;
2788
+ /** User Steam information, if a Steam account has been linked */
2789
+ SteamInfo?: UserSteamInfo;
2790
+ /** Title-specific information for the user account */
2791
+ TitleInfo?: UserTitleInfo;
2792
+ /** User Twitch account information, if a Twitch account has been linked */
2793
+ TwitchInfo?: UserTwitchInfo;
2794
+ /** User account name in the PlayFab service */
2795
+ Username?: string;
2796
+ /** User XBox account information, if a XBox account has been linked */
2797
+ XboxInfo?: UserXboxInfo;
2798
+ }
2799
+ interface UserAndroidDeviceInfo {
2800
+ /** Android device ID */
2801
+ AndroidDeviceId?: string;
2802
+ }
2803
+ interface UserAppleIdInfo {
2804
+ /** Apple subject ID */
2805
+ AppleSubjectId?: string;
2806
+ }
2807
+ interface UserBattleNetInfo {
2808
+ /** Battle.net identifier */
2809
+ BattleNetAccountId?: string;
2810
+ /** Battle.net display name */
2811
+ BattleNetBattleTag?: string;
2812
+ }
2813
+ interface UserCustomIdInfo {
2814
+ /** Custom ID */
2815
+ CustomId?: string;
2816
+ }
2817
+ interface UserDataRecord {
2818
+ /** Timestamp for when this data was last updated. */
2819
+ LastUpdated: string;
2820
+ /**
2821
+ * Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData
2822
+ * requests being made by one player about another player.
2823
+ */
2824
+ Permission?: string;
2825
+ /** Data stored for the specified user data key. */
2826
+ Value?: string;
2827
+ }
2828
+ interface UserFacebookInfo {
2829
+ /** Facebook identifier */
2830
+ FacebookId?: string;
2831
+ /** Facebook full name */
2832
+ FullName?: string;
2833
+ }
2834
+ interface UserFacebookInstantGamesIdInfo {
2835
+ /** Facebook Instant Games ID */
2836
+ FacebookInstantGamesId?: string;
2837
+ }
2838
+ interface UserGameCenterInfo {
2839
+ /** Gamecenter identifier */
2840
+ GameCenterId?: string;
2841
+ }
2842
+ interface UserGoogleInfo {
2843
+ /** Email address of the Google account */
2844
+ GoogleEmail?: string;
2845
+ /** Gender information of the Google account */
2846
+ GoogleGender?: string;
2847
+ /** Google ID */
2848
+ GoogleId?: string;
2849
+ /** Locale of the Google account */
2850
+ GoogleLocale?: string;
2851
+ /** Name of the Google account user */
2852
+ GoogleName?: string;
2853
+ }
2854
+ interface UserGooglePlayGamesInfo {
2855
+ /** Avatar image url of the Google Play Games player */
2856
+ GooglePlayGamesPlayerAvatarImageUrl?: string;
2857
+ /** Display name of the Google Play Games player */
2858
+ GooglePlayGamesPlayerDisplayName?: string;
2859
+ /** Google Play Games player ID */
2860
+ GooglePlayGamesPlayerId?: string;
2861
+ }
2862
+ interface UserIosDeviceInfo {
2863
+ /** iOS device ID */
2864
+ IosDeviceId?: string;
2865
+ }
2866
+ interface UserKongregateInfo {
2867
+ /** Kongregate ID */
2868
+ KongregateId?: string;
2869
+ /** Kongregate Username */
2870
+ KongregateName?: string;
2871
+ }
2872
+ interface UserNintendoSwitchAccountIdInfo {
2873
+ /** Nintendo Switch account subject ID */
2874
+ NintendoSwitchAccountSubjectId?: string;
2875
+ }
2876
+ interface UserNintendoSwitchDeviceIdInfo {
2877
+ /** Nintendo Switch Device ID */
2878
+ NintendoSwitchDeviceId?: string;
2879
+ }
2880
+ interface UserOpenIdInfo {
2881
+ /** OpenID Connection ID */
2882
+ ConnectionId?: string;
2883
+ /** OpenID Issuer */
2884
+ Issuer?: string;
2885
+ /** OpenID Subject */
2886
+ Subject?: string;
2887
+ }
2888
+ interface UserPrivateAccountInfo {
2889
+ /** user email address */
2890
+ Email?: string;
2891
+ }
2892
+ interface UserPsnInfo {
2893
+ /** PlayStation :tm: Network account ID */
2894
+ PsnAccountId?: string;
2895
+ /** PlayStation :tm: Network online ID */
2896
+ PsnOnlineId?: string;
2897
+ }
2898
+ interface UserServerCustomIdInfo {
2899
+ /** Custom ID */
2900
+ CustomId?: string;
2901
+ }
2902
+ interface UserSettings {
2903
+ /** Boolean for whether this player is eligible for gathering device info. */
2904
+ GatherDeviceInfo: boolean;
2905
+ /** Boolean for whether this player should report OnFocus play-time tracking. */
2906
+ GatherFocusInfo: boolean;
2907
+ /** Boolean for whether this player is eligible for ad tracking. */
2908
+ NeedsAttribution: boolean;
2909
+ }
2910
+ interface UserSteamInfo {
2911
+ /** what stage of game ownership the user is listed as being in, from Steam */
2912
+ SteamActivationStatus?: string;
2913
+ /** the country in which the player resides, from Steam data */
2914
+ SteamCountry?: string;
2915
+ /** currency type set in the user Steam account */
2916
+ SteamCurrency?: string;
2917
+ /** Steam identifier */
2918
+ SteamId?: string;
2919
+ /** Steam display name */
2920
+ SteamName?: string;
2921
+ }
2922
+ interface UserTitleInfo {
2923
+ /** URL to the player's avatar. */
2924
+ AvatarUrl?: string;
2925
+ /**
2926
+ * timestamp indicating when the user was first associated with this game (this can differ significantly from when the user
2927
+ * first registered with PlayFab)
2928
+ */
2929
+ Created: string;
2930
+ /** name of the user, as it is displayed in-game */
2931
+ DisplayName?: string;
2932
+ /**
2933
+ * timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other
2934
+ * events, such as issuing a beta key to the user, can associate the title to the user)
2935
+ */
2936
+ FirstLogin?: string;
2937
+ /** boolean indicating whether or not the user is currently banned for a title */
2938
+ isBanned?: boolean;
2939
+ /** timestamp for the last user login for this title */
2940
+ LastLogin?: string;
2941
+ /** source by which the user first joined the game, if known */
2942
+ Origination?: string;
2943
+ /** Title player account entity for this user */
2944
+ TitlePlayerAccount?: EntityKey;
2945
+ }
2946
+ interface UserTwitchInfo {
2947
+ /** Twitch ID */
2948
+ TwitchId?: string;
2949
+ /** Twitch Username */
2950
+ TwitchUserName?: string;
2951
+ }
2952
+ interface UserXboxInfo {
2953
+ /** XBox user ID */
2954
+ XboxUserId?: string;
2955
+ /** XBox user sandbox */
2956
+ XboxUserSandbox?: string;
2957
+ }
2958
+ interface ValueToDateModel {
2959
+ /** ISO 4217 code of the currency used in the purchases */
2960
+ Currency?: string;
2961
+ /**
2962
+ * Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
2963
+ * ninety-nine cents when Currency is 'USD')
2964
+ */
2965
+ TotalValue: number;
2966
+ /**
2967
+ * Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
2968
+ * dollars and ninety-nine cents when Currency is 'USD'.
2969
+ */
2970
+ TotalValueAsDecimal?: string;
2971
+ }
2972
+ interface Variable {
2973
+ /** Name of the variable. */
2974
+ Name: string;
2975
+ /** Value of the variable. */
2976
+ Value?: string;
2977
+ }
2978
+ interface VirtualCurrencyRechargeTime {
2979
+ /**
2980
+ * Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value
2981
+ * through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen
2982
+ * below this value.
2983
+ */
2984
+ RechargeMax: number;
2985
+ /** Server timestamp in UTC indicating the next time the virtual currency will be incremented. */
2986
+ RechargeTime: string;
2987
+ /** Time remaining (in seconds) before the next recharge increment of the virtual currency. */
2988
+ SecondsToRecharge: number;
2989
+ }
2990
+ interface WriteEventResponse extends IPlayFabResultCommon {
2991
+ /**
2992
+ * The unique identifier of the event. The values of this identifier consist of ASCII characters and are not constrained to
2993
+ * any particular format.
2994
+ */
2995
+ EventId?: string;
2996
+ }
2997
+ interface WriteServerCharacterEventRequest extends IPlayFabRequestCommon {
2998
+ /** Custom event properties. Each property consists of a name (string) and a value (JSON object). */
2999
+ Body?: Record<string, any>;
3000
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
3001
+ CharacterId: string;
3002
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3003
+ CustomTags?: Record<string, string | null>;
3004
+ /**
3005
+ * The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it
3006
+ * commonly follows the subject_verb_object pattern (e.g. player_logged_in).
3007
+ */
3008
+ EventName: string;
3009
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
3010
+ PlayFabId: string;
3011
+ /** The time (in UTC) associated with this event. The value defaults to the current time. */
3012
+ Timestamp?: string;
3013
+ }
3014
+ interface WriteServerPlayerEventRequest extends IPlayFabRequestCommon {
3015
+ /** Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object). */
3016
+ Body?: Record<string, any>;
3017
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3018
+ CustomTags?: Record<string, string | null>;
3019
+ /**
3020
+ * The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it
3021
+ * commonly follows the subject_verb_object pattern (e.g. player_logged_in).
3022
+ */
3023
+ EventName: string;
3024
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
3025
+ PlayFabId: string;
3026
+ /** The time (in UTC) associated with this event. The value defaults to the current time. */
3027
+ Timestamp?: string;
3028
+ }
3029
+ interface WriteTitleEventRequest extends IPlayFabRequestCommon {
3030
+ /** Custom event properties. Each property consists of a name (string) and a value (JSON object). */
3031
+ Body?: Record<string, any>;
3032
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3033
+ CustomTags?: Record<string, string | null>;
3034
+ /**
3035
+ * The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it
3036
+ * commonly follows the subject_verb_object pattern (e.g. player_logged_in).
3037
+ */
3038
+ EventName: string;
3039
+ /** The time (in UTC) associated with this event. The value defaults to the current time. */
3040
+ Timestamp?: string;
3041
+ }
3042
+ interface XboxLiveAccountPlayFabIdPair {
3043
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
3044
+ PlayFabId?: string;
3045
+ /** Unique Xbox Live identifier for a user. */
3046
+ XboxLiveAccountId?: string;
3047
+ }
3048
+
3049
+ declare class PlayFabServerApi extends PlayFabCommon {
3050
+ /**
3051
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3052
+ * version 2._ Increments the character's balance of the specified virtual currency by the stated amount
3053
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency
3054
+ */
3055
+ AddCharacterVirtualCurrency(request: AddCharacterVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
3056
+ /**
3057
+ * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
3058
+ * FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
3059
+ * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend
3060
+ */
3061
+ AddFriend(request: AddFriendRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3062
+ /**
3063
+ * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
3064
+ * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
3065
+ * authentication credentials, as the intent is that it is easily accessible by other players.
3066
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid
3067
+ */
3068
+ AddGenericID(request: AddGenericIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3069
+ /**
3070
+ * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
3071
+ * https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag
3072
+ */
3073
+ AddPlayerTag(request: AddPlayerTagRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
3074
+ /**
3075
+ * 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
3076
+ * in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small
3077
+ * number of players, please see our guide:
3078
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3079
+ * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers
3080
+ */
3081
+ AddSharedGroupMembers(request: AddSharedGroupMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
3082
+ /**
3083
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3084
+ * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
3085
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency
3086
+ */
3087
+ AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
3088
+ /**
3089
+ * Validated a client's session ticket, and if successful, returns details for that user
3090
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket
3091
+ */
3092
+ AuthenticateSessionTicket(request: AuthenticateSessionTicketRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AuthenticateSessionTicketResult>;
3093
+ /**
3094
+ * Awards the specified users the specified Steam achievements
3095
+ * https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement
3096
+ */
3097
+ AwardSteamAchievement(request: AwardSteamAchievementRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AwardSteamAchievementResult>;
3098
+ /**
3099
+ * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
3100
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers
3101
+ */
3102
+ BanUsers(request: BanUsersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
3103
+ /**
3104
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3105
+ * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
3106
+ * inventory.
3107
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem
3108
+ */
3109
+ ConsumeItem(request: ConsumeItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
3110
+ /**
3111
+ * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
3112
+ * group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data
3113
+ * between a very small number of players, please see our guide:
3114
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3115
+ * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup
3116
+ */
3117
+ CreateSharedGroup(request: CreateSharedGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
3118
+ /**
3119
+ * Deletes the specific character ID from the specified user.
3120
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser
3121
+ */
3122
+ DeleteCharacterFromUser(request: DeleteCharacterFromUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeleteCharacterFromUserResult>;
3123
+ /**
3124
+ * Removes a user's player account from a title and deletes all associated data
3125
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer
3126
+ */
3127
+ DeletePlayer(request: DeletePlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
3128
+ /**
3129
+ * Deletes title-specific custom properties for a player
3130
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties
3131
+ */
3132
+ DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
3133
+ /**
3134
+ * Deletes push notification template for title
3135
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate
3136
+ */
3137
+ DeletePushNotificationTemplate(request: DeletePushNotificationTemplateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePushNotificationTemplateResult>;
3138
+ /**
3139
+ * Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for
3140
+ * sharing data between a very small number of players, please see our guide:
3141
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3142
+ * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup
3143
+ */
3144
+ DeleteSharedGroup(request: DeleteSharedGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3145
+ /**
3146
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3147
+ * version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
3148
+ * have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to
3149
+ * UnlockContainer.
3150
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable
3151
+ */
3152
+ EvaluateRandomResultTable(request: EvaluateRandomResultTableRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EvaluateRandomResultTableResult>;
3153
+ /**
3154
+ * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
3155
+ * PlayFab ID is the entity ID of the player's master_player_account entity.
3156
+ * https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript
3157
+ */
3158
+ ExecuteCloudScript(request: ExecuteCloudScriptServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
3159
+ /**
3160
+ * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
3161
+ * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
3162
+ * https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments
3163
+ */
3164
+ GetAllSegments(request: GetAllSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
3165
+ /**
3166
+ * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
3167
+ * evaluated with the parent PlayFabId to guarantee uniqueness.
3168
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters
3169
+ */
3170
+ GetAllUsersCharacters(request: ListUsersCharactersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
3171
+ /**
3172
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3173
+ * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
3174
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems
3175
+ */
3176
+ GetCatalogItems(request: GetCatalogItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
3177
+ /**
3178
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
3179
+ * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata
3180
+ */
3181
+ GetCharacterData(request: GetCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3182
+ /**
3183
+ * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
3184
+ * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata
3185
+ */
3186
+ GetCharacterInternalData(request: GetCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3187
+ /**
3188
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3189
+ * version 2._ Retrieves the specified character's current inventory of virtual goods
3190
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory
3191
+ */
3192
+ GetCharacterInventory(request: GetCharacterInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
3193
+ /**
3194
+ * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
3195
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard
3196
+ */
3197
+ GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
3198
+ /**
3199
+ * Retrieves the title-specific custom data for the user's character which can only be read by the client
3200
+ * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata
3201
+ */
3202
+ GetCharacterReadOnlyData(request: GetCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3203
+ /**
3204
+ * Retrieves the details of all title-specific statistics for the specific character
3205
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics
3206
+ */
3207
+ GetCharacterStatistics(request: GetCharacterStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
3208
+ /**
3209
+ * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
3210
+ * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
3211
+ * content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
3212
+ * the query to retrieve the data will fail. See this post for more information:
3213
+ * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
3214
+ * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
3215
+ * https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl
3216
+ */
3217
+ GetContentDownloadUrl(request: GetContentDownloadUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
3218
+ /**
3219
+ * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
3220
+ * leaderboard
3221
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard
3222
+ */
3223
+ GetFriendLeaderboard(request: GetFriendLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
3224
+ /**
3225
+ * Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from
3226
+ * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
3227
+ * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist
3228
+ */
3229
+ GetFriendsList(request: GetFriendsListRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
3230
+ /**
3231
+ * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
3232
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard
3233
+ */
3234
+ GetLeaderboard(request: GetLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
3235
+ /**
3236
+ * Retrieves a list of ranked characters for the given statistic, centered on the requested user
3237
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter
3238
+ */
3239
+ GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
3240
+ /**
3241
+ * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
3242
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser
3243
+ */
3244
+ GetLeaderboardAroundUser(request: GetLeaderboardAroundUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundUserResult>;
3245
+ /**
3246
+ * Retrieves a list of all of the user's characters for the given statistic.
3247
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters
3248
+ */
3249
+ GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
3250
+ /**
3251
+ * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
3252
+ * returned. All parameters default to false.
3253
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo
3254
+ */
3255
+ GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
3256
+ /**
3257
+ * Retrieves a title-specific custom property value for a player.
3258
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty
3259
+ */
3260
+ GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
3261
+ /**
3262
+ * Retrieves the player's profile
3263
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile
3264
+ */
3265
+ GetPlayerProfile(request: GetPlayerProfileRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
3266
+ /**
3267
+ * List all segments that a player currently belongs to at this moment in time.
3268
+ * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments
3269
+ */
3270
+ GetPlayerSegments(request: GetPlayersSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
3271
+ /**
3272
+ * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match
3273
+ * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span
3274
+ * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
3275
+ * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
3276
+ * called 30 times in one minute. You will be returned an error if you exceed this threshold.
3277
+ * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment
3278
+ */
3279
+ GetPlayersInSegment(request: GetPlayersInSegmentRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
3280
+ /**
3281
+ * Retrieves the current version and values for the indicated statistics, for the local player.
3282
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics
3283
+ */
3284
+ GetPlayerStatistics(request: GetPlayerStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
3285
+ /**
3286
+ * Retrieves the information on the available versions of the specified statistic.
3287
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions
3288
+ */
3289
+ GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
3290
+ /**
3291
+ * Get all tags with a given Namespace (optional) from a player profile.
3292
+ * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags
3293
+ */
3294
+ GetPlayerTags(request: GetPlayerTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
3295
+ /**
3296
+ * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
3297
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids
3298
+ */
3299
+ GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
3300
+ /**
3301
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
3302
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids
3303
+ */
3304
+ GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
3305
+ /**
3306
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.
3307
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids
3308
+ */
3309
+ GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
3310
+ /**
3311
+ * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
3312
+ * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
3313
+ * added to the player account.
3314
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids
3315
+ */
3316
+ GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
3317
+ /**
3318
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
3319
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids
3320
+ */
3321
+ GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
3322
+ /**
3323
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
3324
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids
3325
+ */
3326
+ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
3327
+ /**
3328
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
3329
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids
3330
+ */
3331
+ GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
3332
+ /**
3333
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
3334
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids
3335
+ */
3336
+ GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
3337
+ /**
3338
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
3339
+ * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
3340
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids
3341
+ */
3342
+ GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
3343
+ /**
3344
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
3345
+ * names.
3346
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames
3347
+ */
3348
+ GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
3349
+ /**
3350
+ * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
3351
+ * the user accounts, available as "_id" from the Twitch API methods (ex:
3352
+ * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
3353
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids
3354
+ */
3355
+ GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
3356
+ /**
3357
+ * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
3358
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids
3359
+ */
3360
+ GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
3361
+ /**
3362
+ * Retrieves the key-value store of custom publisher settings
3363
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata
3364
+ */
3365
+ GetPublisherData(request: GetPublisherDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
3366
+ /**
3367
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3368
+ * version 2._ Retrieves the configuration information for the specified random results tables for the title, including all
3369
+ * ItemId values and weights
3370
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables
3371
+ */
3372
+ GetRandomResultTables(request: GetRandomResultTablesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
3373
+ /**
3374
+ * Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
3375
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids
3376
+ */
3377
+ GetServerCustomIDsFromPlayFabIDs(request: GetServerCustomIDsFromPlayFabIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetServerCustomIDsFromPlayFabIDsResult>;
3378
+ /**
3379
+ * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
3380
+ * public and private group data. Shared Groups are designed for sharing data between a very small number of players,
3381
+ * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3382
+ * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata
3383
+ */
3384
+ GetSharedGroupData(request: GetSharedGroupDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
3385
+ /**
3386
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3387
+ * version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified
3388
+ * player
3389
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems
3390
+ */
3391
+ GetStoreItems(request: GetStoreItemsServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
3392
+ /**
3393
+ * Retrieves the current server time
3394
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime
3395
+ */
3396
+ GetTime(request: GetTimeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
3397
+ /**
3398
+ * Retrieves the key-value store of custom title settings
3399
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata
3400
+ */
3401
+ GetTitleData(request: GetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
3402
+ /**
3403
+ * Retrieves the key-value store of custom internal title settings
3404
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata
3405
+ */
3406
+ GetTitleInternalData(request: GetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
3407
+ /**
3408
+ * Retrieves the title news feed, as configured in the developer portal
3409
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews
3410
+ */
3411
+ GetTitleNews(request: GetTitleNewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
3412
+ /**
3413
+ * Retrieves the relevant details for a specified user
3414
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo
3415
+ */
3416
+ GetUserAccountInfo(request: GetUserAccountInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserAccountInfoResult>;
3417
+ /**
3418
+ * Gets all bans for a user.
3419
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans
3420
+ */
3421
+ GetUserBans(request: GetUserBansRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
3422
+ /**
3423
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
3424
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata
3425
+ */
3426
+ GetUserData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3427
+ /**
3428
+ * Retrieves the title-specific custom data for the user which cannot be accessed by the client
3429
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata
3430
+ */
3431
+ GetUserInternalData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3432
+ /**
3433
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3434
+ * version 2._ Retrieves the specified user's current inventory of virtual goods
3435
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory
3436
+ */
3437
+ GetUserInventory(request: GetUserInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
3438
+ /**
3439
+ * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
3440
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata
3441
+ */
3442
+ GetUserPublisherData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3443
+ /**
3444
+ * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
3445
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata
3446
+ */
3447
+ GetUserPublisherInternalData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3448
+ /**
3449
+ * Retrieves the publisher-specific custom data for the user which can only be read by the client
3450
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata
3451
+ */
3452
+ GetUserPublisherReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3453
+ /**
3454
+ * Retrieves the title-specific custom data for the user which can only be read by the client
3455
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata
3456
+ */
3457
+ GetUserReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3458
+ /**
3459
+ * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
3460
+ * with the parent PlayFabId to guarantee uniqueness.
3461
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser
3462
+ */
3463
+ GrantCharacterToUser(request: GrantCharacterToUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
3464
+ /**
3465
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3466
+ * version 2._ Adds the specified items to the specified character's inventory
3467
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter
3468
+ */
3469
+ GrantItemsToCharacter(request: GrantItemsToCharacterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantItemsToCharacterResult>;
3470
+ /**
3471
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3472
+ * version 2._ Adds the specified items to the specified user's inventory
3473
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser
3474
+ */
3475
+ GrantItemsToUser(request: GrantItemsToUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantItemsToUserResult>;
3476
+ /**
3477
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3478
+ * version 2._ Adds the specified items to the specified user inventories
3479
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers
3480
+ */
3481
+ GrantItemsToUsers(request: GrantItemsToUsersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
3482
+ /**
3483
+ * Links the Battle.net account associated with the token to the user's PlayFab account.
3484
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount
3485
+ */
3486
+ LinkBattleNetAccount(request: LinkBattleNetAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3487
+ /**
3488
+ * Links the Nintendo account associated with the token to the user's PlayFab account
3489
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount
3490
+ */
3491
+ LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3492
+ /**
3493
+ * Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
3494
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject
3495
+ */
3496
+ LinkNintendoServiceAccountSubject(request: LinkNintendoServiceAccountSubjectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3497
+ /**
3498
+ * Links the NintendoSwitchDeviceId to the user's PlayFab account
3499
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid
3500
+ */
3501
+ LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
3502
+ /**
3503
+ * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
3504
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount
3505
+ */
3506
+ LinkPSNAccount(request: LinkPSNAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
3507
+ /**
3508
+ * Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
3509
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid
3510
+ */
3511
+ LinkPSNId(request: LinkPSNIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkPSNIdResponse>;
3512
+ /**
3513
+ * Links the custom server identifier, generated by the title, to the user's PlayFab account.
3514
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid
3515
+ */
3516
+ LinkServerCustomId(request: LinkServerCustomIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkServerCustomIdResult>;
3517
+ /**
3518
+ * Links the Steam account associated with the provided Steam ID to the user's PlayFab account
3519
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid
3520
+ */
3521
+ LinkSteamId(request: LinkSteamIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkSteamIdResult>;
3522
+ /**
3523
+ * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
3524
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount
3525
+ */
3526
+ LinkXboxAccount(request: LinkXboxAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
3527
+ /**
3528
+ * Retrieves title-specific custom property values for a player.
3529
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties
3530
+ */
3531
+ ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
3532
+ /**
3533
+ * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
3534
+ * API calls which require an authenticated user
3535
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid
3536
+ */
3537
+ LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3538
+ /**
3539
+ * Sign in the user with a Battle.net identity token
3540
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet
3541
+ */
3542
+ LoginWithBattleNet(request: LoginWithBattleNetRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3543
+ /**
3544
+ * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
3545
+ * subsequently be used for API calls which require an authenticated user
3546
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid
3547
+ */
3548
+ LoginWithCustomID(request: LoginWithCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3549
+ /**
3550
+ * Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API
3551
+ * calls which require an authenticated user
3552
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid
3553
+ */
3554
+ LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3555
+ /**
3556
+ * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
3557
+ * subsequently be used for API calls which require an authenticated user
3558
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn
3559
+ */
3560
+ LoginWithPSN(request: LoginWithPSNRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3561
+ /**
3562
+ * Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
3563
+ * and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
3564
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid
3565
+ */
3566
+ LoginWithServerCustomId(request: LoginWithServerCustomIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3567
+ /**
3568
+ * Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which
3569
+ * require an authenticated user
3570
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid
3571
+ */
3572
+ LoginWithSteamId(request: LoginWithSteamIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3573
+ /**
3574
+ * Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
3575
+ * subsequently be used for API calls which require an authenticated user
3576
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox
3577
+ */
3578
+ LoginWithXbox(request: LoginWithXboxRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3579
+ /**
3580
+ * Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API
3581
+ * calls which require an authenticated user
3582
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid
3583
+ */
3584
+ LoginWithXboxId(request: LoginWithXboxIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
3585
+ /**
3586
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3587
+ * version 2._ Modifies the number of remaining uses of a player's inventory item
3588
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses
3589
+ */
3590
+ ModifyItemUses(request: ModifyItemUsesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyItemUsesResult>;
3591
+ /**
3592
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3593
+ * version 2._ Moves an item from a character's inventory into another of the users's character's inventory.
3594
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter
3595
+ */
3596
+ MoveItemToCharacterFromCharacter(request: MoveItemToCharacterFromCharacterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromCharacterResult>;
3597
+ /**
3598
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3599
+ * version 2._ Moves an item from a user's inventory into their character's inventory.
3600
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser
3601
+ */
3602
+ MoveItemToCharacterFromUser(request: MoveItemToCharacterFromUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromUserResult>;
3603
+ /**
3604
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3605
+ * version 2._ Moves an item from a character's inventory into the owning user's inventory.
3606
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter
3607
+ */
3608
+ MoveItemToUserFromCharacter(request: MoveItemToUserFromCharacterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<MoveItemToUserFromCharacterResult>;
3609
+ /**
3610
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3611
+ * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
3612
+ * Economy->Catalogs tab in the PlayFab Game Manager.
3613
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon
3614
+ */
3615
+ RedeemCoupon(request: RedeemCouponRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
3616
+ /**
3617
+ * Removes the specified friend from the the user's friend list
3618
+ * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend
3619
+ */
3620
+ RemoveFriend(request: RemoveFriendRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3621
+ /**
3622
+ * Removes the specified generic service identifier from the player's PlayFab account.
3623
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid
3624
+ */
3625
+ RemoveGenericID(request: RemoveGenericIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3626
+ /**
3627
+ * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
3628
+ * https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag
3629
+ */
3630
+ RemovePlayerTag(request: RemovePlayerTagRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
3631
+ /**
3632
+ * 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
3633
+ * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
3634
+ * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
3635
+ * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3636
+ * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers
3637
+ */
3638
+ RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
3639
+ /**
3640
+ * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service
3641
+ * representatives for the title can take action concerning potentially toxic players.
3642
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer
3643
+ */
3644
+ ReportPlayer(request: ReportPlayerServerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportPlayerServerResult>;
3645
+ /**
3646
+ * Revoke all active bans for a user.
3647
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser
3648
+ */
3649
+ RevokeAllBansForUser(request: RevokeAllBansForUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
3650
+ /**
3651
+ * Revoke all active bans specified with BanId.
3652
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans
3653
+ */
3654
+ RevokeBans(request: RevokeBansRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
3655
+ /**
3656
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3657
+ * version 2._ Revokes access to an item in a user's inventory
3658
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem
3659
+ */
3660
+ RevokeInventoryItem(request: RevokeInventoryItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
3661
+ /**
3662
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3663
+ * version 2._ Revokes access for up to 25 items across multiple users and characters.
3664
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems
3665
+ */
3666
+ RevokeInventoryItems(request: RevokeInventoryItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
3667
+ /**
3668
+ * Saves push notification template for title
3669
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate
3670
+ */
3671
+ SavePushNotificationTemplate(request: SavePushNotificationTemplateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SavePushNotificationTemplateResult>;
3672
+ /**
3673
+ * Forces an email to be sent to the registered contact email address for the user's account based on an account recovery
3674
+ * email template
3675
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail
3676
+ */
3677
+ SendCustomAccountRecoveryEmail(request: SendCustomAccountRecoveryEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendCustomAccountRecoveryEmailResult>;
3678
+ /**
3679
+ * Sends an email based on an email template to a player's contact email
3680
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate
3681
+ */
3682
+ SendEmailFromTemplate(request: SendEmailFromTemplateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendEmailFromTemplateResult>;
3683
+ /**
3684
+ * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push
3685
+ * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
3686
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification
3687
+ */
3688
+ SendPushNotification(request: SendPushNotificationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
3689
+ /**
3690
+ * Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push
3691
+ * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
3692
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate
3693
+ */
3694
+ SendPushNotificationFromTemplate(request: SendPushNotificationFromTemplateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
3695
+ /**
3696
+ * Updates the tag list for a specified user in the friend list of another user
3697
+ * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags
3698
+ */
3699
+ SetFriendTags(request: SetFriendTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3700
+ /**
3701
+ * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
3702
+ * secret use the Admin or Server API method SetPlayerSecret.
3703
+ * https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret
3704
+ */
3705
+ SetPlayerSecret(request: SetPlayerSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
3706
+ /**
3707
+ * Updates the key-value store of custom publisher settings
3708
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata
3709
+ */
3710
+ SetPublisherData(request: SetPublisherDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
3711
+ /**
3712
+ * Updates the key-value store of custom title settings
3713
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata
3714
+ */
3715
+ SetTitleData(request: SetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
3716
+ /**
3717
+ * Updates the key-value store of custom title settings
3718
+ * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata
3719
+ */
3720
+ SetTitleInternalData(request: SetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
3721
+ /**
3722
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3723
+ * version 2._ Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to
3724
+ * make a VC balance negative with this API.
3725
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency
3726
+ */
3727
+ SubtractCharacterVirtualCurrency(request: SubtractCharacterVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
3728
+ /**
3729
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3730
+ * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
3731
+ * a VC balance negative with this API.
3732
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency
3733
+ */
3734
+ SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
3735
+ /**
3736
+ * Unlinks the related Battle.net account from the user's PlayFab account.
3737
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount
3738
+ */
3739
+ UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3740
+ /**
3741
+ * Unlinks the related Nintendo account from the user's PlayFab account
3742
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount
3743
+ */
3744
+ UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3745
+ /**
3746
+ * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
3747
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid
3748
+ */
3749
+ UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
3750
+ /**
3751
+ * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
3752
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount
3753
+ */
3754
+ UnlinkPSNAccount(request: UnlinkPSNAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
3755
+ /**
3756
+ * Unlinks the custom server identifier from the user's PlayFab account.
3757
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid
3758
+ */
3759
+ UnlinkServerCustomId(request: UnlinkServerCustomIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkServerCustomIdResult>;
3760
+ /**
3761
+ * Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account
3762
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid
3763
+ */
3764
+ UnlinkSteamId(request: UnlinkSteamIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkSteamIdResult>;
3765
+ /**
3766
+ * Unlinks the related Xbox Live account from the user's PlayFab account
3767
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount
3768
+ */
3769
+ UnlinkXboxAccount(request: UnlinkXboxAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
3770
+ /**
3771
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3772
+ * version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when
3773
+ * required), and returns the contents of the opened container. If the container (and key when relevant) are consumable
3774
+ * (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
3775
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance
3776
+ */
3777
+ UnlockContainerInstance(request: UnlockContainerInstanceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
3778
+ /**
3779
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3780
+ * version 2._ Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary
3781
+ * unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when
3782
+ * relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of
3783
+ * ConsumeItem.
3784
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem
3785
+ */
3786
+ UnlockContainerItem(request: UnlockContainerItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
3787
+ /**
3788
+ * Update the avatar URL of the specified player
3789
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl
3790
+ */
3791
+ UpdateAvatarUrl(request: UpdateAvatarUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3792
+ /**
3793
+ * Updates information of a list of existing bans specified with Ban Ids.
3794
+ * https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans
3795
+ */
3796
+ UpdateBans(request: UpdateBansRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
3797
+ /**
3798
+ * Updates the title-specific custom data for the user's character which is readable and writable by the client
3799
+ * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata
3800
+ */
3801
+ UpdateCharacterData(request: UpdateCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
3802
+ /**
3803
+ * Updates the title-specific custom data for the user's character which cannot be accessed by the client
3804
+ * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata
3805
+ */
3806
+ UpdateCharacterInternalData(request: UpdateCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
3807
+ /**
3808
+ * Updates the title-specific custom data for the user's character which can only be read by the client
3809
+ * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata
3810
+ */
3811
+ UpdateCharacterReadOnlyData(request: UpdateCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
3812
+ /**
3813
+ * Updates the values of the specified title-specific statistics for the specific character
3814
+ * https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics
3815
+ */
3816
+ UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
3817
+ /**
3818
+ * Updates the title-specific custom property values for a player
3819
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties
3820
+ */
3821
+ UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
3822
+ /**
3823
+ * Updates the values of the specified title-specific statistics for the user
3824
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics
3825
+ */
3826
+ UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
3827
+ /**
3828
+ * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
3829
+ * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
3830
+ * Regardless of the permission setting, only members of the group (and the server) can update the data. Shared Groups are
3831
+ * designed for sharing data between a very small number of players, please see our guide:
3832
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3833
+ * https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata
3834
+ */
3835
+ UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
3836
+ /**
3837
+ * Updates the title-specific custom data for the user which is readable and writable by the client
3838
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata
3839
+ */
3840
+ UpdateUserData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3841
+ /**
3842
+ * Updates the title-specific custom data for the user which cannot be accessed by the client
3843
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata
3844
+ */
3845
+ UpdateUserInternalData(request: UpdateUserInternalDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3846
+ /**
3847
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3848
+ * version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.
3849
+ * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata
3850
+ */
3851
+ UpdateUserInventoryItemCustomData(request: UpdateUserInventoryItemDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3852
+ /**
3853
+ * Updates the publisher-specific custom data for the user which is readable and writable by the client
3854
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata
3855
+ */
3856
+ UpdateUserPublisherData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3857
+ /**
3858
+ * Updates the publisher-specific custom data for the user which cannot be accessed by the client
3859
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata
3860
+ */
3861
+ UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3862
+ /**
3863
+ * Updates the publisher-specific custom data for the user which can only be read by the client
3864
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata
3865
+ */
3866
+ UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3867
+ /**
3868
+ * Updates the title-specific custom data for the user which can only be read by the client
3869
+ * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata
3870
+ */
3871
+ UpdateUserReadOnlyData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
3872
+ /**
3873
+ * Writes a character-based event into PlayStream.
3874
+ * https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent
3875
+ */
3876
+ WriteCharacterEvent(request: WriteServerCharacterEventRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
3877
+ /**
3878
+ * Writes a player-based event into PlayStream.
3879
+ * https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent
3880
+ */
3881
+ WritePlayerEvent(request: WriteServerPlayerEventRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
3882
+ /**
3883
+ * Writes a title-based event into PlayStream.
3884
+ * https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent
3885
+ */
3886
+ WriteTitleEvent(request: WriteTitleEventRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
3887
+ }
3888
+
3889
+ export { PlayFabServerApi as default };