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,4482 @@
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
2
+
3
+ interface AcceptTradeRequest extends IPlayFabRequestCommon {
4
+ /**
5
+ * Items from the accepting player's inventory in exchange for the offered items in the trade. In the case of a gift, this
6
+ * will be null.
7
+ */
8
+ AcceptedInventoryInstanceIds?: string[];
9
+ /** Player who opened the trade. */
10
+ OfferingPlayerId: string;
11
+ /** Trade identifier. */
12
+ TradeId: string;
13
+ }
14
+ interface AcceptTradeResponse extends IPlayFabResultCommon {
15
+ /** Details about trade which was just accepted. */
16
+ Trade?: TradeInfo;
17
+ }
18
+ interface AdCampaignAttributionModel {
19
+ /** UTC time stamp of attribution */
20
+ AttributedAt: string;
21
+ /** Attribution campaign identifier */
22
+ CampaignId?: string;
23
+ /** Attribution network name */
24
+ Platform?: string;
25
+ }
26
+ interface AddFriendRequest extends IPlayFabRequestCommon {
27
+ /** Email address of the user to attempt to add to the local user's friend list. */
28
+ FriendEmail?: string;
29
+ /** PlayFab identifier of the user to attempt to add to the local user's friend list. */
30
+ FriendPlayFabId?: string;
31
+ /** Title-specific display name of the user to attempt to add to the local user's friend list. */
32
+ FriendTitleDisplayName?: string;
33
+ /** PlayFab username of the user to attempt to add to the local user's friend list. */
34
+ FriendUsername?: string;
35
+ }
36
+ interface AddFriendResult extends IPlayFabResultCommon {
37
+ /** True if the friend request was processed successfully. */
38
+ Created: boolean;
39
+ }
40
+ interface AddGenericIDRequest extends IPlayFabRequestCommon {
41
+ /** Generic service identifier to add to the player account. */
42
+ GenericId: GenericServiceId;
43
+ }
44
+ interface AddGenericIDResult extends IPlayFabResultCommon {
45
+ }
46
+ interface AddOrUpdateContactEmailRequest extends IPlayFabRequestCommon {
47
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
48
+ CustomTags?: Record<string, string | null>;
49
+ /** The new contact email to associate with the player. */
50
+ EmailAddress: string;
51
+ }
52
+ interface AddOrUpdateContactEmailResult extends IPlayFabResultCommon {
53
+ }
54
+ interface AddSharedGroupMembersRequest extends IPlayFabRequestCommon {
55
+ /** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
56
+ PlayFabIds: string[];
57
+ /** Unique identifier for the shared group. */
58
+ SharedGroupId: string;
59
+ }
60
+ interface AddSharedGroupMembersResult extends IPlayFabResultCommon {
61
+ }
62
+ interface AddUsernamePasswordRequest extends IPlayFabRequestCommon {
63
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
64
+ CustomTags?: Record<string, string | null>;
65
+ /** User email address attached to their account */
66
+ Email: string;
67
+ /** Password for the PlayFab account (6-100 characters) */
68
+ Password: string;
69
+ /** PlayFab username for the account (3-20 characters) */
70
+ Username: string;
71
+ }
72
+ interface AddUsernamePasswordResult extends IPlayFabResultCommon {
73
+ /** PlayFab unique user name. */
74
+ Username?: string;
75
+ }
76
+ interface AddUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
77
+ /** Amount to be added to the user balance of the specified virtual currency. */
78
+ Amount: number;
79
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
80
+ CustomTags?: Record<string, string | null>;
81
+ /** Name of the virtual currency which is to be incremented. */
82
+ VirtualCurrency: string;
83
+ }
84
+ interface AdPlacementDetails {
85
+ /** Placement unique ID */
86
+ PlacementId?: string;
87
+ /** Placement name */
88
+ PlacementName?: string;
89
+ /** If placement has viewing limits indicates how many views are left */
90
+ PlacementViewsRemaining?: number;
91
+ /** If placement has viewing limits indicates when they will next reset */
92
+ PlacementViewsResetMinutes?: number;
93
+ /** Optional URL to a reward asset */
94
+ RewardAssetUrl?: string;
95
+ /** Reward description */
96
+ RewardDescription?: string;
97
+ /** Reward unique ID */
98
+ RewardId?: string;
99
+ /** Reward name */
100
+ RewardName?: string;
101
+ }
102
+ interface AdRewardItemGranted {
103
+ /** Catalog ID */
104
+ CatalogId?: string;
105
+ /** Catalog item display name */
106
+ DisplayName?: string;
107
+ /** Inventory instance ID */
108
+ InstanceId?: string;
109
+ /** Item ID */
110
+ ItemId?: string;
111
+ }
112
+ interface AdRewardResults {
113
+ /** Array of the items granted to the player */
114
+ GrantedItems?: AdRewardItemGranted[];
115
+ /** Dictionary of virtual currencies that were granted to the player */
116
+ GrantedVirtualCurrencies?: Record<string, number>;
117
+ /** Dictionary of statistics that were modified for the player */
118
+ IncrementedStatistics?: Record<string, number>;
119
+ }
120
+ interface AndroidDevicePushNotificationRegistrationRequest extends IPlayFabRequestCommon {
121
+ /** Message to display when confirming push notification. */
122
+ ConfirmationMessage?: string;
123
+ /**
124
+ * Registration ID provided by the Google Cloud Messaging service when the title registered to receive push notifications
125
+ * (see the GCM documentation, here: http://developer.android.com/google/gcm/client.html).
126
+ */
127
+ DeviceToken: string;
128
+ /** If true, send a test push message immediately after sucessful registration. Defaults to false. */
129
+ SendPushNotificationConfirmation?: boolean;
130
+ }
131
+ interface AndroidDevicePushNotificationRegistrationResult extends IPlayFabResultCommon {
132
+ }
133
+ interface AttributeInstallRequest extends IPlayFabRequestCommon {
134
+ /** The adid for this device. */
135
+ Adid?: string;
136
+ /** The IdentifierForAdvertisers for iOS Devices. */
137
+ Idfa?: string;
138
+ }
139
+ interface AttributeInstallResult extends IPlayFabResultCommon {
140
+ }
141
+ interface BattleNetAccountPlayFabIdPair {
142
+ /** Unique Battle.net account identifier for a user. */
143
+ BattleNetAccountId?: string;
144
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Battle.net account identifier. */
145
+ PlayFabId?: string;
146
+ }
147
+ interface CancelTradeRequest extends IPlayFabRequestCommon {
148
+ /** Trade identifier. */
149
+ TradeId: string;
150
+ }
151
+ interface CancelTradeResponse extends IPlayFabResultCommon {
152
+ /** Details about trade which was just canceled. */
153
+ Trade?: TradeInfo;
154
+ }
155
+ interface CartItem {
156
+ /** Description of the catalog item. */
157
+ Description?: string;
158
+ /** Display name for the catalog item. */
159
+ DisplayName?: string;
160
+ /** Class name to which catalog item belongs. */
161
+ ItemClass?: string;
162
+ /** Unique identifier for the catalog item. */
163
+ ItemId?: string;
164
+ /** Unique instance identifier for this catalog item. */
165
+ ItemInstanceId?: string;
166
+ /** Cost of the catalog item for each applicable real world currency. */
167
+ RealCurrencyPrices?: Record<string, number>;
168
+ /** Amount of each applicable virtual currency which will be received as a result of purchasing this catalog item. */
169
+ VCAmount?: Record<string, number>;
170
+ /** Cost of the catalog item for each applicable virtual currency. */
171
+ VirtualCurrencyPrices?: Record<string, number>;
172
+ }
173
+ interface CatalogItem {
174
+ /**
175
+ * defines the bundle properties for the item - bundles are items which contain other items, including random drop tables
176
+ * and virtual currencies
177
+ */
178
+ Bundle?: CatalogItemBundleInfo;
179
+ /** if true, then an item instance of this type can be used to grant a character to a user. */
180
+ CanBecomeCharacter: boolean;
181
+ /** catalog version for this item */
182
+ CatalogVersion?: string;
183
+ /** defines the consumable properties (number of uses, timeout) for the item */
184
+ Consumable?: CatalogItemConsumableInfo;
185
+ /**
186
+ * defines the container properties for the item - what items it contains, including random drop tables and virtual
187
+ * currencies, and what item (if any) is required to open it via the UnlockContainerItem API
188
+ */
189
+ Container?: CatalogItemContainerInfo;
190
+ /** game specific custom data */
191
+ CustomData?: string;
192
+ /** text description of item, to show in-game */
193
+ Description?: string;
194
+ /** text name for the item, to show in-game */
195
+ DisplayName?: string;
196
+ /**
197
+ * If the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited
198
+ * edition item, this value determines the total number of instances to allocate for the title. Once this limit has been
199
+ * reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of
200
+ * false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less
201
+ * than zero, it will be ignored.
202
+ */
203
+ InitialLimitedEditionCount: number;
204
+ /** BETA: If true, then only a fixed number can ever be granted. */
205
+ IsLimitedEdition: boolean;
206
+ /**
207
+ * if true, then only one item instance of this type will exist and its remaininguses will be incremented instead.
208
+ * RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded
209
+ */
210
+ IsStackable: boolean;
211
+ /** if true, then an item instance of this type can be traded between players using the trading APIs */
212
+ IsTradable: boolean;
213
+ /** class to which the item belongs */
214
+ ItemClass?: string;
215
+ /** unique identifier for this item */
216
+ ItemId: string;
217
+ /**
218
+ * URL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP
219
+ * URL.
220
+ */
221
+ ItemImageUrl?: string;
222
+ /** override prices for this item for specific currencies */
223
+ RealCurrencyPrices?: Record<string, number>;
224
+ /** list of item tags */
225
+ Tags?: string[];
226
+ /** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
227
+ VirtualCurrencyPrices?: Record<string, number>;
228
+ }
229
+ interface CatalogItemBundleInfo {
230
+ /** unique ItemId values for all items which will be added to the player inventory when the bundle is added */
231
+ BundledItems?: string[];
232
+ /**
233
+ * unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and
234
+ * add the relevant items to the player inventory when the bundle is added)
235
+ */
236
+ BundledResultTables?: string[];
237
+ /** virtual currency types and balances which will be added to the player inventory when the bundle is added */
238
+ BundledVirtualCurrencies?: Record<string, number>;
239
+ }
240
+ interface CatalogItemConsumableInfo {
241
+ /** number of times this object can be used, after which it will be removed from the player inventory */
242
+ UsageCount?: number;
243
+ /**
244
+ * duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
245
+ * (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
246
+ * this item's details have completed)
247
+ */
248
+ UsagePeriod?: number;
249
+ /**
250
+ * all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values
251
+ * added together, and share the result - when that period has elapsed, all the items in the group will be removed
252
+ */
253
+ UsagePeriodGroup?: string;
254
+ }
255
+ interface CatalogItemContainerInfo {
256
+ /** unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked */
257
+ ItemContents?: string[];
258
+ /**
259
+ * ItemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will
260
+ * open the container, adding the contents to the player inventory and currency balances)
261
+ */
262
+ KeyItemId?: string;
263
+ /**
264
+ * unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables
265
+ * will be resolved and add the relevant items to the player inventory)
266
+ */
267
+ ResultTableContents?: string[];
268
+ /** virtual currency types and balances which will be added to the player inventory when the container is unlocked */
269
+ VirtualCurrencyContents?: Record<string, number>;
270
+ }
271
+ interface CharacterInventory {
272
+ /** The id of this character. */
273
+ CharacterId?: string;
274
+ /** The inventory of this character. */
275
+ Inventory?: ItemInstance[];
276
+ }
277
+ interface CharacterLeaderboardEntry {
278
+ /** PlayFab unique identifier of the character that belongs to the user for this leaderboard entry. */
279
+ CharacterId?: string;
280
+ /** Title-specific display name of the character for this leaderboard entry. */
281
+ CharacterName?: string;
282
+ /** Name of the character class for this entry. */
283
+ CharacterType?: string;
284
+ /** Title-specific display name of the user for this leaderboard entry. */
285
+ DisplayName?: string;
286
+ /** PlayFab unique identifier of the user for this leaderboard entry. */
287
+ PlayFabId?: string;
288
+ /** User's overall position in the leaderboard. */
289
+ Position: number;
290
+ /** Specific value of the user's statistic. */
291
+ StatValue: number;
292
+ }
293
+ interface CharacterResult {
294
+ /** The id for this character on this player. */
295
+ CharacterId?: string;
296
+ /** The name of this character. */
297
+ CharacterName?: string;
298
+ /** The type-string that was given to this character on creation. */
299
+ CharacterType?: string;
300
+ }
301
+ interface ConfirmPurchaseRequest extends IPlayFabRequestCommon {
302
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
303
+ CustomTags?: Record<string, string | null>;
304
+ /** Purchase order identifier returned from StartPurchase. */
305
+ OrderId: string;
306
+ }
307
+ interface ConfirmPurchaseResult extends IPlayFabResultCommon {
308
+ /** Array of items purchased. */
309
+ Items?: ItemInstance[];
310
+ /** Purchase order identifier. */
311
+ OrderId?: string;
312
+ /** Date and time of the purchase. */
313
+ PurchaseDate: string;
314
+ }
315
+ interface ConsumeItemRequest extends IPlayFabRequestCommon {
316
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
317
+ CharacterId?: string;
318
+ /** Number of uses to consume from the item. */
319
+ ConsumeCount: number;
320
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
321
+ CustomTags?: Record<string, string | null>;
322
+ /** Unique instance identifier of the item to be consumed. */
323
+ ItemInstanceId: string;
324
+ }
325
+ interface ConsumeItemResult extends IPlayFabResultCommon {
326
+ /** Unique instance identifier of the item with uses consumed. */
327
+ ItemInstanceId?: string;
328
+ /** Number of uses remaining on the item. */
329
+ RemainingUses: number;
330
+ }
331
+ interface ConsumeMicrosoftStoreEntitlementsRequest extends IPlayFabRequestCommon {
332
+ /** Catalog version to use */
333
+ CatalogVersion?: string;
334
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
335
+ CustomTags?: Record<string, string | null>;
336
+ /** Marketplace specific payload containing details to fetch in app purchase transactions */
337
+ MarketplaceSpecificData: MicrosoftStorePayload;
338
+ }
339
+ interface ConsumeMicrosoftStoreEntitlementsResponse extends IPlayFabResultCommon {
340
+ /** Details for the items purchased. */
341
+ Items?: ItemInstance[];
342
+ }
343
+ interface ConsumePS5EntitlementsRequest extends IPlayFabRequestCommon {
344
+ /** Catalog version to use */
345
+ CatalogVersion?: string;
346
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
347
+ CustomTags?: Record<string, string | null>;
348
+ /** Marketplace specific payload containing details to fetch in app purchase transactions */
349
+ MarketplaceSpecificData: PlayStation5Payload;
350
+ }
351
+ interface ConsumePS5EntitlementsResult extends IPlayFabResultCommon {
352
+ /** Details for the items purchased. */
353
+ Items?: ItemInstance[];
354
+ }
355
+ interface ConsumePSNEntitlementsRequest extends IPlayFabRequestCommon {
356
+ /** Which catalog to match granted entitlements against. If null, defaults to title default catalog */
357
+ CatalogVersion?: string;
358
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
359
+ CustomTags?: Record<string, string | null>;
360
+ /** Id of the PlayStation :tm: Network service label to consume entitlements from */
361
+ ServiceLabel: number;
362
+ }
363
+ interface ConsumePSNEntitlementsResult extends IPlayFabResultCommon {
364
+ /** Array of items granted to the player as a result of consuming entitlements. */
365
+ ItemsGranted?: ItemInstance[];
366
+ }
367
+ interface ConsumeXboxEntitlementsRequest extends IPlayFabRequestCommon {
368
+ /** Catalog version to use */
369
+ CatalogVersion?: string;
370
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
371
+ CustomTags?: Record<string, string | null>;
372
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
373
+ XboxToken: string;
374
+ }
375
+ interface ConsumeXboxEntitlementsResult extends IPlayFabResultCommon {
376
+ /** Details for the items purchased. */
377
+ Items?: ItemInstance[];
378
+ }
379
+ interface ContactEmailInfoModel {
380
+ /** The email address */
381
+ EmailAddress?: string;
382
+ /** The name of the email info data */
383
+ Name?: string;
384
+ /** The verification status of the email */
385
+ VerificationStatus?: string;
386
+ }
387
+ interface CreateSharedGroupRequest extends IPlayFabRequestCommon {
388
+ /** Unique identifier for the shared group (a random identifier will be assigned, if one is not specified). */
389
+ SharedGroupId?: string;
390
+ }
391
+ interface CreateSharedGroupResult extends IPlayFabResultCommon {
392
+ /** Unique identifier for the shared group. */
393
+ SharedGroupId?: string;
394
+ }
395
+ interface CustomPropertyDetails {
396
+ /** The custom property's name. */
397
+ Name?: string;
398
+ /** The custom property's value. */
399
+ Value?: any;
400
+ }
401
+ interface DeletedPropertyDetails {
402
+ /** The name of the property which was requested to be deleted. */
403
+ Name?: string;
404
+ /** Indicates whether or not the property was deleted. If false, no property with that name existed. */
405
+ WasDeleted: boolean;
406
+ }
407
+ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
408
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
409
+ CustomTags?: Record<string, string | null>;
410
+ /**
411
+ * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the
412
+ * player's properties have not been updated by any other clients since the last version.
413
+ */
414
+ ExpectedPropertiesVersion?: number;
415
+ /** A list of property names denoting which properties should be deleted. */
416
+ PropertyNames: string[];
417
+ }
418
+ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
419
+ /** The list of properties requested to be deleted. */
420
+ DeletedProperties?: DeletedPropertyDetails[];
421
+ /**
422
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
423
+ * deletes. This version can be provided in update and delete calls for concurrency control.
424
+ */
425
+ PropertiesVersion: number;
426
+ }
427
+ interface DeviceInfoRequest extends IPlayFabRequestCommon {
428
+ /** Information posted to the PlayStream Event. Currently arbitrary, and specific to the environment sending it. */
429
+ Info?: Record<string, any>;
430
+ }
431
+ interface EmptyResult extends IPlayFabResultCommon {
432
+ }
433
+ interface EntityKey {
434
+ /** Unique ID of the entity. */
435
+ Id: string;
436
+ /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
437
+ Type?: string;
438
+ }
439
+ interface EntityTokenResponse {
440
+ /** The entity id and type. */
441
+ Entity?: EntityKey;
442
+ /** The token used to set X-EntityToken for all entity based API calls. */
443
+ EntityToken?: string;
444
+ /** The time the token will expire, if it is an expiring token, in UTC. */
445
+ TokenExpiration?: string;
446
+ }
447
+ interface ExecuteCloudScriptRequest extends IPlayFabRequestCommon {
448
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
449
+ CustomTags?: Record<string, string | null>;
450
+ /** The name of the CloudScript function to execute */
451
+ FunctionName: string;
452
+ /** Object that is passed in to the function as the first argument */
453
+ FunctionParameter?: any;
454
+ /**
455
+ * Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other
456
+ * contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
457
+ */
458
+ GeneratePlayStreamEvent?: boolean;
459
+ /**
460
+ * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
461
+ * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
462
+ * 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.
463
+ */
464
+ RevisionSelection?: string;
465
+ /** The specivic revision to execute, when RevisionSelection is set to 'Specific' */
466
+ SpecificRevision?: number;
467
+ }
468
+ interface ExecuteCloudScriptResult extends IPlayFabResultCommon {
469
+ /** Number of PlayFab API requests issued by the CloudScript function */
470
+ APIRequestsIssued: number;
471
+ /** Information about the error, if any, that occurred during execution */
472
+ Error?: ScriptExecutionError;
473
+ ExecutionTimeSeconds: number;
474
+ /** The name of the function that executed */
475
+ FunctionName?: string;
476
+ /** The object returned from the CloudScript function, if any */
477
+ FunctionResult?: any;
478
+ /**
479
+ * Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if
480
+ * the total event size is larger than 350KB.
481
+ */
482
+ FunctionResultTooLarge?: boolean;
483
+ /** Number of external HTTP requests issued by the CloudScript function */
484
+ HttpRequestsIssued: number;
485
+ /**
486
+ * Entries logged during the function execution. These include both entries logged in the function code using log.info()
487
+ * and log.error() and error entries for API and HTTP request failures.
488
+ */
489
+ Logs?: LogStatement[];
490
+ /**
491
+ * Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total
492
+ * event size is larger than 350KB after the FunctionResult was removed.
493
+ */
494
+ LogsTooLarge?: boolean;
495
+ MemoryConsumedBytes: number;
496
+ /**
497
+ * Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP
498
+ * requests.
499
+ */
500
+ ProcessorTimeSeconds: number;
501
+ /** The revision of the CloudScript that executed */
502
+ Revision: number;
503
+ }
504
+ interface FacebookInstantGamesPlayFabIdPair {
505
+ /** Unique Facebook Instant Games identifier for a user. */
506
+ FacebookInstantGamesId?: string;
507
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook Instant Games identifier. */
508
+ PlayFabId?: string;
509
+ }
510
+ interface FacebookPlayFabIdPair {
511
+ /** Unique Facebook identifier for a user. */
512
+ FacebookId?: string;
513
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook identifier. */
514
+ PlayFabId?: string;
515
+ }
516
+ interface FriendInfo {
517
+ /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */
518
+ FacebookInfo?: UserFacebookInfo;
519
+ /** PlayFab unique identifier for this friend. */
520
+ FriendPlayFabId?: string;
521
+ /**
522
+ * Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same
523
+ * title).
524
+ */
525
+ GameCenterInfo?: UserGameCenterInfo;
526
+ /** The profile of the user, if requested. */
527
+ Profile?: PlayerProfileModel;
528
+ /**
529
+ * Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab
530
+ * Accounts in the same title.
531
+ */
532
+ PSNInfo?: UserPsnInfo;
533
+ /** Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). */
534
+ SteamInfo?: UserSteamInfo;
535
+ /** Tags which have been associated with this friend. */
536
+ Tags?: string[];
537
+ /** Title-specific display name for this friend. */
538
+ TitleDisplayName?: string;
539
+ /** PlayFab unique username for this friend. */
540
+ Username?: string;
541
+ /** Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). */
542
+ XboxInfo?: UserXboxInfo;
543
+ }
544
+ interface GameCenterPlayFabIdPair {
545
+ /** Unique Game Center identifier for a user. */
546
+ GameCenterId?: string;
547
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Game Center identifier. */
548
+ PlayFabId?: string;
549
+ }
550
+ interface GenericPlayFabIdPair {
551
+ /** Unique generic service identifier for a user. */
552
+ GenericId?: GenericServiceId;
553
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the given generic identifier. */
554
+ PlayFabId?: string;
555
+ }
556
+ interface GenericServiceId {
557
+ /** Name of the service for which the player has a unique identifier. */
558
+ ServiceName: string;
559
+ /** Unique identifier of the player in that service. */
560
+ UserId: string;
561
+ }
562
+ interface GetAccountInfoRequest extends IPlayFabRequestCommon {
563
+ /** User email address for the account to find (if no Username is specified). */
564
+ Email?: string;
565
+ /**
566
+ * Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no
567
+ * other lookup identifier set.
568
+ */
569
+ PlayFabId?: string;
570
+ /**
571
+ * Title-specific username for the account to find (if no Email is set). Note that if the non-unique Title Display Names
572
+ * option is enabled for the title, attempts to look up users by Title Display Name will always return AccountNotFound.
573
+ */
574
+ TitleDisplayName?: string;
575
+ /** PlayFab Username for the account to find (if no PlayFabId is specified). */
576
+ Username?: string;
577
+ }
578
+ interface GetAccountInfoResult extends IPlayFabResultCommon {
579
+ /** Account information for the local user. */
580
+ AccountInfo?: UserAccountInfo;
581
+ }
582
+ interface GetAdPlacementsRequest extends IPlayFabRequestCommon {
583
+ /** The current AppId to use */
584
+ AppId: string;
585
+ /** Using the name or unique identifier, filter the result for get a specific placement. */
586
+ Identifier?: NameIdentifier;
587
+ }
588
+ interface GetAdPlacementsResult extends IPlayFabResultCommon {
589
+ /** Array of results */
590
+ AdPlacements?: AdPlacementDetails[];
591
+ }
592
+ interface GetCatalogItemsRequest extends IPlayFabRequestCommon {
593
+ /** Which catalog is being requested. If null, uses the default catalog. */
594
+ CatalogVersion?: string;
595
+ }
596
+ interface GetCatalogItemsResult extends IPlayFabResultCommon {
597
+ /** Array of items which can be purchased. */
598
+ Catalog?: CatalogItem[];
599
+ }
600
+ interface GetCharacterDataRequest extends IPlayFabRequestCommon {
601
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
602
+ CharacterId: string;
603
+ /**
604
+ * The version that currently exists according to the caller. The call will return the data for all of the keys if the
605
+ * version in the system is greater than this.
606
+ */
607
+ IfChangedFromDataVersion?: number;
608
+ /** Specific keys to search for in the custom user data. */
609
+ Keys?: string[];
610
+ /** Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. */
611
+ PlayFabId?: string;
612
+ }
613
+ interface GetCharacterDataResult extends IPlayFabResultCommon {
614
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
615
+ CharacterId?: string;
616
+ /** User specific data for this title. */
617
+ Data?: Record<string, UserDataRecord>;
618
+ /**
619
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
620
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
621
+ */
622
+ DataVersion: number;
623
+ }
624
+ interface GetCharacterInventoryRequest extends IPlayFabRequestCommon {
625
+ /** Used to limit results to only those from a specific catalog version. */
626
+ CatalogVersion?: string;
627
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
628
+ CharacterId: string;
629
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
630
+ CustomTags?: Record<string, string | null>;
631
+ }
632
+ interface GetCharacterInventoryResult extends IPlayFabResultCommon {
633
+ /** Unique identifier of the character for this inventory. */
634
+ CharacterId?: string;
635
+ /** Array of inventory items belonging to the character. */
636
+ Inventory?: ItemInstance[];
637
+ /** Array of virtual currency balance(s) belonging to the character. */
638
+ VirtualCurrency?: Record<string, number>;
639
+ /** Array of remaining times and timestamps for virtual currencies. */
640
+ VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
641
+ }
642
+ interface GetCharacterLeaderboardRequest extends IPlayFabRequestCommon {
643
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
644
+ MaxResultsCount?: number;
645
+ /** First entry in the leaderboard to be retrieved. */
646
+ StartPosition: number;
647
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
648
+ StatisticName: string;
649
+ }
650
+ interface GetCharacterLeaderboardResult extends IPlayFabResultCommon {
651
+ /** Ordered list of leaderboard entries. */
652
+ Leaderboard?: CharacterLeaderboardEntry[];
653
+ }
654
+ interface GetCharacterStatisticsRequest extends IPlayFabRequestCommon {
655
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
656
+ CharacterId: string;
657
+ }
658
+ interface GetCharacterStatisticsResult extends IPlayFabResultCommon {
659
+ /** The requested character statistics. */
660
+ CharacterStatistics?: Record<string, number>;
661
+ }
662
+ interface GetContentDownloadUrlRequest extends IPlayFabRequestCommon {
663
+ /** HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET. */
664
+ HttpMethod?: string;
665
+ /** Key of the content item to fetch, usually formatted as a path, e.g. images/a.png */
666
+ Key: string;
667
+ /**
668
+ * True to download through CDN. CDN provides higher download bandwidth and lower latency. However, if you want the latest,
669
+ * non-cached version of the content during development, set this to false. Default is true.
670
+ */
671
+ ThruCDN?: boolean;
672
+ }
673
+ interface GetContentDownloadUrlResult extends IPlayFabResultCommon {
674
+ /** URL for downloading content via HTTP GET or HEAD method. The URL will expire in approximately one hour. */
675
+ URL?: string;
676
+ }
677
+ interface GetFriendLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
678
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
679
+ CustomTags?: Record<string, string | null>;
680
+ /**
681
+ * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
682
+ * comma-separated list of platforms.
683
+ */
684
+ ExternalPlatformFriends?: string;
685
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
686
+ MaxResultsCount?: number;
687
+ /** PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user. */
688
+ PlayFabId?: string;
689
+ /**
690
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
691
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
692
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
693
+ */
694
+ ProfileConstraints?: PlayerProfileViewConstraints;
695
+ /** Statistic used to rank players for this leaderboard. */
696
+ StatisticName: string;
697
+ /** The version of the leaderboard to get. */
698
+ Version?: number;
699
+ /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
700
+ XboxToken?: string;
701
+ }
702
+ interface GetFriendLeaderboardAroundPlayerResult extends IPlayFabResultCommon {
703
+ /** Ordered listing of users and their positions in the requested leaderboard. */
704
+ Leaderboard?: PlayerLeaderboardEntry[];
705
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
706
+ NextReset?: string;
707
+ /** The version of the leaderboard returned. */
708
+ Version: number;
709
+ }
710
+ interface GetFriendLeaderboardRequest 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
+ /**
714
+ * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
715
+ * comma-separated list of platforms.
716
+ */
717
+ ExternalPlatformFriends?: string;
718
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
719
+ MaxResultsCount?: number;
720
+ /**
721
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
722
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
723
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
724
+ */
725
+ ProfileConstraints?: PlayerProfileViewConstraints;
726
+ /** Position in the leaderboard to start this listing (defaults to the first entry). */
727
+ StartPosition: number;
728
+ /** Statistic used to rank friends for this leaderboard. */
729
+ StatisticName: string;
730
+ /** The version of the leaderboard to get. */
731
+ Version?: number;
732
+ /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
733
+ XboxToken?: string;
734
+ }
735
+ interface GetFriendsListRequest extends IPlayFabRequestCommon {
736
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
737
+ CustomTags?: Record<string, string | null>;
738
+ /**
739
+ * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
740
+ * comma-separated list of platforms.
741
+ */
742
+ ExternalPlatformFriends?: string;
743
+ /**
744
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
745
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
746
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
747
+ */
748
+ ProfileConstraints?: PlayerProfileViewConstraints;
749
+ /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
750
+ XboxToken?: string;
751
+ }
752
+ interface GetFriendsListResult extends IPlayFabResultCommon {
753
+ /** Array of friends found. */
754
+ Friends?: FriendInfo[];
755
+ }
756
+ interface GetLeaderboardAroundCharacterRequest extends IPlayFabRequestCommon {
757
+ /** Unique PlayFab assigned ID for a specific character on which to center the leaderboard. */
758
+ CharacterId: string;
759
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
760
+ MaxResultsCount?: number;
761
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
762
+ StatisticName: string;
763
+ }
764
+ interface GetLeaderboardAroundCharacterResult extends IPlayFabResultCommon {
765
+ /** Ordered list of leaderboard entries. */
766
+ Leaderboard?: CharacterLeaderboardEntry[];
767
+ }
768
+ interface GetLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
769
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
770
+ CustomTags?: Record<string, string | null>;
771
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
772
+ MaxResultsCount?: number;
773
+ /** PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user. */
774
+ PlayFabId?: string;
775
+ /**
776
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
777
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
778
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
779
+ */
780
+ ProfileConstraints?: PlayerProfileViewConstraints;
781
+ /** Statistic used to rank players for this leaderboard. */
782
+ StatisticName: string;
783
+ /** The version of the leaderboard to get. */
784
+ Version?: number;
785
+ }
786
+ interface GetLeaderboardAroundPlayerResult extends IPlayFabResultCommon {
787
+ /** Ordered listing of users and their positions in the requested leaderboard. */
788
+ Leaderboard?: PlayerLeaderboardEntry[];
789
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
790
+ NextReset?: string;
791
+ /** The version of the leaderboard returned. */
792
+ Version: number;
793
+ }
794
+ interface GetLeaderboardForUsersCharactersRequest extends IPlayFabRequestCommon {
795
+ /** Unique identifier for the title-specific statistic for the leaderboard. */
796
+ StatisticName: string;
797
+ }
798
+ interface GetLeaderboardForUsersCharactersResult extends IPlayFabResultCommon {
799
+ /** Ordered list of leaderboard entries. */
800
+ Leaderboard?: CharacterLeaderboardEntry[];
801
+ }
802
+ interface GetLeaderboardRequest extends IPlayFabRequestCommon {
803
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
804
+ CustomTags?: Record<string, string | null>;
805
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
806
+ MaxResultsCount?: number;
807
+ /**
808
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
809
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
810
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
811
+ */
812
+ ProfileConstraints?: PlayerProfileViewConstraints;
813
+ /** Position in the leaderboard to start this listing (defaults to the first entry). */
814
+ StartPosition: number;
815
+ /** Statistic used to rank players for this leaderboard. */
816
+ StatisticName: string;
817
+ /** The version of the leaderboard to get. */
818
+ Version?: number;
819
+ }
820
+ interface GetLeaderboardResult extends IPlayFabResultCommon {
821
+ /** Ordered listing of users and their positions in the requested leaderboard. */
822
+ Leaderboard?: PlayerLeaderboardEntry[];
823
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
824
+ NextReset?: string;
825
+ /** The version of the leaderboard returned. */
826
+ Version: number;
827
+ }
828
+ interface GetPaymentTokenRequest extends IPlayFabRequestCommon {
829
+ /** The name of service to provide the payment token. Allowed Values are: xsolla */
830
+ TokenProvider: string;
831
+ }
832
+ interface GetPaymentTokenResult extends IPlayFabResultCommon {
833
+ /** PlayFab's purchase order identifier. */
834
+ OrderId?: string;
835
+ /** The token from provider. */
836
+ ProviderToken?: string;
837
+ }
838
+ interface GetPhotonAuthenticationTokenRequest extends IPlayFabRequestCommon {
839
+ /** The Photon applicationId for the game you wish to log into. */
840
+ PhotonApplicationId: string;
841
+ }
842
+ interface GetPhotonAuthenticationTokenResult extends IPlayFabResultCommon {
843
+ /** The Photon authentication token for this game-session. */
844
+ PhotonCustomAuthenticationToken?: string;
845
+ }
846
+ interface GetPlayerCombinedInfoRequest extends IPlayFabRequestCommon {
847
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
848
+ CustomTags?: Record<string, string | null>;
849
+ /** Flags for which pieces of info to return for the user. */
850
+ InfoRequestParameters: GetPlayerCombinedInfoRequestParams;
851
+ /** PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. */
852
+ PlayFabId?: string;
853
+ }
854
+ interface GetPlayerCombinedInfoRequestParams {
855
+ /** Whether to get character inventories. Defaults to false. */
856
+ GetCharacterInventories: boolean;
857
+ /** Whether to get the list of characters. Defaults to false. */
858
+ GetCharacterList: boolean;
859
+ /** Whether to get player profile. Defaults to false. Has no effect for a new player. */
860
+ GetPlayerProfile: boolean;
861
+ /** Whether to get player statistics. Defaults to false. */
862
+ GetPlayerStatistics: boolean;
863
+ /** Whether to get title data. Defaults to false. */
864
+ GetTitleData: boolean;
865
+ /** Whether to get the player's account Info. Defaults to false */
866
+ GetUserAccountInfo: boolean;
867
+ /** Whether to get the player's custom data. Defaults to false */
868
+ GetUserData: boolean;
869
+ /** Whether to get the player's inventory. Defaults to false */
870
+ GetUserInventory: boolean;
871
+ /** Whether to get the player's read only data. Defaults to false */
872
+ GetUserReadOnlyData: boolean;
873
+ /** Whether to get the player's virtual currency balances. Defaults to false */
874
+ GetUserVirtualCurrency: boolean;
875
+ /** Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false */
876
+ PlayerStatisticNames?: string[];
877
+ /** Specifies the properties to return from the player profile. Defaults to returning the player's display name. */
878
+ ProfileConstraints?: PlayerProfileViewConstraints;
879
+ /** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false */
880
+ TitleDataKeys?: string[];
881
+ /** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false */
882
+ UserDataKeys?: string[];
883
+ /**
884
+ * Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is
885
+ * false
886
+ */
887
+ UserReadOnlyDataKeys?: string[];
888
+ }
889
+ interface GetPlayerCombinedInfoResult extends IPlayFabResultCommon {
890
+ /** Results for requested info. */
891
+ InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
892
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
893
+ PlayFabId?: string;
894
+ }
895
+ interface GetPlayerCombinedInfoResultPayload {
896
+ /** Account information for the user. This is always retrieved. */
897
+ AccountInfo?: UserAccountInfo;
898
+ /** Inventories for each character for the user. */
899
+ CharacterInventories?: CharacterInventory[];
900
+ /** List of characters for the user. */
901
+ CharacterList?: CharacterResult[];
902
+ /**
903
+ * The profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
904
+ * exist.
905
+ */
906
+ PlayerProfile?: PlayerProfileModel;
907
+ /** List of statistics for this player. */
908
+ PlayerStatistics?: StatisticValue[];
909
+ /** Title data for this title. */
910
+ TitleData?: Record<string, string | null>;
911
+ /** User specific custom data. */
912
+ UserData?: Record<string, UserDataRecord>;
913
+ /** The version of the UserData that was returned. */
914
+ UserDataVersion: number;
915
+ /** Array of inventory items in the user's current inventory. */
916
+ UserInventory?: ItemInstance[];
917
+ /** User specific read-only data. */
918
+ UserReadOnlyData?: Record<string, UserDataRecord>;
919
+ /** The version of the Read-Only UserData that was returned. */
920
+ UserReadOnlyDataVersion: number;
921
+ /** Dictionary of virtual currency balance(s) belonging to the user. */
922
+ UserVirtualCurrency?: Record<string, number>;
923
+ /** Dictionary of remaining times and timestamps for virtual currencies. */
924
+ UserVirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
925
+ }
926
+ interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
927
+ /** Specific property name to search for in the player's properties. */
928
+ PropertyName: string;
929
+ }
930
+ interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
931
+ /**
932
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
933
+ * deletes. This version can be provided in update and delete calls for concurrency control.
934
+ */
935
+ PropertiesVersion: number;
936
+ /** Player specific property and its corresponding value. */
937
+ Property?: CustomPropertyDetails;
938
+ }
939
+ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
940
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
941
+ CustomTags?: Record<string, string | null>;
942
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
943
+ PlayFabId?: string;
944
+ /**
945
+ * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
946
+ * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
947
+ * the Game Manager "Client Profile Options" tab in the "Settings" section.
948
+ */
949
+ ProfileConstraints?: PlayerProfileViewConstraints;
950
+ }
951
+ interface GetPlayerProfileResult extends IPlayFabResultCommon {
952
+ /**
953
+ * The profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
954
+ * exist.
955
+ */
956
+ PlayerProfile?: PlayerProfileModel;
957
+ }
958
+ interface GetPlayerSegmentsRequest extends IPlayFabRequestCommon {
959
+ }
960
+ interface GetPlayerSegmentsResult extends IPlayFabResultCommon {
961
+ /** Array of segments the requested player currently belongs to. */
962
+ Segments?: GetSegmentResult[];
963
+ }
964
+ interface GetPlayerStatisticsRequest extends IPlayFabRequestCommon {
965
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
966
+ CustomTags?: Record<string, string | null>;
967
+ /** statistics to return (current version will be returned for each) */
968
+ StatisticNames?: string[];
969
+ /**
970
+ * statistics to return, if StatisticNames is not set (only statistics which have a version matching that provided will be
971
+ * returned)
972
+ */
973
+ StatisticNameVersions?: StatisticNameVersion[];
974
+ }
975
+ interface GetPlayerStatisticsResult extends IPlayFabResultCommon {
976
+ /** User statistics for the requested user. */
977
+ Statistics?: StatisticValue[];
978
+ }
979
+ interface GetPlayerStatisticVersionsRequest extends IPlayFabRequestCommon {
980
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
981
+ CustomTags?: Record<string, string | null>;
982
+ /** unique name of the statistic */
983
+ StatisticName?: string;
984
+ }
985
+ interface GetPlayerStatisticVersionsResult extends IPlayFabResultCommon {
986
+ /** version change history of the statistic */
987
+ StatisticVersions?: PlayerStatisticVersion[];
988
+ }
989
+ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
990
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
991
+ CustomTags?: Record<string, string | null>;
992
+ /** Optional namespace to filter results by */
993
+ Namespace?: string;
994
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
995
+ PlayFabId: string;
996
+ }
997
+ interface GetPlayerTagsResult extends IPlayFabResultCommon {
998
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
999
+ PlayFabId: string;
1000
+ /** Canonical tags (including namespace and tag's name) for the requested user */
1001
+ Tags: string[];
1002
+ }
1003
+ interface GetPlayerTradesRequest extends IPlayFabRequestCommon {
1004
+ /** Returns only trades with the given status. If null, returns all trades. */
1005
+ StatusFilter?: string;
1006
+ }
1007
+ interface GetPlayerTradesResponse extends IPlayFabResultCommon {
1008
+ /** History of trades which this player has accepted. */
1009
+ AcceptedTrades?: TradeInfo[];
1010
+ /** The trades for this player which are currently available to be accepted. */
1011
+ OpenedTrades?: TradeInfo[];
1012
+ }
1013
+ interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends IPlayFabRequestCommon {
1014
+ /**
1015
+ * Array of unique Battle.net account identifiers for which the title needs to get PlayFab identifiers. The array cannot
1016
+ * exceed 10 in length.
1017
+ */
1018
+ BattleNetAccountIds: string[];
1019
+ }
1020
+ interface GetPlayFabIDsFromBattleNetAccountIdsResult extends IPlayFabResultCommon {
1021
+ /** Mapping of Battle.net account identifiers to PlayFab identifiers. */
1022
+ Data?: BattleNetAccountPlayFabIdPair[];
1023
+ }
1024
+ interface GetPlayFabIDsFromFacebookIDsRequest extends IPlayFabRequestCommon {
1025
+ /**
1026
+ * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000
1027
+ * in length.
1028
+ */
1029
+ FacebookIDs: string[];
1030
+ }
1031
+ interface GetPlayFabIDsFromFacebookIDsResult extends IPlayFabResultCommon {
1032
+ /** Mapping of Facebook identifiers to PlayFab identifiers. */
1033
+ Data?: FacebookPlayFabIdPair[];
1034
+ }
1035
+ interface GetPlayFabIDsFromFacebookInstantGamesIdsRequest extends IPlayFabRequestCommon {
1036
+ /**
1037
+ * Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array
1038
+ * cannot exceed 25 in length.
1039
+ */
1040
+ FacebookInstantGamesIds: string[];
1041
+ }
1042
+ interface GetPlayFabIDsFromFacebookInstantGamesIdsResult extends IPlayFabResultCommon {
1043
+ /** Mapping of Facebook Instant Games identifiers to PlayFab identifiers. */
1044
+ Data?: FacebookInstantGamesPlayFabIdPair[];
1045
+ }
1046
+ interface GetPlayFabIDsFromGameCenterIDsRequest extends IPlayFabRequestCommon {
1047
+ /**
1048
+ * Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers.
1049
+ * The array cannot exceed 2,000 in length.
1050
+ */
1051
+ GameCenterIDs: string[];
1052
+ }
1053
+ interface GetPlayFabIDsFromGameCenterIDsResult extends IPlayFabResultCommon {
1054
+ /** Mapping of Game Center identifiers to PlayFab identifiers. */
1055
+ Data?: GameCenterPlayFabIdPair[];
1056
+ }
1057
+ interface GetPlayFabIDsFromGenericIDsRequest extends IPlayFabRequestCommon {
1058
+ /**
1059
+ * Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a
1060
+ * maximum of 10 in a single request.
1061
+ */
1062
+ GenericIDs: GenericServiceId[];
1063
+ }
1064
+ interface GetPlayFabIDsFromGenericIDsResult extends IPlayFabResultCommon {
1065
+ /** Mapping of generic service identifiers to PlayFab identifiers. */
1066
+ Data?: GenericPlayFabIdPair[];
1067
+ }
1068
+ interface GetPlayFabIDsFromGoogleIDsRequest extends IPlayFabRequestCommon {
1069
+ /**
1070
+ * Array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. The array
1071
+ * cannot exceed 2,000 in length.
1072
+ */
1073
+ GoogleIDs: string[];
1074
+ }
1075
+ interface GetPlayFabIDsFromGoogleIDsResult extends IPlayFabResultCommon {
1076
+ /** Mapping of Google identifiers to PlayFab identifiers. */
1077
+ Data?: GooglePlayFabIdPair[];
1078
+ }
1079
+ interface GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest extends IPlayFabRequestCommon {
1080
+ /**
1081
+ * Array of unique Google Play Games identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers.
1082
+ * The array cannot exceed 2,000 in length.
1083
+ */
1084
+ GooglePlayGamesPlayerIDs: string[];
1085
+ }
1086
+ interface GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult extends IPlayFabResultCommon {
1087
+ /** Mapping of Google Play Games identifiers to PlayFab identifiers. */
1088
+ Data?: GooglePlayGamesPlayFabIdPair[];
1089
+ }
1090
+ interface GetPlayFabIDsFromKongregateIDsRequest extends IPlayFabRequestCommon {
1091
+ /**
1092
+ * Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The
1093
+ * array cannot exceed 2,000 in length.
1094
+ */
1095
+ KongregateIDs: string[];
1096
+ }
1097
+ interface GetPlayFabIDsFromKongregateIDsResult extends IPlayFabResultCommon {
1098
+ /** Mapping of Kongregate identifiers to PlayFab identifiers. */
1099
+ Data?: KongregatePlayFabIdPair[];
1100
+ }
1101
+ interface GetPlayFabIDsFromNintendoServiceAccountIdsRequest extends IPlayFabRequestCommon {
1102
+ /**
1103
+ * Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array
1104
+ * cannot exceed 2,000 in length.
1105
+ */
1106
+ NintendoAccountIds: string[];
1107
+ }
1108
+ interface GetPlayFabIDsFromNintendoServiceAccountIdsResult extends IPlayFabResultCommon {
1109
+ /** Mapping of Nintendo Switch Service Account identifiers to PlayFab identifiers. */
1110
+ Data?: NintendoServiceAccountPlayFabIdPair[];
1111
+ }
1112
+ interface GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest extends IPlayFabRequestCommon {
1113
+ /**
1114
+ * Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array
1115
+ * cannot exceed 2,000 in length.
1116
+ */
1117
+ NintendoSwitchDeviceIds: string[];
1118
+ }
1119
+ interface GetPlayFabIDsFromNintendoSwitchDeviceIdsResult extends IPlayFabResultCommon {
1120
+ /** Mapping of Nintendo Switch Device identifiers to PlayFab identifiers. */
1121
+ Data?: NintendoSwitchPlayFabIdPair[];
1122
+ }
1123
+ interface GetPlayFabIDsFromPSNAccountIDsRequest extends IPlayFabRequestCommon {
1124
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1125
+ IssuerId?: number;
1126
+ /**
1127
+ * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array
1128
+ * cannot exceed 2,000 in length.
1129
+ */
1130
+ PSNAccountIDs: string[];
1131
+ }
1132
+ interface GetPlayFabIDsFromPSNAccountIDsResult extends IPlayFabResultCommon {
1133
+ /** Mapping of PlayStation :tm: Network identifiers to PlayFab identifiers. */
1134
+ Data?: PSNAccountPlayFabIdPair[];
1135
+ }
1136
+ interface GetPlayFabIDsFromPSNOnlineIDsRequest extends IPlayFabRequestCommon {
1137
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1138
+ IssuerId?: number;
1139
+ /**
1140
+ * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array
1141
+ * cannot exceed 2,000 in length.
1142
+ */
1143
+ PSNOnlineIDs: string[];
1144
+ }
1145
+ interface GetPlayFabIDsFromPSNOnlineIDsResult extends IPlayFabResultCommon {
1146
+ /** Mapping of PlayStation :tm: Network identifiers to PlayFab identifiers. */
1147
+ Data?: PSNOnlinePlayFabIdPair[];
1148
+ }
1149
+ interface GetPlayFabIDsFromSteamIDsRequest extends IPlayFabRequestCommon {
1150
+ /**
1151
+ * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array
1152
+ * cannot exceed 2,000 in length.
1153
+ */
1154
+ SteamStringIDs?: string[];
1155
+ }
1156
+ interface GetPlayFabIDsFromSteamIDsResult extends IPlayFabResultCommon {
1157
+ /** Mapping of Steam identifiers to PlayFab identifiers. */
1158
+ Data?: SteamPlayFabIdPair[];
1159
+ }
1160
+ interface GetPlayFabIDsFromSteamNamesRequest extends IPlayFabRequestCommon {
1161
+ /**
1162
+ * Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in
1163
+ * length.
1164
+ */
1165
+ SteamNames: string[];
1166
+ }
1167
+ interface GetPlayFabIDsFromSteamNamesResult extends IPlayFabResultCommon {
1168
+ /** Mapping of Steam identifiers to PlayFab identifiers. */
1169
+ Data?: SteamNamePlayFabIdPair[];
1170
+ }
1171
+ interface GetPlayFabIDsFromTwitchIDsRequest extends IPlayFabRequestCommon {
1172
+ /**
1173
+ * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot
1174
+ * exceed 2,000 in length.
1175
+ */
1176
+ TwitchIds: string[];
1177
+ }
1178
+ interface GetPlayFabIDsFromTwitchIDsResult extends IPlayFabResultCommon {
1179
+ /** Mapping of Twitch identifiers to PlayFab identifiers. */
1180
+ Data?: TwitchPlayFabIdPair[];
1181
+ }
1182
+ interface GetPlayFabIDsFromXboxLiveIDsRequest extends IPlayFabRequestCommon {
1183
+ /** The ID of Xbox Live sandbox. */
1184
+ Sandbox?: string;
1185
+ /**
1186
+ * Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot
1187
+ * exceed 2,000 in length.
1188
+ */
1189
+ XboxLiveAccountIDs: string[];
1190
+ }
1191
+ interface GetPlayFabIDsFromXboxLiveIDsResult extends IPlayFabResultCommon {
1192
+ /** Mapping of Xbox Live identifiers to PlayFab identifiers. */
1193
+ Data?: XboxLiveAccountPlayFabIdPair[];
1194
+ }
1195
+ interface GetPublisherDataRequest extends IPlayFabRequestCommon {
1196
+ /** array of keys to get back data from the Publisher data blob, set by the admin tools */
1197
+ Keys: string[];
1198
+ }
1199
+ interface GetPublisherDataResult extends IPlayFabResultCommon {
1200
+ /** a dictionary object of key / value pairs */
1201
+ Data?: Record<string, string | null>;
1202
+ }
1203
+ interface GetPurchaseRequest extends IPlayFabRequestCommon {
1204
+ /** Purchase order identifier. */
1205
+ OrderId: string;
1206
+ }
1207
+ interface GetPurchaseResult extends IPlayFabResultCommon {
1208
+ /** Purchase order identifier. */
1209
+ OrderId?: string;
1210
+ /** Payment provider used for transaction (If not VC) */
1211
+ PaymentProvider?: string;
1212
+ /** Date and time of the purchase. */
1213
+ PurchaseDate: string;
1214
+ /** Provider transaction ID (If not VC) */
1215
+ TransactionId?: string;
1216
+ /** PlayFab transaction status */
1217
+ TransactionStatus?: string;
1218
+ }
1219
+ interface GetSegmentResult {
1220
+ /** Identifier of the segments AB Test, if it is attached to one. */
1221
+ ABTestParent?: string;
1222
+ /** Unique identifier for this segment. */
1223
+ Id: string;
1224
+ /** Segment name. */
1225
+ Name?: string;
1226
+ }
1227
+ interface GetSharedGroupDataRequest extends IPlayFabRequestCommon {
1228
+ /** If true, return the list of all members of the shared group. */
1229
+ GetMembers?: boolean;
1230
+ /**
1231
+ * Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array
1232
+ * indicates that no keys should be returned).
1233
+ */
1234
+ Keys?: string[];
1235
+ /** Unique identifier for the shared group. */
1236
+ SharedGroupId: string;
1237
+ }
1238
+ interface GetSharedGroupDataResult extends IPlayFabResultCommon {
1239
+ /** Data for the requested keys. */
1240
+ Data?: Record<string, SharedGroupDataRecord>;
1241
+ /** List of PlayFabId identifiers for the members of this group, if requested. */
1242
+ Members?: string[];
1243
+ }
1244
+ interface GetStoreItemsRequest extends IPlayFabRequestCommon {
1245
+ /** Catalog version to store items from. Use default catalog version if null */
1246
+ CatalogVersion?: string;
1247
+ /** Unqiue identifier for the store which is being requested. */
1248
+ StoreId: string;
1249
+ }
1250
+ interface GetStoreItemsResult extends IPlayFabResultCommon {
1251
+ /** The base catalog that this store is a part of. */
1252
+ CatalogVersion?: string;
1253
+ /** Additional data about the store. */
1254
+ MarketingData?: StoreMarketingModel;
1255
+ /** How the store was last updated (Admin or a third party). */
1256
+ Source?: string;
1257
+ /** Array of items which can be purchased from this store. */
1258
+ Store?: StoreItem[];
1259
+ /** The ID of this store. */
1260
+ StoreId?: string;
1261
+ }
1262
+ interface GetTimeRequest extends IPlayFabRequestCommon {
1263
+ }
1264
+ interface GetTimeResult extends IPlayFabResultCommon {
1265
+ /** Current server time when the request was received, in UTC */
1266
+ Time: string;
1267
+ }
1268
+ interface GetTitleDataRequest extends IPlayFabRequestCommon {
1269
+ /** Specific keys to search for in the title data (leave null to get all keys) */
1270
+ Keys?: string[];
1271
+ /**
1272
+ * Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise,
1273
+ * the overrides are applied automatically to the title data.
1274
+ */
1275
+ OverrideLabel?: string;
1276
+ }
1277
+ interface GetTitleDataResult extends IPlayFabResultCommon {
1278
+ /** a dictionary object of key / value pairs */
1279
+ Data?: Record<string, string | null>;
1280
+ }
1281
+ interface GetTitleNewsRequest extends IPlayFabRequestCommon {
1282
+ /** Limits the results to the last n entries. Defaults to 10 if not set. */
1283
+ Count?: number;
1284
+ }
1285
+ interface GetTitleNewsResult extends IPlayFabResultCommon {
1286
+ /** Array of news items. */
1287
+ News?: TitleNewsItem[];
1288
+ }
1289
+ interface GetTitlePublicKeyRequest extends IPlayFabRequestCommon {
1290
+ /**
1291
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1292
+ * title has been selected.
1293
+ */
1294
+ TitleId: string;
1295
+ /** The shared secret key for this title */
1296
+ TitleSharedSecret: string;
1297
+ }
1298
+ interface GetTitlePublicKeyResult extends IPlayFabResultCommon {
1299
+ /** Base64 encoded RSA CSP byte array blob containing the title's public RSA key */
1300
+ RSAPublicKey?: string;
1301
+ }
1302
+ interface GetTradeStatusRequest extends IPlayFabRequestCommon {
1303
+ /** Player who opened trade. */
1304
+ OfferingPlayerId: string;
1305
+ /** Trade identifier as returned by OpenTradeOffer. */
1306
+ TradeId: string;
1307
+ }
1308
+ interface GetTradeStatusResponse extends IPlayFabResultCommon {
1309
+ /** Information about the requested trade. */
1310
+ Trade?: TradeInfo;
1311
+ }
1312
+ interface GetUserDataRequest extends IPlayFabRequestCommon {
1313
+ /**
1314
+ * The version that currently exists according to the caller. The call will return the data for all of the keys if the
1315
+ * version in the system is greater than this.
1316
+ */
1317
+ IfChangedFromDataVersion?: number;
1318
+ /** List of unique keys to load from. */
1319
+ Keys?: string[];
1320
+ /**
1321
+ * Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a
1322
+ * PlayFab id of another player, then this will only return public keys for that account.
1323
+ */
1324
+ PlayFabId?: string;
1325
+ }
1326
+ interface GetUserDataResult extends IPlayFabResultCommon {
1327
+ /** User specific data for this title. */
1328
+ Data?: Record<string, UserDataRecord>;
1329
+ /**
1330
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
1331
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
1332
+ */
1333
+ DataVersion: number;
1334
+ }
1335
+ interface GetUserInventoryRequest extends IPlayFabRequestCommon {
1336
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1337
+ CustomTags?: Record<string, string | null>;
1338
+ }
1339
+ interface GetUserInventoryResult extends IPlayFabResultCommon {
1340
+ /** Array of inventory items belonging to the user. */
1341
+ Inventory?: ItemInstance[];
1342
+ /** Array of virtual currency balance(s) belonging to the user. */
1343
+ VirtualCurrency?: Record<string, number>;
1344
+ /** Array of remaining times and timestamps for virtual currencies. */
1345
+ VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
1346
+ }
1347
+ interface GooglePlayFabIdPair {
1348
+ /** Unique Google identifier for a user. */
1349
+ GoogleId?: string;
1350
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Google identifier. */
1351
+ PlayFabId?: string;
1352
+ }
1353
+ interface GooglePlayGamesPlayFabIdPair {
1354
+ /** Unique Google Play Games identifier for a user. */
1355
+ GooglePlayGamesPlayerId?: string;
1356
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Google Play Games identifier. */
1357
+ PlayFabId?: string;
1358
+ }
1359
+ interface GrantCharacterToUserRequest extends IPlayFabRequestCommon {
1360
+ /** Catalog version from which items are to be granted. */
1361
+ CatalogVersion?: string;
1362
+ /** Non-unique display name of the character being granted (1-40 characters in length). */
1363
+ CharacterName: string;
1364
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1365
+ CustomTags?: Record<string, string | null>;
1366
+ /**
1367
+ * Catalog item identifier of the item in the user's inventory that corresponds to the character in the catalog to be
1368
+ * created.
1369
+ */
1370
+ ItemId: string;
1371
+ }
1372
+ interface GrantCharacterToUserResult extends IPlayFabResultCommon {
1373
+ /** Unique identifier tagged to this character. */
1374
+ CharacterId?: string;
1375
+ /** Type of character that was created. */
1376
+ CharacterType?: string;
1377
+ /** Indicates whether this character was created successfully. */
1378
+ Result: boolean;
1379
+ }
1380
+ interface ItemInstance {
1381
+ /** Game specific comment associated with this instance when it was added to the user inventory. */
1382
+ Annotation?: string;
1383
+ /** Array of unique items that were awarded when this catalog item was purchased. */
1384
+ BundleContents?: string[];
1385
+ /**
1386
+ * Unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
1387
+ * container.
1388
+ */
1389
+ BundleParent?: string;
1390
+ /** Catalog version for the inventory item, when this instance was created. */
1391
+ CatalogVersion?: string;
1392
+ /**
1393
+ * A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
1394
+ * item's custom data.
1395
+ */
1396
+ CustomData?: Record<string, string | null>;
1397
+ /** CatalogItem.DisplayName at the time this item was purchased. */
1398
+ DisplayName?: string;
1399
+ /** Timestamp for when this instance will expire. */
1400
+ Expiration?: string;
1401
+ /** Class name for the inventory item, as defined in the catalog. */
1402
+ ItemClass?: string;
1403
+ /** Unique identifier for the inventory item, as defined in the catalog. */
1404
+ ItemId?: string;
1405
+ /** Unique item identifier for this specific instance of the item. */
1406
+ ItemInstanceId?: string;
1407
+ /** Timestamp for when this instance was purchased. */
1408
+ PurchaseDate?: string;
1409
+ /** Total number of remaining uses, if this is a consumable item. */
1410
+ RemainingUses?: number;
1411
+ /** Currency type for the cost of the catalog item. Not available when granting items. */
1412
+ UnitCurrency?: string;
1413
+ /** Cost of the catalog item in the given currency. Not available when granting items. */
1414
+ UnitPrice: number;
1415
+ /** The number of uses that were added or removed to this item in this call. */
1416
+ UsesIncrementedBy?: number;
1417
+ }
1418
+ interface ItemPurchaseRequest {
1419
+ /** Title-specific text concerning this purchase. */
1420
+ Annotation?: string;
1421
+ /** Unique ItemId of the item to purchase. */
1422
+ ItemId: string;
1423
+ /** How many of this item to purchase. Min 1, maximum 25. */
1424
+ Quantity: number;
1425
+ /** Items to be upgraded as a result of this purchase (upgraded items are hidden, as they are "replaced" by the new items). */
1426
+ UpgradeFromItems?: string[];
1427
+ }
1428
+ interface KongregatePlayFabIdPair {
1429
+ /** Unique Kongregate identifier for a user. */
1430
+ KongregateId?: string;
1431
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Kongregate identifier. */
1432
+ PlayFabId?: string;
1433
+ }
1434
+ interface LinkAndroidDeviceIDRequest extends IPlayFabRequestCommon {
1435
+ /** Specific model of the user's device. */
1436
+ AndroidDevice?: string;
1437
+ /** Android device identifier for the user's device. */
1438
+ AndroidDeviceId: string;
1439
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1440
+ CustomTags?: Record<string, string | null>;
1441
+ /** If another user is already linked to the device, unlink the other user and re-link. */
1442
+ ForceLink?: boolean;
1443
+ /** Specific Operating System version for the user's device. */
1444
+ OS?: string;
1445
+ }
1446
+ interface LinkAndroidDeviceIDResult extends IPlayFabResultCommon {
1447
+ }
1448
+ interface LinkAppleRequest extends IPlayFabRequestCommon {
1449
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1450
+ CustomTags?: Record<string, string | null>;
1451
+ /** If another user is already linked to a specific Apple account, unlink the other user and re-link. */
1452
+ ForceLink?: boolean;
1453
+ /**
1454
+ * The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization
1455
+ * credential payload. Used to validate the request and find the user ID (Apple subject) to link with.
1456
+ */
1457
+ IdentityToken: string;
1458
+ }
1459
+ interface LinkBattleNetAccountRequest extends IPlayFabRequestCommon {
1460
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1461
+ CustomTags?: Record<string, string | null>;
1462
+ /** If another user is already linked to a specific Battle.net account, unlink the other user and re-link. */
1463
+ ForceLink?: boolean;
1464
+ /** The JSON Web Token (JWT) returned by Battle.net after login */
1465
+ IdentityToken: string;
1466
+ }
1467
+ interface LinkCustomIDRequest extends IPlayFabRequestCommon {
1468
+ /** Custom unique identifier for the user, generated by the title. */
1469
+ CustomId: string;
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 the custom ID, unlink the other user and re-link. */
1473
+ ForceLink?: boolean;
1474
+ }
1475
+ interface LinkCustomIDResult extends IPlayFabResultCommon {
1476
+ }
1477
+ interface LinkedPlatformAccountModel {
1478
+ /** Linked account email of the user on the platform, if available */
1479
+ Email?: string;
1480
+ /** Authentication platform */
1481
+ Platform?: string;
1482
+ /** Unique account identifier of the user on the platform */
1483
+ PlatformUserId?: string;
1484
+ /** Linked account username of the user on the platform, if available */
1485
+ Username?: string;
1486
+ }
1487
+ interface LinkFacebookAccountRequest extends IPlayFabRequestCommon {
1488
+ /** Unique identifier from Facebook for the user. */
1489
+ AccessToken: string;
1490
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1491
+ CustomTags?: Record<string, string | null>;
1492
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1493
+ ForceLink?: boolean;
1494
+ }
1495
+ interface LinkFacebookAccountResult extends IPlayFabResultCommon {
1496
+ }
1497
+ interface LinkFacebookInstantGamesIdRequest extends IPlayFabRequestCommon {
1498
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1499
+ CustomTags?: Record<string, string | null>;
1500
+ /** Facebook Instant Games signature for the user. */
1501
+ FacebookInstantGamesSignature: string;
1502
+ /** If another user is already linked to the Facebook Instant Games ID, unlink the other user and re-link. */
1503
+ ForceLink?: boolean;
1504
+ }
1505
+ interface LinkFacebookInstantGamesIdResult extends IPlayFabResultCommon {
1506
+ }
1507
+ interface LinkGameCenterAccountRequest 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
+ /**
1511
+ * If another user is already linked to the account, unlink the other user and re-link. If the current user is already
1512
+ * linked, link both accounts
1513
+ */
1514
+ ForceLink?: boolean;
1515
+ /** Game Center identifier for the player account to be linked. */
1516
+ GameCenterId: string;
1517
+ /** The URL for the public encryption key that will be used to verify the signature. */
1518
+ PublicKeyUrl?: string;
1519
+ /** A random value used to compute the hash and keep it randomized. */
1520
+ Salt?: string;
1521
+ /** The verification signature of the authentication payload. */
1522
+ Signature?: string;
1523
+ /**
1524
+ * The integer representation of date and time that the signature was created on. PlayFab will reject authentication
1525
+ * signatures not within 10 minutes of the server's current time.
1526
+ */
1527
+ Timestamp?: string;
1528
+ }
1529
+ interface LinkGameCenterAccountResult extends IPlayFabResultCommon {
1530
+ }
1531
+ interface LinkGoogleAccountRequest extends IPlayFabRequestCommon {
1532
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1533
+ CustomTags?: Record<string, string | null>;
1534
+ /**
1535
+ * If another user is already linked to the account, unlink the other user and re-link. If the current user is already
1536
+ * linked, link both accounts
1537
+ */
1538
+ ForceLink?: boolean;
1539
+ /**
1540
+ * Server authentication code obtained on the client by calling getServerAuthCode()
1541
+ * (https://developers.google.com/identity/sign-in/android/offline-access) from Google Play for the user.
1542
+ */
1543
+ ServerAuthCode?: string;
1544
+ }
1545
+ interface LinkGoogleAccountResult extends IPlayFabResultCommon {
1546
+ }
1547
+ interface LinkGooglePlayGamesServicesAccountRequest extends IPlayFabRequestCommon {
1548
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1549
+ CustomTags?: Record<string, string | null>;
1550
+ /**
1551
+ * If another user is already linked to the account, unlink the other user and re-link. If the current user is already
1552
+ * linked, link both accounts
1553
+ */
1554
+ ForceLink?: boolean;
1555
+ /**
1556
+ * OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess()
1557
+ * (https://developers.google.com/games/services/android/signin) Google Play Games client API.
1558
+ */
1559
+ ServerAuthCode: string;
1560
+ }
1561
+ interface LinkGooglePlayGamesServicesAccountResult extends IPlayFabResultCommon {
1562
+ }
1563
+ interface LinkIOSDeviceIDRequest extends IPlayFabRequestCommon {
1564
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1565
+ CustomTags?: Record<string, string | null>;
1566
+ /** Vendor-specific iOS identifier for the user's device. */
1567
+ DeviceId: string;
1568
+ /** Specific model of the user's device. */
1569
+ DeviceModel?: string;
1570
+ /** If another user is already linked to the device, unlink the other user and re-link. */
1571
+ ForceLink?: boolean;
1572
+ /** Specific Operating System version for the user's device. */
1573
+ OS?: string;
1574
+ }
1575
+ interface LinkIOSDeviceIDResult extends IPlayFabResultCommon {
1576
+ }
1577
+ interface LinkKongregateAccountRequest extends IPlayFabRequestCommon {
1578
+ /** Valid session auth ticket issued by Kongregate */
1579
+ AuthTicket: string;
1580
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1581
+ CustomTags?: Record<string, string | null>;
1582
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1583
+ ForceLink?: boolean;
1584
+ /** Numeric user ID assigned by Kongregate */
1585
+ KongregateId: string;
1586
+ }
1587
+ interface LinkKongregateAccountResult extends IPlayFabResultCommon {
1588
+ }
1589
+ interface LinkNintendoServiceAccountRequest extends IPlayFabRequestCommon {
1590
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1591
+ CustomTags?: Record<string, string | null>;
1592
+ /** If another user is already linked to a specific Nintendo Switch account, unlink the other user and re-link. */
1593
+ ForceLink?: boolean;
1594
+ /**
1595
+ * The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo
1596
+ * Switch subject) to link with.
1597
+ */
1598
+ IdentityToken: string;
1599
+ }
1600
+ interface LinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
1601
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1602
+ CustomTags?: Record<string, string | null>;
1603
+ /** If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link. */
1604
+ ForceLink?: boolean;
1605
+ /** Nintendo Switch unique identifier for the user's device. */
1606
+ NintendoSwitchDeviceId: string;
1607
+ }
1608
+ interface LinkNintendoSwitchDeviceIdResult extends IPlayFabResultCommon {
1609
+ }
1610
+ interface LinkOpenIdConnectRequest extends IPlayFabRequestCommon {
1611
+ /** A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters. */
1612
+ ConnectionId: string;
1613
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1614
+ CustomTags?: Record<string, string | null>;
1615
+ /** If another user is already linked to a specific OpenId Connect user, unlink the other user and re-link. */
1616
+ ForceLink?: boolean;
1617
+ /**
1618
+ * The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the
1619
+ * identity provider's response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.
1620
+ */
1621
+ IdToken: string;
1622
+ }
1623
+ interface LinkPSNAccountRequest extends IPlayFabRequestCommon {
1624
+ /** Authentication code provided by the PlayStation :tm: Network. */
1625
+ AuthCode: string;
1626
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1627
+ CustomTags?: Record<string, string | null>;
1628
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1629
+ ForceLink?: boolean;
1630
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
1631
+ IssuerId?: number;
1632
+ /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
1633
+ RedirectUri: string;
1634
+ }
1635
+ interface LinkPSNAccountResult extends IPlayFabResultCommon {
1636
+ }
1637
+ interface LinkSteamAccountRequest extends IPlayFabRequestCommon {
1638
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1639
+ CustomTags?: Record<string, string | null>;
1640
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1641
+ ForceLink?: boolean;
1642
+ /**
1643
+ * Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte
1644
+ * 0x08 should become "08").
1645
+ */
1646
+ SteamTicket: string;
1647
+ /**
1648
+ * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string.
1649
+ * False if the ticket was generated with ISteamUser::GetAuthSessionTicket().
1650
+ */
1651
+ TicketIsServiceSpecific?: boolean;
1652
+ }
1653
+ interface LinkSteamAccountResult extends IPlayFabResultCommon {
1654
+ }
1655
+ interface LinkTwitchAccountRequest extends IPlayFabRequestCommon {
1656
+ /** Valid token issued by Twitch */
1657
+ AccessToken: string;
1658
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1659
+ CustomTags?: Record<string, string | null>;
1660
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1661
+ ForceLink?: boolean;
1662
+ }
1663
+ interface LinkTwitchAccountResult extends IPlayFabResultCommon {
1664
+ }
1665
+ interface LinkXboxAccountRequest extends IPlayFabRequestCommon {
1666
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1667
+ CustomTags?: Record<string, string | null>;
1668
+ /** If another user is already linked to the account, unlink the other user and re-link. */
1669
+ ForceLink?: boolean;
1670
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
1671
+ XboxToken: string;
1672
+ }
1673
+ interface LinkXboxAccountResult extends IPlayFabResultCommon {
1674
+ }
1675
+ interface ListPlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
1676
+ }
1677
+ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
1678
+ /** Player specific properties and their corresponding values for this title. */
1679
+ Properties?: CustomPropertyDetails[];
1680
+ /**
1681
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
1682
+ * deletes. This version can be provided in update and delete calls for concurrency control.
1683
+ */
1684
+ PropertiesVersion: number;
1685
+ }
1686
+ interface ListUsersCharactersRequest extends IPlayFabRequestCommon {
1687
+ /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
1688
+ PlayFabId?: string;
1689
+ }
1690
+ interface ListUsersCharactersResult extends IPlayFabResultCommon {
1691
+ /** The requested list of characters. */
1692
+ Characters?: CharacterResult[];
1693
+ }
1694
+ interface LocationModel {
1695
+ /** City name. */
1696
+ City?: string;
1697
+ /** The two-character continent code for this location */
1698
+ ContinentCode?: string;
1699
+ /** The two-character ISO 3166-1 country code for the country associated with the location */
1700
+ CountryCode?: string;
1701
+ /** Latitude coordinate of the geographic location. */
1702
+ Latitude?: number;
1703
+ /** Longitude coordinate of the geographic location. */
1704
+ Longitude?: number;
1705
+ }
1706
+ interface LoginResult extends IPlayFabResultCommon {
1707
+ /**
1708
+ * If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and
1709
+ * returned.
1710
+ */
1711
+ EntityToken?: EntityTokenResponse;
1712
+ /** Results for requested info. */
1713
+ InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
1714
+ /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */
1715
+ LastLoginTime?: string;
1716
+ /** True if the master_player_account was newly created on this login. */
1717
+ NewlyCreated: boolean;
1718
+ /** Player's unique PlayFabId. */
1719
+ PlayFabId?: string;
1720
+ /** Unique token authorizing the user and game at the server level, for the current session. */
1721
+ SessionTicket?: string;
1722
+ /** Settings specific to this user. */
1723
+ SettingsForUser?: UserSettings;
1724
+ /** The experimentation treatments for this user at the time of login. */
1725
+ TreatmentAssignment?: TreatmentAssignment;
1726
+ }
1727
+ interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
1728
+ /** Specific model of the user's device. */
1729
+ AndroidDevice?: string;
1730
+ /** Android device identifier for the user's device. */
1731
+ AndroidDeviceId?: string;
1732
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1733
+ CreateAccount?: boolean;
1734
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1735
+ CustomTags?: Record<string, string | null>;
1736
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1737
+ EncryptedRequest?: string;
1738
+ /** Flags for which pieces of info to return for the user. */
1739
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1740
+ /** Specific Operating System version for the user's device. */
1741
+ OS?: string;
1742
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1743
+ PlayerSecret?: string;
1744
+ /**
1745
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1746
+ * title has been selected.
1747
+ */
1748
+ TitleId?: string;
1749
+ }
1750
+ interface LoginWithAppleRequest extends IPlayFabRequestCommon {
1751
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1752
+ CreateAccount?: boolean;
1753
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1754
+ CustomTags?: Record<string, string | null>;
1755
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1756
+ EncryptedRequest?: string;
1757
+ /**
1758
+ * The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization
1759
+ * credential payload. If you choose to ignore the expiration date for identity tokens, you will receive an NotAuthorized
1760
+ * error if Apple rotates the signing key. In this case, users have to login to provide a fresh identity token.
1761
+ */
1762
+ IdentityToken: string;
1763
+ /** Flags for which pieces of info to return for the user. */
1764
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1765
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1766
+ PlayerSecret?: string;
1767
+ /**
1768
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1769
+ * title has been selected.
1770
+ */
1771
+ TitleId?: string;
1772
+ }
1773
+ interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
1774
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1775
+ CreateAccount?: boolean;
1776
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1777
+ CustomTags?: Record<string, string | null>;
1778
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1779
+ EncryptedRequest?: string;
1780
+ /** The JSON Web Token (JWT) returned by Battle.net after login */
1781
+ IdentityToken: string;
1782
+ /** Flags for which pieces of info to return for the user. */
1783
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1784
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1785
+ PlayerSecret?: string;
1786
+ /**
1787
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1788
+ * title has been selected.
1789
+ */
1790
+ TitleId?: string;
1791
+ }
1792
+ interface LoginWithCustomIDRequest extends IPlayFabRequestCommon {
1793
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1794
+ CreateAccount?: boolean;
1795
+ /** Custom unique identifier for the user, generated by the title. */
1796
+ CustomId?: string;
1797
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1798
+ CustomTags?: Record<string, string | null>;
1799
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1800
+ EncryptedRequest?: string;
1801
+ /** Flags for which pieces of info to return for the user. */
1802
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1803
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1804
+ PlayerSecret?: string;
1805
+ /**
1806
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1807
+ * title has been selected.
1808
+ */
1809
+ TitleId?: string;
1810
+ }
1811
+ interface LoginWithEmailAddressRequest extends IPlayFabRequestCommon {
1812
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1813
+ CustomTags?: Record<string, string | null>;
1814
+ /** Email address for the account. */
1815
+ Email: string;
1816
+ /** Flags for which pieces of info to return for the user. */
1817
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1818
+ /** Password for the PlayFab account (6-100 characters) */
1819
+ Password: string;
1820
+ /**
1821
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1822
+ * title has been selected.
1823
+ */
1824
+ TitleId?: string;
1825
+ }
1826
+ interface LoginWithFacebookInstantGamesIdRequest extends IPlayFabRequestCommon {
1827
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1828
+ CreateAccount?: boolean;
1829
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1830
+ CustomTags?: Record<string, string | null>;
1831
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1832
+ EncryptedRequest?: string;
1833
+ /** Facebook Instant Games signature for the user. */
1834
+ FacebookInstantGamesSignature: string;
1835
+ /** Flags for which pieces of info to return for the user. */
1836
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1837
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1838
+ PlayerSecret?: string;
1839
+ /**
1840
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1841
+ * title has been selected.
1842
+ */
1843
+ TitleId?: string;
1844
+ }
1845
+ interface LoginWithFacebookRequest extends IPlayFabRequestCommon {
1846
+ /** Unique identifier from Facebook for the user. */
1847
+ AccessToken?: string;
1848
+ /** Token used for limited login authentication. */
1849
+ AuthenticationToken?: string;
1850
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1851
+ CreateAccount?: boolean;
1852
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1853
+ CustomTags?: Record<string, string | null>;
1854
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1855
+ EncryptedRequest?: string;
1856
+ /** Flags for which pieces of info to return for the user. */
1857
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1858
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1859
+ PlayerSecret?: string;
1860
+ /**
1861
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1862
+ * title has been selected.
1863
+ */
1864
+ TitleId?: string;
1865
+ }
1866
+ interface LoginWithGameCenterRequest extends IPlayFabRequestCommon {
1867
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1868
+ CreateAccount?: boolean;
1869
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1870
+ CustomTags?: Record<string, string | null>;
1871
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1872
+ EncryptedRequest?: string;
1873
+ /** Flags for which pieces of info to return for the user. */
1874
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1875
+ /** Unique Game Center player id. */
1876
+ PlayerId?: string;
1877
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1878
+ PlayerSecret?: string;
1879
+ /** The URL for the public encryption key that will be used to verify the signature. */
1880
+ PublicKeyUrl?: string;
1881
+ /** A random value used to compute the hash and keep it randomized. */
1882
+ Salt?: string;
1883
+ /** The verification signature of the authentication payload. */
1884
+ Signature?: string;
1885
+ /**
1886
+ * The integer representation of date and time that the signature was created on. PlayFab will reject authentication
1887
+ * signatures not within 10 minutes of the server's current time.
1888
+ */
1889
+ Timestamp?: string;
1890
+ /**
1891
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1892
+ * title has been selected.
1893
+ */
1894
+ TitleId?: string;
1895
+ }
1896
+ interface LoginWithGoogleAccountRequest extends IPlayFabRequestCommon {
1897
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1898
+ CreateAccount?: boolean;
1899
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1900
+ CustomTags?: Record<string, string | null>;
1901
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1902
+ EncryptedRequest?: string;
1903
+ /** Flags for which pieces of info to return for the user. */
1904
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1905
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1906
+ PlayerSecret?: string;
1907
+ /**
1908
+ * OAuth 2.0 server authentication code obtained on the client by calling the getServerAuthCode()
1909
+ * (https://developers.google.com/identity/sign-in/android/offline-access) Google client API.
1910
+ */
1911
+ ServerAuthCode?: string;
1912
+ /** Optional boolean to opt out of setting the MPA email when creating a Google account, defaults to true. */
1913
+ SetEmail?: boolean;
1914
+ /**
1915
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1916
+ * title has been selected.
1917
+ */
1918
+ TitleId?: string;
1919
+ }
1920
+ interface LoginWithGooglePlayGamesServicesRequest extends IPlayFabRequestCommon {
1921
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1922
+ CreateAccount?: boolean;
1923
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1924
+ CustomTags?: Record<string, string | null>;
1925
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1926
+ EncryptedRequest?: string;
1927
+ /** Flags for which pieces of info to return for the user. */
1928
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1929
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1930
+ PlayerSecret?: string;
1931
+ /**
1932
+ * OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess()
1933
+ * (https://developers.google.com/games/services/android/signin) Google Play Games client API.
1934
+ */
1935
+ ServerAuthCode?: string;
1936
+ /**
1937
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1938
+ * title has been selected.
1939
+ */
1940
+ TitleId?: string;
1941
+ }
1942
+ interface LoginWithIOSDeviceIDRequest extends IPlayFabRequestCommon {
1943
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1944
+ CreateAccount?: boolean;
1945
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1946
+ CustomTags?: Record<string, string | null>;
1947
+ /** Vendor-specific iOS identifier for the user's device. */
1948
+ DeviceId?: string;
1949
+ /** Specific model of the user's device. */
1950
+ DeviceModel?: string;
1951
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1952
+ EncryptedRequest?: string;
1953
+ /** Flags for which pieces of info to return for the user. */
1954
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1955
+ /** Specific Operating System version for the user's device. */
1956
+ OS?: string;
1957
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1958
+ PlayerSecret?: string;
1959
+ /**
1960
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1961
+ * title has been selected.
1962
+ */
1963
+ TitleId?: string;
1964
+ }
1965
+ interface LoginWithKongregateRequest extends IPlayFabRequestCommon {
1966
+ /** Token issued by Kongregate's client API for the user. */
1967
+ AuthTicket?: string;
1968
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1969
+ CreateAccount?: boolean;
1970
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1971
+ CustomTags?: Record<string, string | null>;
1972
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1973
+ EncryptedRequest?: string;
1974
+ /** Flags for which pieces of info to return for the user. */
1975
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1976
+ /** Numeric user ID assigned by Kongregate */
1977
+ KongregateId?: string;
1978
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1979
+ PlayerSecret?: string;
1980
+ /**
1981
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1982
+ * title has been selected.
1983
+ */
1984
+ TitleId?: string;
1985
+ }
1986
+ interface LoginWithNintendoServiceAccountRequest extends IPlayFabRequestCommon {
1987
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1988
+ CreateAccount?: boolean;
1989
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1990
+ CustomTags?: Record<string, string | null>;
1991
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
1992
+ EncryptedRequest?: string;
1993
+ /** The JSON Web token (JWT) returned by Nintendo after login. */
1994
+ IdentityToken: string;
1995
+ /** Flags for which pieces of info to return for the user. */
1996
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1997
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
1998
+ PlayerSecret?: string;
1999
+ /**
2000
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2001
+ * title has been selected.
2002
+ */
2003
+ TitleId?: string;
2004
+ }
2005
+ interface LoginWithNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
2006
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2007
+ CreateAccount?: boolean;
2008
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2009
+ CustomTags?: Record<string, string | null>;
2010
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2011
+ EncryptedRequest?: string;
2012
+ /** Flags for which pieces of info to return for the user. */
2013
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2014
+ /** Nintendo Switch unique identifier for the user's device. */
2015
+ NintendoSwitchDeviceId?: string;
2016
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2017
+ PlayerSecret?: string;
2018
+ /**
2019
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2020
+ * title has been selected.
2021
+ */
2022
+ TitleId?: string;
2023
+ }
2024
+ interface LoginWithOpenIdConnectRequest extends IPlayFabRequestCommon {
2025
+ /** A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters. */
2026
+ ConnectionId: string;
2027
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2028
+ CreateAccount?: boolean;
2029
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2030
+ CustomTags?: Record<string, string | null>;
2031
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2032
+ EncryptedRequest?: string;
2033
+ /**
2034
+ * The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the
2035
+ * identity provider's response.
2036
+ */
2037
+ IdToken: string;
2038
+ /** Flags for which pieces of info to return for the user. */
2039
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2040
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2041
+ PlayerSecret?: string;
2042
+ /**
2043
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2044
+ * title has been selected.
2045
+ */
2046
+ TitleId?: string;
2047
+ }
2048
+ interface LoginWithPlayFabRequest extends IPlayFabRequestCommon {
2049
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2050
+ CustomTags?: Record<string, string | null>;
2051
+ /** Flags for which pieces of info to return for the user. */
2052
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2053
+ /** Password for the PlayFab account (6-100 characters) */
2054
+ Password: string;
2055
+ /**
2056
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2057
+ * title has been selected.
2058
+ */
2059
+ TitleId?: string;
2060
+ /** PlayFab username for the account. */
2061
+ Username: string;
2062
+ }
2063
+ interface LoginWithPSNRequest extends IPlayFabRequestCommon {
2064
+ /** Auth code provided by the PlayStation :tm: Network OAuth provider. */
2065
+ AuthCode?: string;
2066
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2067
+ CreateAccount?: boolean;
2068
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2069
+ CustomTags?: Record<string, string | null>;
2070
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2071
+ EncryptedRequest?: string;
2072
+ /** Flags for which pieces of info to return for the user. */
2073
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2074
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
2075
+ IssuerId?: number;
2076
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2077
+ PlayerSecret?: string;
2078
+ /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
2079
+ RedirectUri?: string;
2080
+ /**
2081
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2082
+ * title has been selected.
2083
+ */
2084
+ TitleId?: string;
2085
+ }
2086
+ interface LoginWithSteamRequest extends IPlayFabRequestCommon {
2087
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2088
+ CreateAccount?: boolean;
2089
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2090
+ CustomTags?: Record<string, string | null>;
2091
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2092
+ EncryptedRequest?: string;
2093
+ /** Flags for which pieces of info to return for the user. */
2094
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2095
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2096
+ PlayerSecret?: string;
2097
+ /**
2098
+ * Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte
2099
+ * 0x08 should become "08").
2100
+ */
2101
+ SteamTicket?: string;
2102
+ /**
2103
+ * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string.
2104
+ * False if the ticket was generated with ISteamUser::GetAuthSessionTicket().
2105
+ */
2106
+ TicketIsServiceSpecific?: boolean;
2107
+ /**
2108
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2109
+ * title has been selected.
2110
+ */
2111
+ TitleId?: string;
2112
+ }
2113
+ interface LoginWithTwitchRequest extends IPlayFabRequestCommon {
2114
+ /** Token issued by Twitch's API for the user. */
2115
+ AccessToken?: string;
2116
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2117
+ CreateAccount?: boolean;
2118
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2119
+ CustomTags?: Record<string, string | null>;
2120
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2121
+ EncryptedRequest?: string;
2122
+ /** Flags for which pieces of info to return for the user. */
2123
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2124
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2125
+ PlayerSecret?: string;
2126
+ /**
2127
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2128
+ * title has been selected.
2129
+ */
2130
+ TitleId?: string;
2131
+ }
2132
+ interface LoginWithXboxRequest extends IPlayFabRequestCommon {
2133
+ /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2134
+ CreateAccount?: boolean;
2135
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2136
+ CustomTags?: Record<string, string | null>;
2137
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2138
+ EncryptedRequest?: string;
2139
+ /** Flags for which pieces of info to return for the user. */
2140
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2141
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2142
+ PlayerSecret?: string;
2143
+ /**
2144
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2145
+ * title has been selected.
2146
+ */
2147
+ TitleId?: string;
2148
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
2149
+ XboxToken?: string;
2150
+ }
2151
+ interface LogStatement {
2152
+ /** Optional object accompanying the message as contextual information */
2153
+ Data?: any;
2154
+ /** 'Debug', 'Info', or 'Error' */
2155
+ Level?: string;
2156
+ Message?: string;
2157
+ }
2158
+ interface MembershipModel {
2159
+ /** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
2160
+ IsActive: boolean;
2161
+ /** The time this membership expires */
2162
+ MembershipExpiration: string;
2163
+ /** The id of the membership */
2164
+ MembershipId?: string;
2165
+ /**
2166
+ * Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been
2167
+ * overridden, this will be the new expiration time.
2168
+ */
2169
+ OverrideExpiration?: string;
2170
+ /** The list of subscriptions that this player has for this membership */
2171
+ Subscriptions?: SubscriptionModel[];
2172
+ }
2173
+ interface MicrosoftStorePayload {
2174
+ /** Microsoft store ID key. This is optional. Alternatively you can use XboxToken */
2175
+ CollectionsMsIdKey?: string;
2176
+ /** If collectionsMsIdKey is provided, this will verify the user id in the collectionsMsIdKey is the same. */
2177
+ UserId?: string;
2178
+ /**
2179
+ * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). This is
2180
+ * optional. Alternatively can use CollectionsMsIdKey
2181
+ */
2182
+ XboxToken?: string;
2183
+ }
2184
+ interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
2185
+ /** Balance of the virtual currency after modification. */
2186
+ Balance: number;
2187
+ /**
2188
+ * Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
2189
+ * over this value will be discarded.
2190
+ */
2191
+ BalanceChange: number;
2192
+ /** User currency was subtracted from. */
2193
+ PlayFabId?: string;
2194
+ /** Name of the virtual currency which was modified. */
2195
+ VirtualCurrency?: string;
2196
+ }
2197
+ interface NameIdentifier {
2198
+ /** Id Identifier, if present */
2199
+ Id?: string;
2200
+ /** Name Identifier, if present */
2201
+ Name?: string;
2202
+ }
2203
+ interface NintendoServiceAccountPlayFabIdPair {
2204
+ /** Unique Nintendo Switch Service Account identifier for a user. */
2205
+ NintendoServiceAccountId?: string;
2206
+ /**
2207
+ * Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Service Account
2208
+ * identifier.
2209
+ */
2210
+ PlayFabId?: string;
2211
+ }
2212
+ interface NintendoSwitchPlayFabIdPair {
2213
+ /** Unique Nintendo Switch Device identifier for a user. */
2214
+ NintendoSwitchDeviceId?: string;
2215
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier. */
2216
+ PlayFabId?: string;
2217
+ }
2218
+ interface OpenTradeRequest extends IPlayFabRequestCommon {
2219
+ /**
2220
+ * Players who are allowed to accept the trade. If null, the trade may be accepted by any player. If empty, the trade may
2221
+ * not be accepted by any player.
2222
+ */
2223
+ AllowedPlayerIds?: string[];
2224
+ /** Player inventory items offered for trade. If not set, the trade is effectively a gift request */
2225
+ OfferedInventoryInstanceIds?: string[];
2226
+ /** Catalog items accepted for the trade. If not set, the trade is effectively a gift. */
2227
+ RequestedCatalogItemIds?: string[];
2228
+ }
2229
+ interface OpenTradeResponse extends IPlayFabResultCommon {
2230
+ /** The information about the trade that was just opened. */
2231
+ Trade?: TradeInfo;
2232
+ }
2233
+ interface PayForPurchaseRequest extends IPlayFabRequestCommon {
2234
+ /** Currency to use to fund the purchase. */
2235
+ Currency: string;
2236
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2237
+ CustomTags?: Record<string, string | null>;
2238
+ /** Purchase order identifier returned from StartPurchase. */
2239
+ OrderId: string;
2240
+ /** Payment provider to use to fund the purchase. */
2241
+ ProviderName: string;
2242
+ /** Payment provider transaction identifier. Required for Facebook Payments. */
2243
+ ProviderTransactionId?: string;
2244
+ }
2245
+ interface PayForPurchaseResult extends IPlayFabResultCommon {
2246
+ /** Local credit applied to the transaction (provider specific). */
2247
+ CreditApplied: number;
2248
+ /** Purchase order identifier. */
2249
+ OrderId?: string;
2250
+ /** Provider used for the transaction. */
2251
+ ProviderData?: string;
2252
+ /** A token generated by the provider to authenticate the request (provider-specific). */
2253
+ ProviderToken?: string;
2254
+ /** URL to the purchase provider page that details the purchase. */
2255
+ PurchaseConfirmationPageURL?: string;
2256
+ /** Currency for the transaction, may be a virtual currency or real money. */
2257
+ PurchaseCurrency?: string;
2258
+ /** Cost of the transaction. */
2259
+ PurchasePrice: number;
2260
+ /** Status of the transaction. */
2261
+ Status?: string;
2262
+ /** Virtual currencies granted by the transaction, if any. */
2263
+ VCAmount?: Record<string, number>;
2264
+ /** Current virtual currency balances for the user. */
2265
+ VirtualCurrency?: Record<string, number>;
2266
+ }
2267
+ interface PaymentOption {
2268
+ /** Specific currency to use to fund the purchase. */
2269
+ Currency?: string;
2270
+ /** Amount of the specified currency needed for the purchase. */
2271
+ Price: number;
2272
+ /** Name of the purchase provider for this option. */
2273
+ ProviderName?: string;
2274
+ /** Amount of existing credit the user has with the provider. */
2275
+ StoreCredit: number;
2276
+ }
2277
+ interface PlayerLeaderboardEntry {
2278
+ /** Title-specific display name of the user for this leaderboard entry. */
2279
+ DisplayName?: string;
2280
+ /** PlayFab unique identifier of the user for this leaderboard entry. */
2281
+ PlayFabId?: string;
2282
+ /** User's overall position in the leaderboard. */
2283
+ Position: number;
2284
+ /** The profile of the user, if requested. */
2285
+ Profile?: PlayerProfileModel;
2286
+ /** Specific value of the user's statistic. */
2287
+ StatValue: number;
2288
+ }
2289
+ interface PlayerProfileModel {
2290
+ /** List of advertising campaigns the player has been attributed to */
2291
+ AdCampaignAttributions?: AdCampaignAttributionModel[];
2292
+ /** URL of the player's avatar image */
2293
+ AvatarUrl?: string;
2294
+ /** If the player is currently banned, the UTC Date when the ban expires */
2295
+ BannedUntil?: string;
2296
+ /** List of all contact email info associated with the player account */
2297
+ ContactEmailAddresses?: ContactEmailInfoModel[];
2298
+ /** Player record created */
2299
+ Created?: string;
2300
+ /** Player display name */
2301
+ DisplayName?: string;
2302
+ /**
2303
+ * List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned
2304
+ * during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment
2305
+ * property during login to get the correct variants and variables.
2306
+ */
2307
+ ExperimentVariants?: string[];
2308
+ /** UTC time when the player most recently logged in to the title */
2309
+ LastLogin?: string;
2310
+ /** List of all authentication systems linked to this player account */
2311
+ LinkedAccounts?: LinkedPlatformAccountModel[];
2312
+ /** List of geographic locations from which the player has logged in to the title */
2313
+ Locations?: LocationModel[];
2314
+ /** List of memberships for the player, along with whether are expired. */
2315
+ Memberships?: MembershipModel[];
2316
+ /** Player account origination */
2317
+ Origination?: string;
2318
+ /** PlayFab player account unique identifier */
2319
+ PlayerId?: string;
2320
+ /** Publisher this player belongs to */
2321
+ PublisherId?: string;
2322
+ /** List of configured end points registered for sending the player push notifications */
2323
+ PushNotificationRegistrations?: PushNotificationRegistrationModel[];
2324
+ /** List of leaderboard statistic values for the player */
2325
+ Statistics?: StatisticModel[];
2326
+ /** List of player's tags for segmentation */
2327
+ Tags?: TagModel[];
2328
+ /** Title ID this player profile applies to */
2329
+ TitleId?: string;
2330
+ /**
2331
+ * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
2332
+ * whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
2333
+ */
2334
+ TotalValueToDateInUSD?: number;
2335
+ /** List of the player's lifetime purchase totals, summed by real-money currency */
2336
+ ValuesToDate?: ValueToDateModel[];
2337
+ }
2338
+ interface PlayerProfileViewConstraints {
2339
+ /** Whether to show player's avatar URL. Defaults to false */
2340
+ ShowAvatarUrl: boolean;
2341
+ /** Whether to show the banned until time. Defaults to false */
2342
+ ShowBannedUntil: boolean;
2343
+ /** Whether to show campaign attributions. Defaults to false */
2344
+ ShowCampaignAttributions: boolean;
2345
+ /** Whether to show contact email addresses. Defaults to false */
2346
+ ShowContactEmailAddresses: boolean;
2347
+ /** Whether to show the created date. Defaults to false */
2348
+ ShowCreated: boolean;
2349
+ /** Whether to show the display name. Defaults to false */
2350
+ ShowDisplayName: boolean;
2351
+ /** Whether to show player's experiment variants. Defaults to false */
2352
+ ShowExperimentVariants: boolean;
2353
+ /** Whether to show the last login time. Defaults to false */
2354
+ ShowLastLogin: boolean;
2355
+ /** Whether to show the linked accounts. Defaults to false */
2356
+ ShowLinkedAccounts: boolean;
2357
+ /** Whether to show player's locations. Defaults to false */
2358
+ ShowLocations: boolean;
2359
+ /** Whether to show player's membership information. Defaults to false */
2360
+ ShowMemberships: boolean;
2361
+ /** Whether to show origination. Defaults to false */
2362
+ ShowOrigination: boolean;
2363
+ /** Whether to show push notification registrations. Defaults to false */
2364
+ ShowPushNotificationRegistrations: boolean;
2365
+ /** Reserved for future development */
2366
+ ShowStatistics: boolean;
2367
+ /** Whether to show tags. Defaults to false */
2368
+ ShowTags: boolean;
2369
+ /** Whether to show the total value to date in usd. Defaults to false */
2370
+ ShowTotalValueToDateInUsd: boolean;
2371
+ /** Whether to show the values to date. Defaults to false */
2372
+ ShowValuesToDate: boolean;
2373
+ }
2374
+ interface PlayerStatisticVersion {
2375
+ /** time when the statistic version became active */
2376
+ ActivationTime: string;
2377
+ /** time when the statistic version became inactive due to statistic version incrementing */
2378
+ DeactivationTime?: string;
2379
+ /** time at which the statistic version was scheduled to become active, based on the configured ResetInterval */
2380
+ ScheduledActivationTime?: string;
2381
+ /** time at which the statistic version was scheduled to become inactive, based on the configured ResetInterval */
2382
+ ScheduledDeactivationTime?: string;
2383
+ /** name of the statistic when the version became active */
2384
+ StatisticName?: string;
2385
+ /** version of the statistic */
2386
+ Version: number;
2387
+ }
2388
+ interface PlayStation5Payload {
2389
+ /** An optional list of entitlement ids to query against PlayStation :tm: Network */
2390
+ Ids?: string[];
2391
+ /** Id of the PlayStation :tm: Network service label to consume entitlements from */
2392
+ ServiceLabel?: string;
2393
+ }
2394
+ interface PSNAccountPlayFabIdPair {
2395
+ /**
2396
+ * Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation :tm: Network
2397
+ * identifier.
2398
+ */
2399
+ PlayFabId?: string;
2400
+ /** Unique PlayStation :tm: Network identifier for a user. */
2401
+ PSNAccountId?: string;
2402
+ }
2403
+ interface PSNOnlinePlayFabIdPair {
2404
+ /**
2405
+ * Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the PlayStation :tm: Network
2406
+ * identifier.
2407
+ */
2408
+ PlayFabId?: string;
2409
+ /** Unique PlayStation :tm: Network identifier for a user. */
2410
+ PSNOnlineId?: string;
2411
+ }
2412
+ interface PurchaseItemRequest extends IPlayFabRequestCommon {
2413
+ /** Catalog version for the items to be purchased (defaults to most recent version. */
2414
+ CatalogVersion?: string;
2415
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2416
+ CharacterId?: string;
2417
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2418
+ CustomTags?: Record<string, string | null>;
2419
+ /** Unique identifier of the item to purchase. */
2420
+ ItemId: string;
2421
+ /** Price the client expects to pay for the item (in case a new catalog or store was uploaded, with new prices). */
2422
+ Price: number;
2423
+ /** Store to buy this item through. If not set, prices default to those in the catalog. */
2424
+ StoreId?: string;
2425
+ /** Virtual currency to use to purchase the item. */
2426
+ VirtualCurrency: string;
2427
+ }
2428
+ interface PurchaseItemResult extends IPlayFabResultCommon {
2429
+ /** Details for the items purchased. */
2430
+ Items?: ItemInstance[];
2431
+ }
2432
+ interface PurchaseReceiptFulfillment {
2433
+ /** Items granted to the player in fulfillment of the validated receipt. */
2434
+ FulfilledItems?: ItemInstance[];
2435
+ /**
2436
+ * Source of the payment price information for the recorded purchase transaction. A value of 'Request' indicates that the
2437
+ * price specified in the request was used, whereas a value of 'Catalog' indicates that the real-money price of the catalog
2438
+ * item matching the product ID in the validated receipt transaction and the currency specified in the request (defaulting
2439
+ * to USD) was used.
2440
+ */
2441
+ RecordedPriceSource?: string;
2442
+ /** Currency used to purchase the items (ISO 4217 currency code). */
2443
+ RecordedTransactionCurrency?: string;
2444
+ /** Amount of the stated currency paid for the items, in centesimal units */
2445
+ RecordedTransactionTotal?: number;
2446
+ }
2447
+ interface PushNotificationRegistrationModel {
2448
+ /** Notification configured endpoint */
2449
+ NotificationEndpointARN?: string;
2450
+ /** Push notification platform */
2451
+ Platform?: string;
2452
+ }
2453
+ interface RedeemCouponRequest extends IPlayFabRequestCommon {
2454
+ /** Catalog version of the coupon. If null, uses the default catalog */
2455
+ CatalogVersion?: string;
2456
+ /** Optional identifier for the Character that should receive the item. If null, item is added to the player */
2457
+ CharacterId?: string;
2458
+ /** Generated coupon code to redeem. */
2459
+ CouponCode: string;
2460
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2461
+ CustomTags?: Record<string, string | null>;
2462
+ }
2463
+ interface RedeemCouponResult extends IPlayFabResultCommon {
2464
+ /** Items granted to the player as a result of redeeming the coupon. */
2465
+ GrantedItems?: ItemInstance[];
2466
+ }
2467
+ interface RefreshPSNAuthTokenRequest extends IPlayFabRequestCommon {
2468
+ /** Auth code returned by PlayStation :tm: Network OAuth system. */
2469
+ AuthCode: string;
2470
+ /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
2471
+ IssuerId?: number;
2472
+ /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
2473
+ RedirectUri: string;
2474
+ }
2475
+ interface RegisterForIOSPushNotificationRequest extends IPlayFabRequestCommon {
2476
+ /** Message to display when confirming push notification. */
2477
+ ConfirmationMessage?: string;
2478
+ /** Unique token generated by the Apple Push Notification service when the title registered to receive push notifications. */
2479
+ DeviceToken: string;
2480
+ /** If true, send a test push message immediately after sucessful registration. Defaults to false. */
2481
+ SendPushNotificationConfirmation?: boolean;
2482
+ }
2483
+ interface RegisterForIOSPushNotificationResult extends IPlayFabResultCommon {
2484
+ }
2485
+ interface RegisterPlayFabUserRequest 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
+ /** An optional parameter for setting the display name for this title (3-25 characters). */
2489
+ DisplayName?: string;
2490
+ /** User email address attached to their account */
2491
+ Email?: string;
2492
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2493
+ EncryptedRequest?: string;
2494
+ /** Flags for which pieces of info to return for the user. */
2495
+ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2496
+ /** Password for the PlayFab account (6-100 characters) */
2497
+ Password?: string;
2498
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2499
+ PlayerSecret?: string;
2500
+ /**
2501
+ * An optional parameter that specifies whether both the username and email parameters are required. If true, both
2502
+ * parameters are required; if false, the user must supply either the username or email parameter. The default value is
2503
+ * true.
2504
+ */
2505
+ RequireBothUsernameAndEmail?: boolean;
2506
+ /**
2507
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2508
+ * title has been selected.
2509
+ */
2510
+ TitleId?: string;
2511
+ /** PlayFab username for the account (3-20 characters) */
2512
+ Username?: string;
2513
+ }
2514
+ interface RegisterPlayFabUserResult extends IPlayFabResultCommon {
2515
+ /**
2516
+ * If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and
2517
+ * returned.
2518
+ */
2519
+ EntityToken?: EntityTokenResponse;
2520
+ /** PlayFab unique identifier for this newly created account. */
2521
+ PlayFabId?: string;
2522
+ /** Unique token identifying the user and game at the server level, for the current session. */
2523
+ SessionTicket?: string;
2524
+ /** Settings specific to this user. */
2525
+ SettingsForUser?: UserSettings;
2526
+ /** PlayFab unique user name. */
2527
+ Username?: string;
2528
+ }
2529
+ interface RemoveContactEmailRequest extends IPlayFabRequestCommon {
2530
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2531
+ CustomTags?: Record<string, string | null>;
2532
+ }
2533
+ interface RemoveContactEmailResult extends IPlayFabResultCommon {
2534
+ }
2535
+ interface RemoveFriendRequest extends IPlayFabRequestCommon {
2536
+ /** PlayFab identifier of the friend account which is to be removed. */
2537
+ FriendPlayFabId: string;
2538
+ }
2539
+ interface RemoveFriendResult extends IPlayFabResultCommon {
2540
+ }
2541
+ interface RemoveGenericIDRequest extends IPlayFabRequestCommon {
2542
+ /** Generic service identifier to be removed from the player. */
2543
+ GenericId: GenericServiceId;
2544
+ }
2545
+ interface RemoveGenericIDResult extends IPlayFabResultCommon {
2546
+ }
2547
+ interface RemoveSharedGroupMembersRequest extends IPlayFabRequestCommon {
2548
+ /** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
2549
+ PlayFabIds: string[];
2550
+ /** Unique identifier for the shared group. */
2551
+ SharedGroupId: string;
2552
+ }
2553
+ interface RemoveSharedGroupMembersResult extends IPlayFabResultCommon {
2554
+ }
2555
+ interface ReportAdActivityRequest extends IPlayFabRequestCommon {
2556
+ /** Type of activity, may be Opened, Closed, Start or End */
2557
+ Activity: string;
2558
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2559
+ CustomTags?: Record<string, string | null>;
2560
+ /** Unique ID of the placement to report for */
2561
+ PlacementId: string;
2562
+ /** Unique ID of the reward the player was offered */
2563
+ RewardId: string;
2564
+ }
2565
+ interface ReportAdActivityResult extends IPlayFabResultCommon {
2566
+ }
2567
+ interface ReportPlayerClientRequest extends IPlayFabRequestCommon {
2568
+ /** Optional additional comment by reporting player. */
2569
+ Comment?: string;
2570
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2571
+ CustomTags?: Record<string, string | null>;
2572
+ /** Unique PlayFab identifier of the reported player. */
2573
+ ReporteeId: string;
2574
+ }
2575
+ interface ReportPlayerClientResult extends IPlayFabResultCommon {
2576
+ /** The number of remaining reports which may be filed today. */
2577
+ SubmissionsRemaining: number;
2578
+ }
2579
+ interface RestoreIOSPurchasesRequest extends IPlayFabRequestCommon {
2580
+ /** Catalog version of the restored items. If null, defaults to primary catalog. */
2581
+ CatalogVersion?: string;
2582
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2583
+ CustomTags?: Record<string, string | null>;
2584
+ /** Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase. */
2585
+ ReceiptData: string;
2586
+ }
2587
+ interface RestoreIOSPurchasesResult extends IPlayFabResultCommon {
2588
+ /** Fulfilled inventory items and recorded purchases in fulfillment of the validated receipt transactions. */
2589
+ Fulfillments?: PurchaseReceiptFulfillment[];
2590
+ }
2591
+ interface RewardAdActivityRequest extends IPlayFabRequestCommon {
2592
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2593
+ CustomTags?: Record<string, string | null>;
2594
+ /** Placement unique ID */
2595
+ PlacementId: string;
2596
+ /** Reward unique ID */
2597
+ RewardId: string;
2598
+ }
2599
+ interface RewardAdActivityResult extends IPlayFabResultCommon {
2600
+ /** PlayStream Event ID that was generated by this reward (all subsequent events are associated with this event identifier) */
2601
+ AdActivityEventId?: string;
2602
+ /** Debug results from the grants */
2603
+ DebugResults?: string[];
2604
+ /** Id of the placement the reward was for */
2605
+ PlacementId?: string;
2606
+ /** Name of the placement the reward was for */
2607
+ PlacementName?: string;
2608
+ /** If placement has viewing limits indicates how many views are left */
2609
+ PlacementViewsRemaining?: number;
2610
+ /** If placement has viewing limits indicates when they will next reset */
2611
+ PlacementViewsResetMinutes?: number;
2612
+ /** Reward results */
2613
+ RewardResults?: AdRewardResults;
2614
+ }
2615
+ interface ScriptExecutionError {
2616
+ /**
2617
+ * Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
2618
+ * CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, or CloudScriptHTTPRequestError
2619
+ */
2620
+ Error?: string;
2621
+ /** Details about the error */
2622
+ Message?: string;
2623
+ /** Point during the execution of the script at which the error occurred, if any */
2624
+ StackTrace?: string;
2625
+ }
2626
+ interface SendAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
2627
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2628
+ CustomTags?: Record<string, string | null>;
2629
+ /** User email address attached to their account */
2630
+ Email: string;
2631
+ /** The email template id of the account recovery email template to send. */
2632
+ EmailTemplateId?: string;
2633
+ /**
2634
+ * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2635
+ * title has been selected.
2636
+ */
2637
+ TitleId: string;
2638
+ }
2639
+ interface SendAccountRecoveryEmailResult extends IPlayFabResultCommon {
2640
+ }
2641
+ interface SetFriendTagsRequest extends IPlayFabRequestCommon {
2642
+ /** PlayFab identifier of the friend account to which the tag(s) should be applied. */
2643
+ FriendPlayFabId: string;
2644
+ /** Array of tags to set on the friend account. */
2645
+ Tags: string[];
2646
+ }
2647
+ interface SetFriendTagsResult extends IPlayFabResultCommon {
2648
+ }
2649
+ interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
2650
+ /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2651
+ EncryptedRequest?: string;
2652
+ /** Player secret that is used to verify API request signatures (Enterprise Only). */
2653
+ PlayerSecret?: string;
2654
+ }
2655
+ interface SetPlayerSecretResult extends IPlayFabResultCommon {
2656
+ }
2657
+ interface SharedGroupDataRecord {
2658
+ /** Timestamp for when this data was last updated. */
2659
+ LastUpdated: string;
2660
+ /** Unique PlayFab identifier of the user to last update this value. */
2661
+ LastUpdatedBy?: string;
2662
+ /** Indicates whether this data can be read by all users (public) or only members of the group (private). */
2663
+ Permission?: string;
2664
+ /** Data stored for the specified group data key. */
2665
+ Value?: string;
2666
+ }
2667
+ interface StartPurchaseRequest extends IPlayFabRequestCommon {
2668
+ /** Catalog version for the items to be purchased. Defaults to most recent catalog. */
2669
+ CatalogVersion?: string;
2670
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2671
+ CustomTags?: Record<string, string | null>;
2672
+ /** Array of items to purchase. */
2673
+ Items: ItemPurchaseRequest[];
2674
+ /** Store through which to purchase items. If not set, prices will be pulled from the catalog itself. */
2675
+ StoreId?: string;
2676
+ }
2677
+ interface StartPurchaseResult extends IPlayFabResultCommon {
2678
+ /** Cart items to be purchased. */
2679
+ Contents?: CartItem[];
2680
+ /** Purchase order identifier. */
2681
+ OrderId?: string;
2682
+ /** Available methods by which the user can pay. */
2683
+ PaymentOptions?: PaymentOption[];
2684
+ /** Current virtual currency totals for the user. */
2685
+ VirtualCurrencyBalances?: Record<string, number>;
2686
+ }
2687
+ interface StatisticModel {
2688
+ /** Statistic name */
2689
+ Name?: string;
2690
+ /** Statistic value */
2691
+ Value: number;
2692
+ /** Statistic version (0 if not a versioned statistic) */
2693
+ Version: number;
2694
+ }
2695
+ interface StatisticNameVersion {
2696
+ /** unique name of the statistic */
2697
+ StatisticName: string;
2698
+ /** the version of the statistic to be returned */
2699
+ Version: number;
2700
+ }
2701
+ interface StatisticUpdate {
2702
+ /** unique name of the statistic */
2703
+ StatisticName: string;
2704
+ /** statistic value for the player */
2705
+ Value: number;
2706
+ /**
2707
+ * for updates to an existing statistic value for a player, the version of the statistic when it was loaded. Null when
2708
+ * setting the statistic value for the first time.
2709
+ */
2710
+ Version?: number;
2711
+ }
2712
+ interface StatisticValue {
2713
+ /** unique name of the statistic */
2714
+ StatisticName?: string;
2715
+ /** statistic value for the player */
2716
+ Value: number;
2717
+ /** for updates to an existing statistic value for a player, the version of the statistic when it was loaded */
2718
+ Version: number;
2719
+ }
2720
+ interface SteamNamePlayFabIdPair {
2721
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
2722
+ PlayFabId?: string;
2723
+ /** Unique Steam identifier for a user, also known as Steam persona name. */
2724
+ SteamName?: string;
2725
+ }
2726
+ interface SteamPlayFabIdPair {
2727
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
2728
+ PlayFabId?: string;
2729
+ /** Unique Steam identifier for a user. */
2730
+ SteamStringId?: string;
2731
+ }
2732
+ interface StoreItem {
2733
+ /** Store specific custom data. The data only exists as part of this store; it is not transferred to item instances */
2734
+ CustomData?: any;
2735
+ /** Intended display position for this item. Note that 0 is the first position */
2736
+ DisplayPosition?: number;
2737
+ /**
2738
+ * Unique identifier of the item as it exists in the catalog - note that this must exactly match the ItemId from the
2739
+ * catalog
2740
+ */
2741
+ ItemId: string;
2742
+ /** Override prices for this item for specific currencies */
2743
+ RealCurrencyPrices?: Record<string, number>;
2744
+ /** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
2745
+ VirtualCurrencyPrices?: Record<string, number>;
2746
+ }
2747
+ interface StoreMarketingModel {
2748
+ /** Tagline for a store. */
2749
+ Description?: string;
2750
+ /** Display name of a store as it will appear to users. */
2751
+ DisplayName?: string;
2752
+ /** Custom data about a store. */
2753
+ Metadata?: any;
2754
+ }
2755
+ interface SubscriptionModel {
2756
+ /** When this subscription expires. */
2757
+ Expiration: string;
2758
+ /** The time the subscription was orignially purchased */
2759
+ InitialSubscriptionTime: string;
2760
+ /** Whether this subscription is currently active. That is, if Expiration > now. */
2761
+ IsActive: boolean;
2762
+ /** The status of this subscription, according to the subscription provider. */
2763
+ Status?: string;
2764
+ /** The id for this subscription */
2765
+ SubscriptionId?: string;
2766
+ /** The item id for this subscription from the primary catalog */
2767
+ SubscriptionItemId?: string;
2768
+ /** The provider for this subscription. Apple or Google Play are supported today. */
2769
+ SubscriptionProvider?: string;
2770
+ }
2771
+ interface SubtractUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
2772
+ /** Amount to be subtracted from the user balance of the specified virtual currency. */
2773
+ Amount: number;
2774
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2775
+ CustomTags?: Record<string, string | null>;
2776
+ /** Name of the virtual currency which is to be decremented. */
2777
+ VirtualCurrency: string;
2778
+ }
2779
+ interface TagModel {
2780
+ /** Full value of the tag, including namespace */
2781
+ TagValue?: string;
2782
+ }
2783
+ interface TitleNewsItem {
2784
+ /** News item text. */
2785
+ Body?: string;
2786
+ /** Unique identifier of news item. */
2787
+ NewsId?: string;
2788
+ /** Date and time when the news item was posted. */
2789
+ Timestamp: string;
2790
+ /** Title of the news item. */
2791
+ Title?: string;
2792
+ }
2793
+ interface TradeInfo {
2794
+ /** Item instances from the accepting player that are used to fulfill the trade. If null, no one has accepted the trade. */
2795
+ AcceptedInventoryInstanceIds?: string[];
2796
+ /** The PlayFab ID of the player who accepted the trade. If null, no one has accepted the trade. */
2797
+ AcceptedPlayerId?: string;
2798
+ /** An optional list of players allowed to complete this trade. If null, anybody can complete the trade. */
2799
+ AllowedPlayerIds?: string[];
2800
+ /** If set, The UTC time when this trade was canceled. */
2801
+ CancelledAt?: string;
2802
+ /** If set, The UTC time when this trade was fulfilled. */
2803
+ FilledAt?: string;
2804
+ /** If set, The UTC time when this trade was made invalid. */
2805
+ InvalidatedAt?: string;
2806
+ /** The catalogItem Ids of the item instances being offered. */
2807
+ OfferedCatalogItemIds?: string[];
2808
+ /** The itemInstance Ids that are being offered. */
2809
+ OfferedInventoryInstanceIds?: string[];
2810
+ /** The PlayFabId for the offering player. */
2811
+ OfferingPlayerId?: string;
2812
+ /** The UTC time when this trade was created. */
2813
+ OpenedAt?: string;
2814
+ /** The catalogItem Ids requested in exchange. */
2815
+ RequestedCatalogItemIds?: string[];
2816
+ /** Describes the current state of this trade. */
2817
+ Status?: string;
2818
+ /** The identifier for this trade. */
2819
+ TradeId?: string;
2820
+ }
2821
+ interface TreatmentAssignment {
2822
+ /** List of the experiment variables. */
2823
+ Variables?: Variable[];
2824
+ /** List of the experiment variants. */
2825
+ Variants?: string[];
2826
+ }
2827
+ interface TwitchPlayFabIdPair {
2828
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Twitch identifier. */
2829
+ PlayFabId?: string;
2830
+ /** Unique Twitch identifier for a user. */
2831
+ TwitchId?: string;
2832
+ }
2833
+ interface UnlinkAndroidDeviceIDRequest extends IPlayFabRequestCommon {
2834
+ /**
2835
+ * Android device identifier for the user's device. If not specified, the most recently signed in Android Device ID will be
2836
+ * used.
2837
+ */
2838
+ AndroidDeviceId?: string;
2839
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2840
+ CustomTags?: Record<string, string | null>;
2841
+ }
2842
+ interface UnlinkAndroidDeviceIDResult extends IPlayFabResultCommon {
2843
+ }
2844
+ interface UnlinkAppleRequest extends IPlayFabRequestCommon {
2845
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2846
+ CustomTags?: Record<string, string | null>;
2847
+ }
2848
+ interface UnlinkBattleNetAccountRequest extends IPlayFabRequestCommon {
2849
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2850
+ CustomTags?: Record<string, string | null>;
2851
+ }
2852
+ interface UnlinkCustomIDRequest extends IPlayFabRequestCommon {
2853
+ /**
2854
+ * Custom unique identifier for the user, generated by the title. If not specified, the most recently signed in Custom ID
2855
+ * will be used.
2856
+ */
2857
+ CustomId?: string;
2858
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2859
+ CustomTags?: Record<string, string | null>;
2860
+ }
2861
+ interface UnlinkCustomIDResult extends IPlayFabResultCommon {
2862
+ }
2863
+ interface UnlinkFacebookAccountRequest extends IPlayFabRequestCommon {
2864
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2865
+ CustomTags?: Record<string, string | null>;
2866
+ }
2867
+ interface UnlinkFacebookAccountResult extends IPlayFabResultCommon {
2868
+ }
2869
+ interface UnlinkFacebookInstantGamesIdRequest extends IPlayFabRequestCommon {
2870
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2871
+ CustomTags?: Record<string, string | null>;
2872
+ /** Facebook Instant Games identifier for the user. If not specified, the most recently signed in ID will be used. */
2873
+ FacebookInstantGamesId?: string;
2874
+ }
2875
+ interface UnlinkFacebookInstantGamesIdResult extends IPlayFabResultCommon {
2876
+ }
2877
+ interface UnlinkGameCenterAccountRequest extends IPlayFabRequestCommon {
2878
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2879
+ CustomTags?: Record<string, string | null>;
2880
+ }
2881
+ interface UnlinkGameCenterAccountResult extends IPlayFabResultCommon {
2882
+ }
2883
+ interface UnlinkGoogleAccountRequest extends IPlayFabRequestCommon {
2884
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2885
+ CustomTags?: Record<string, string | null>;
2886
+ }
2887
+ interface UnlinkGoogleAccountResult extends IPlayFabResultCommon {
2888
+ }
2889
+ interface UnlinkGooglePlayGamesServicesAccountRequest extends IPlayFabRequestCommon {
2890
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2891
+ CustomTags?: Record<string, string | null>;
2892
+ }
2893
+ interface UnlinkGooglePlayGamesServicesAccountResult extends IPlayFabResultCommon {
2894
+ }
2895
+ interface UnlinkIOSDeviceIDRequest extends IPlayFabRequestCommon {
2896
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2897
+ CustomTags?: Record<string, string | null>;
2898
+ /**
2899
+ * Vendor-specific iOS identifier for the user's device. If not specified, the most recently signed in iOS Device ID will
2900
+ * be used.
2901
+ */
2902
+ DeviceId?: string;
2903
+ }
2904
+ interface UnlinkIOSDeviceIDResult extends IPlayFabResultCommon {
2905
+ }
2906
+ interface UnlinkKongregateAccountRequest extends IPlayFabRequestCommon {
2907
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2908
+ CustomTags?: Record<string, string | null>;
2909
+ }
2910
+ interface UnlinkKongregateAccountResult extends IPlayFabResultCommon {
2911
+ }
2912
+ interface UnlinkNintendoServiceAccountRequest extends IPlayFabRequestCommon {
2913
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2914
+ CustomTags?: Record<string, string | null>;
2915
+ }
2916
+ interface UnlinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
2917
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2918
+ CustomTags?: Record<string, string | null>;
2919
+ /** Nintendo Switch Device identifier for the user. If not specified, the most recently signed in device ID will be used. */
2920
+ NintendoSwitchDeviceId?: string;
2921
+ }
2922
+ interface UnlinkNintendoSwitchDeviceIdResult extends IPlayFabResultCommon {
2923
+ }
2924
+ interface UnlinkOpenIdConnectRequest extends IPlayFabRequestCommon {
2925
+ /** A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters. */
2926
+ ConnectionId: string;
2927
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2928
+ CustomTags?: Record<string, string | null>;
2929
+ }
2930
+ interface UnlinkPSNAccountRequest extends IPlayFabRequestCommon {
2931
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2932
+ CustomTags?: Record<string, string | null>;
2933
+ }
2934
+ interface UnlinkPSNAccountResult extends IPlayFabResultCommon {
2935
+ }
2936
+ interface UnlinkSteamAccountRequest extends IPlayFabRequestCommon {
2937
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2938
+ CustomTags?: Record<string, string | null>;
2939
+ }
2940
+ interface UnlinkSteamAccountResult extends IPlayFabResultCommon {
2941
+ }
2942
+ interface UnlinkTwitchAccountRequest extends IPlayFabRequestCommon {
2943
+ /**
2944
+ * Valid token issued by Twitch. Used to specify which twitch account to unlink from the profile. By default it uses the
2945
+ * one that is present on the profile.
2946
+ */
2947
+ AccessToken?: string;
2948
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2949
+ CustomTags?: Record<string, string | null>;
2950
+ }
2951
+ interface UnlinkTwitchAccountResult extends IPlayFabResultCommon {
2952
+ }
2953
+ interface UnlinkXboxAccountRequest extends IPlayFabRequestCommon {
2954
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2955
+ CustomTags?: Record<string, string | null>;
2956
+ }
2957
+ interface UnlinkXboxAccountResult extends IPlayFabResultCommon {
2958
+ }
2959
+ interface UnlockContainerInstanceRequest extends IPlayFabRequestCommon {
2960
+ /**
2961
+ * Specifies the catalog version that should be used to determine container contents. If unspecified, uses catalog
2962
+ * associated with the item instance.
2963
+ */
2964
+ CatalogVersion?: string;
2965
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2966
+ CharacterId?: string;
2967
+ /** ItemInstanceId of the container to unlock. */
2968
+ ContainerItemInstanceId: string;
2969
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2970
+ CustomTags?: Record<string, string | null>;
2971
+ /**
2972
+ * ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this
2973
+ * parameter is required.
2974
+ */
2975
+ KeyItemInstanceId?: string;
2976
+ }
2977
+ interface UnlockContainerItemRequest extends IPlayFabRequestCommon {
2978
+ /**
2979
+ * Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary
2980
+ * catalog.
2981
+ */
2982
+ CatalogVersion?: string;
2983
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
2984
+ CharacterId?: string;
2985
+ /** Catalog ItemId of the container type to unlock. */
2986
+ ContainerItemId: string;
2987
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2988
+ CustomTags?: Record<string, string | null>;
2989
+ }
2990
+ interface UnlockContainerItemResult extends IPlayFabResultCommon {
2991
+ /** Items granted to the player as a result of unlocking the container. */
2992
+ GrantedItems?: ItemInstance[];
2993
+ /** Unique instance identifier of the container unlocked. */
2994
+ UnlockedItemInstanceId?: string;
2995
+ /** Unique instance identifier of the key used to unlock the container, if applicable. */
2996
+ UnlockedWithItemInstanceId?: string;
2997
+ /** Virtual currency granted to the player as a result of unlocking the container. */
2998
+ VirtualCurrency?: Record<string, number>;
2999
+ }
3000
+ interface UpdateAvatarUrlRequest extends IPlayFabRequestCommon {
3001
+ /** URL of the avatar image. If empty, it removes the existing avatar URL. */
3002
+ ImageUrl: string;
3003
+ }
3004
+ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
3005
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
3006
+ CharacterId: string;
3007
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3008
+ CustomTags?: Record<string, string | null>;
3009
+ /**
3010
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
3011
+ * not begin with a '!' character or be null.
3012
+ */
3013
+ Data?: Record<string, string | null>;
3014
+ /**
3015
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
3016
+ * constraints. Use this to delete the keys directly.
3017
+ */
3018
+ KeysToRemove?: string[];
3019
+ /** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
3020
+ Permission?: string;
3021
+ }
3022
+ interface UpdateCharacterDataResult extends IPlayFabResultCommon {
3023
+ /**
3024
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
3025
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
3026
+ */
3027
+ DataVersion: number;
3028
+ }
3029
+ interface UpdateCharacterStatisticsRequest extends IPlayFabRequestCommon {
3030
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
3031
+ CharacterId: string;
3032
+ /** Statistics to be updated with the provided values, in the Key(string), Value(int) pattern. */
3033
+ CharacterStatistics?: Record<string, number>;
3034
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3035
+ CustomTags?: Record<string, string | null>;
3036
+ }
3037
+ interface UpdateCharacterStatisticsResult extends IPlayFabResultCommon {
3038
+ }
3039
+ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
3040
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3041
+ CustomTags?: Record<string, string | null>;
3042
+ /**
3043
+ * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the
3044
+ * player's properties have not been updated by any other clients since last the version.
3045
+ */
3046
+ ExpectedPropertiesVersion?: number;
3047
+ /** Collection of properties to be set for a player. */
3048
+ Properties: UpdateProperty[];
3049
+ }
3050
+ interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
3051
+ /**
3052
+ * Indicates the current version of a player's properties that have been set. This is incremented after updates and
3053
+ * deletes. This version can be provided in update and delete calls for concurrency control.
3054
+ */
3055
+ PropertiesVersion: number;
3056
+ }
3057
+ interface UpdatePlayerStatisticsRequest extends IPlayFabRequestCommon {
3058
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3059
+ CustomTags?: Record<string, string | null>;
3060
+ /** Statistics to be updated with the provided values */
3061
+ Statistics: StatisticUpdate[];
3062
+ }
3063
+ interface UpdatePlayerStatisticsResult extends IPlayFabResultCommon {
3064
+ }
3065
+ interface UpdateProperty {
3066
+ /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */
3067
+ Name: string;
3068
+ /** Value of the custom property. Limited to booleans, numbers, and strings. */
3069
+ Value: any;
3070
+ }
3071
+ interface UpdateSharedGroupDataRequest extends IPlayFabRequestCommon {
3072
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3073
+ CustomTags?: Record<string, string | null>;
3074
+ /**
3075
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
3076
+ * not begin with a '!' character or be null.
3077
+ */
3078
+ Data?: Record<string, string | null>;
3079
+ /**
3080
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
3081
+ * constraints. Use this to delete the keys directly.
3082
+ */
3083
+ KeysToRemove?: string[];
3084
+ /** Permission to be applied to all user data keys in this request. */
3085
+ Permission?: string;
3086
+ /** Unique identifier for the shared group. */
3087
+ SharedGroupId: string;
3088
+ }
3089
+ interface UpdateSharedGroupDataResult extends IPlayFabResultCommon {
3090
+ }
3091
+ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
3092
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3093
+ CustomTags?: Record<string, string | null>;
3094
+ /**
3095
+ * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
3096
+ * not begin with a '!' character or be null.
3097
+ */
3098
+ Data?: Record<string, string | null>;
3099
+ /**
3100
+ * Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
3101
+ * constraints. Use this to delete the keys directly.
3102
+ */
3103
+ KeysToRemove?: string[];
3104
+ /**
3105
+ * Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. This is used
3106
+ * for requests by one player for information about another player; those requests will only return Public keys.
3107
+ */
3108
+ Permission?: string;
3109
+ }
3110
+ interface UpdateUserDataResult extends IPlayFabResultCommon {
3111
+ /**
3112
+ * Indicates the current version of the data that has been set. This is incremented with every set call for that type of
3113
+ * data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
3114
+ */
3115
+ DataVersion: number;
3116
+ }
3117
+ interface UpdateUserTitleDisplayNameRequest extends IPlayFabRequestCommon {
3118
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3119
+ CustomTags?: Record<string, string | null>;
3120
+ /** New title display name for the user - must be between 3 and 25 characters. */
3121
+ DisplayName: string;
3122
+ }
3123
+ interface UpdateUserTitleDisplayNameResult extends IPlayFabResultCommon {
3124
+ /** Current title display name for the user (this will be the original display name if the rename attempt failed). */
3125
+ DisplayName?: string;
3126
+ }
3127
+ interface UserAccountInfo {
3128
+ /** User Android device information, if an Android device has been linked */
3129
+ AndroidDeviceInfo?: UserAndroidDeviceInfo;
3130
+ /** Sign in with Apple account information, if an Apple account has been linked */
3131
+ AppleAccountInfo?: UserAppleIdInfo;
3132
+ /** Battle.net account information, if a Battle.net account has been linked */
3133
+ BattleNetAccountInfo?: UserBattleNetInfo;
3134
+ /** Timestamp indicating when the user account was created */
3135
+ Created: string;
3136
+ /** Custom ID information, if a custom ID has been assigned */
3137
+ CustomIdInfo?: UserCustomIdInfo;
3138
+ /** User Facebook information, if a Facebook account has been linked */
3139
+ FacebookInfo?: UserFacebookInfo;
3140
+ /** Facebook Instant Games account information, if a Facebook Instant Games account has been linked */
3141
+ FacebookInstantGamesIdInfo?: UserFacebookInstantGamesIdInfo;
3142
+ /** User Gamecenter information, if a Gamecenter account has been linked */
3143
+ GameCenterInfo?: UserGameCenterInfo;
3144
+ /** User Google account information, if a Google account has been linked */
3145
+ GoogleInfo?: UserGoogleInfo;
3146
+ /** User Google Play Games account information, if a Google Play Games account has been linked */
3147
+ GooglePlayGamesInfo?: UserGooglePlayGamesInfo;
3148
+ /** User iOS device information, if an iOS device has been linked */
3149
+ IosDeviceInfo?: UserIosDeviceInfo;
3150
+ /** User Kongregate account information, if a Kongregate account has been linked */
3151
+ KongregateInfo?: UserKongregateInfo;
3152
+ /** Nintendo Switch account information, if a Nintendo Switch account has been linked */
3153
+ NintendoSwitchAccountInfo?: UserNintendoSwitchAccountIdInfo;
3154
+ /** Nintendo Switch device information, if a Nintendo Switch device has been linked */
3155
+ NintendoSwitchDeviceIdInfo?: UserNintendoSwitchDeviceIdInfo;
3156
+ /** OpenID Connect information, if any OpenID Connect accounts have been linked */
3157
+ OpenIdInfo?: UserOpenIdInfo[];
3158
+ /** Unique identifier for the user account */
3159
+ PlayFabId?: string;
3160
+ /** Personal information for the user which is considered more sensitive */
3161
+ PrivateInfo?: UserPrivateAccountInfo;
3162
+ /** User PlayStation :tm: Network account information, if a PlayStation :tm: Network account has been linked */
3163
+ PsnInfo?: UserPsnInfo;
3164
+ /** Server Custom ID information, if a server custom ID has been assigned */
3165
+ ServerCustomIdInfo?: UserServerCustomIdInfo;
3166
+ /** User Steam information, if a Steam account has been linked */
3167
+ SteamInfo?: UserSteamInfo;
3168
+ /** Title-specific information for the user account */
3169
+ TitleInfo?: UserTitleInfo;
3170
+ /** User Twitch account information, if a Twitch account has been linked */
3171
+ TwitchInfo?: UserTwitchInfo;
3172
+ /** User account name in the PlayFab service */
3173
+ Username?: string;
3174
+ /** User XBox account information, if a XBox account has been linked */
3175
+ XboxInfo?: UserXboxInfo;
3176
+ }
3177
+ interface UserAndroidDeviceInfo {
3178
+ /** Android device ID */
3179
+ AndroidDeviceId?: string;
3180
+ }
3181
+ interface UserAppleIdInfo {
3182
+ /** Apple subject ID */
3183
+ AppleSubjectId?: string;
3184
+ }
3185
+ interface UserBattleNetInfo {
3186
+ /** Battle.net identifier */
3187
+ BattleNetAccountId?: string;
3188
+ /** Battle.net display name */
3189
+ BattleNetBattleTag?: string;
3190
+ }
3191
+ interface UserCustomIdInfo {
3192
+ /** Custom ID */
3193
+ CustomId?: string;
3194
+ }
3195
+ interface UserDataRecord {
3196
+ /** Timestamp for when this data was last updated. */
3197
+ LastUpdated: string;
3198
+ /**
3199
+ * Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData
3200
+ * requests being made by one player about another player.
3201
+ */
3202
+ Permission?: string;
3203
+ /** Data stored for the specified user data key. */
3204
+ Value?: string;
3205
+ }
3206
+ interface UserFacebookInfo {
3207
+ /** Facebook identifier */
3208
+ FacebookId?: string;
3209
+ /** Facebook full name */
3210
+ FullName?: string;
3211
+ }
3212
+ interface UserFacebookInstantGamesIdInfo {
3213
+ /** Facebook Instant Games ID */
3214
+ FacebookInstantGamesId?: string;
3215
+ }
3216
+ interface UserGameCenterInfo {
3217
+ /** Gamecenter identifier */
3218
+ GameCenterId?: string;
3219
+ }
3220
+ interface UserGoogleInfo {
3221
+ /** Email address of the Google account */
3222
+ GoogleEmail?: string;
3223
+ /** Gender information of the Google account */
3224
+ GoogleGender?: string;
3225
+ /** Google ID */
3226
+ GoogleId?: string;
3227
+ /** Locale of the Google account */
3228
+ GoogleLocale?: string;
3229
+ /** Name of the Google account user */
3230
+ GoogleName?: string;
3231
+ }
3232
+ interface UserGooglePlayGamesInfo {
3233
+ /** Avatar image url of the Google Play Games player */
3234
+ GooglePlayGamesPlayerAvatarImageUrl?: string;
3235
+ /** Display name of the Google Play Games player */
3236
+ GooglePlayGamesPlayerDisplayName?: string;
3237
+ /** Google Play Games player ID */
3238
+ GooglePlayGamesPlayerId?: string;
3239
+ }
3240
+ interface UserIosDeviceInfo {
3241
+ /** iOS device ID */
3242
+ IosDeviceId?: string;
3243
+ }
3244
+ interface UserKongregateInfo {
3245
+ /** Kongregate ID */
3246
+ KongregateId?: string;
3247
+ /** Kongregate Username */
3248
+ KongregateName?: string;
3249
+ }
3250
+ interface UserNintendoSwitchAccountIdInfo {
3251
+ /** Nintendo Switch account subject ID */
3252
+ NintendoSwitchAccountSubjectId?: string;
3253
+ }
3254
+ interface UserNintendoSwitchDeviceIdInfo {
3255
+ /** Nintendo Switch Device ID */
3256
+ NintendoSwitchDeviceId?: string;
3257
+ }
3258
+ interface UserOpenIdInfo {
3259
+ /** OpenID Connection ID */
3260
+ ConnectionId?: string;
3261
+ /** OpenID Issuer */
3262
+ Issuer?: string;
3263
+ /** OpenID Subject */
3264
+ Subject?: string;
3265
+ }
3266
+ interface UserPrivateAccountInfo {
3267
+ /** user email address */
3268
+ Email?: string;
3269
+ }
3270
+ interface UserPsnInfo {
3271
+ /** PlayStation :tm: Network account ID */
3272
+ PsnAccountId?: string;
3273
+ /** PlayStation :tm: Network online ID */
3274
+ PsnOnlineId?: string;
3275
+ }
3276
+ interface UserServerCustomIdInfo {
3277
+ /** Custom ID */
3278
+ CustomId?: string;
3279
+ }
3280
+ interface UserSettings {
3281
+ /** Boolean for whether this player is eligible for gathering device info. */
3282
+ GatherDeviceInfo: boolean;
3283
+ /** Boolean for whether this player should report OnFocus play-time tracking. */
3284
+ GatherFocusInfo: boolean;
3285
+ /** Boolean for whether this player is eligible for ad tracking. */
3286
+ NeedsAttribution: boolean;
3287
+ }
3288
+ interface UserSteamInfo {
3289
+ /** what stage of game ownership the user is listed as being in, from Steam */
3290
+ SteamActivationStatus?: string;
3291
+ /** the country in which the player resides, from Steam data */
3292
+ SteamCountry?: string;
3293
+ /** currency type set in the user Steam account */
3294
+ SteamCurrency?: string;
3295
+ /** Steam identifier */
3296
+ SteamId?: string;
3297
+ /** Steam display name */
3298
+ SteamName?: string;
3299
+ }
3300
+ interface UserTitleInfo {
3301
+ /** URL to the player's avatar. */
3302
+ AvatarUrl?: string;
3303
+ /**
3304
+ * timestamp indicating when the user was first associated with this game (this can differ significantly from when the user
3305
+ * first registered with PlayFab)
3306
+ */
3307
+ Created: string;
3308
+ /** name of the user, as it is displayed in-game */
3309
+ DisplayName?: string;
3310
+ /**
3311
+ * timestamp indicating when the user first signed into this game (this can differ from the Created timestamp, as other
3312
+ * events, such as issuing a beta key to the user, can associate the title to the user)
3313
+ */
3314
+ FirstLogin?: string;
3315
+ /** boolean indicating whether or not the user is currently banned for a title */
3316
+ isBanned?: boolean;
3317
+ /** timestamp for the last user login for this title */
3318
+ LastLogin?: string;
3319
+ /** source by which the user first joined the game, if known */
3320
+ Origination?: string;
3321
+ /** Title player account entity for this user */
3322
+ TitlePlayerAccount?: EntityKey;
3323
+ }
3324
+ interface UserTwitchInfo {
3325
+ /** Twitch ID */
3326
+ TwitchId?: string;
3327
+ /** Twitch Username */
3328
+ TwitchUserName?: string;
3329
+ }
3330
+ interface UserXboxInfo {
3331
+ /** XBox user ID */
3332
+ XboxUserId?: string;
3333
+ /** XBox user sandbox */
3334
+ XboxUserSandbox?: string;
3335
+ }
3336
+ interface ValidateAmazonReceiptRequest extends IPlayFabRequestCommon {
3337
+ /** Catalog version of the fulfilled items. If null, defaults to the primary catalog. */
3338
+ CatalogVersion?: string;
3339
+ /** Currency used to pay for the purchase (ISO 4217 currency code). */
3340
+ CurrencyCode?: string;
3341
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3342
+ CustomTags?: Record<string, string | null>;
3343
+ /** Amount of the stated currency paid, in centesimal units. */
3344
+ PurchasePrice: number;
3345
+ /** ReceiptId returned by the Amazon App Store in-app purchase API */
3346
+ ReceiptId: string;
3347
+ /** AmazonId of the user making the purchase as returned by the Amazon App Store in-app purchase API */
3348
+ UserId: string;
3349
+ }
3350
+ interface ValidateAmazonReceiptResult extends IPlayFabResultCommon {
3351
+ /** Fulfilled inventory items and recorded purchases in fulfillment of the validated receipt transactions. */
3352
+ Fulfillments?: PurchaseReceiptFulfillment[];
3353
+ }
3354
+ interface ValidateGooglePlayPurchaseRequest extends IPlayFabRequestCommon {
3355
+ /** Catalog version of the fulfilled items. If null, defaults to the primary catalog. */
3356
+ CatalogVersion?: string;
3357
+ /** Currency used to pay for the purchase (ISO 4217 currency code). */
3358
+ CurrencyCode?: string;
3359
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3360
+ CustomTags?: Record<string, string | null>;
3361
+ /** Amount of the stated currency paid, in centesimal units. */
3362
+ PurchasePrice?: number;
3363
+ /** Original JSON string returned by the Google Play IAB API. */
3364
+ ReceiptJson: string;
3365
+ /** Signature returned by the Google Play IAB API. */
3366
+ Signature: string;
3367
+ }
3368
+ interface ValidateGooglePlayPurchaseResult extends IPlayFabResultCommon {
3369
+ /** Fulfilled inventory items and recorded purchases in fulfillment of the validated receipt transactions. */
3370
+ Fulfillments?: PurchaseReceiptFulfillment[];
3371
+ }
3372
+ interface ValidateIOSReceiptRequest extends IPlayFabRequestCommon {
3373
+ /** Catalog version of the fulfilled items. If null, defaults to the primary catalog. */
3374
+ CatalogVersion?: string;
3375
+ /** Currency used to pay for the purchase (ISO 4217 currency code). */
3376
+ CurrencyCode?: string;
3377
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3378
+ CustomTags?: Record<string, string | null>;
3379
+ /** Amount of the stated currency paid, in centesimal units. */
3380
+ PurchasePrice: number;
3381
+ /** Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase. */
3382
+ ReceiptData: string;
3383
+ }
3384
+ interface ValidateIOSReceiptResult extends IPlayFabResultCommon {
3385
+ /** Fulfilled inventory items and recorded purchases in fulfillment of the validated receipt transactions. */
3386
+ Fulfillments?: PurchaseReceiptFulfillment[];
3387
+ }
3388
+ interface ValidateWindowsReceiptRequest extends IPlayFabRequestCommon {
3389
+ /** Catalog version of the fulfilled items. If null, defaults to the primary catalog. */
3390
+ CatalogVersion?: string;
3391
+ /** Currency used to pay for the purchase (ISO 4217 currency code). */
3392
+ CurrencyCode: string;
3393
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3394
+ CustomTags?: Record<string, string | null>;
3395
+ /** Amount of the stated currency paid, in centesimal units. */
3396
+ PurchasePrice: number;
3397
+ /** XML Receipt returned by the Windows App Store in-app purchase API */
3398
+ Receipt: string;
3399
+ }
3400
+ interface ValidateWindowsReceiptResult extends IPlayFabResultCommon {
3401
+ /** Fulfilled inventory items and recorded purchases in fulfillment of the validated receipt transactions. */
3402
+ Fulfillments?: PurchaseReceiptFulfillment[];
3403
+ }
3404
+ interface ValueToDateModel {
3405
+ /** ISO 4217 code of the currency used in the purchases */
3406
+ Currency?: string;
3407
+ /**
3408
+ * Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
3409
+ * ninety-nine cents when Currency is 'USD')
3410
+ */
3411
+ TotalValue: number;
3412
+ /**
3413
+ * Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
3414
+ * dollars and ninety-nine cents when Currency is 'USD'.
3415
+ */
3416
+ TotalValueAsDecimal?: string;
3417
+ }
3418
+ interface Variable {
3419
+ /** Name of the variable. */
3420
+ Name: string;
3421
+ /** Value of the variable. */
3422
+ Value?: string;
3423
+ }
3424
+ interface VirtualCurrencyRechargeTime {
3425
+ /**
3426
+ * Maximum value to which the regenerating currency will automatically increment. Note that it can exceed this value
3427
+ * through use of the AddUserVirtualCurrency API call. However, it will not regenerate automatically until it has fallen
3428
+ * below this value.
3429
+ */
3430
+ RechargeMax: number;
3431
+ /** Server timestamp in UTC indicating the next time the virtual currency will be incremented. */
3432
+ RechargeTime: string;
3433
+ /** Time remaining (in seconds) before the next recharge increment of the virtual currency. */
3434
+ SecondsToRecharge: number;
3435
+ }
3436
+ interface WriteClientCharacterEventRequest extends IPlayFabRequestCommon {
3437
+ /** Custom event properties. Each property consists of a name (string) and a value (JSON object). */
3438
+ Body?: Record<string, any>;
3439
+ /** Unique PlayFab assigned ID for a specific character owned by a user */
3440
+ CharacterId: string;
3441
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3442
+ CustomTags?: Record<string, string | null>;
3443
+ /**
3444
+ * The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it
3445
+ * commonly follows the subject_verb_object pattern (e.g. player_logged_in).
3446
+ */
3447
+ EventName: string;
3448
+ /** The time (in UTC) associated with this event. The value defaults to the current time. */
3449
+ Timestamp?: string;
3450
+ }
3451
+ interface WriteClientPlayerEventRequest extends IPlayFabRequestCommon {
3452
+ /** Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object). */
3453
+ Body?: Record<string, any>;
3454
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3455
+ CustomTags?: Record<string, string | null>;
3456
+ /**
3457
+ * The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it
3458
+ * commonly follows the subject_verb_object pattern (e.g. player_logged_in).
3459
+ */
3460
+ EventName: string;
3461
+ /** The time (in UTC) associated with this event. The value defaults to the current time. */
3462
+ Timestamp?: string;
3463
+ }
3464
+ interface WriteEventResponse extends IPlayFabResultCommon {
3465
+ /**
3466
+ * The unique identifier of the event. The values of this identifier consist of ASCII characters and are not constrained to
3467
+ * any particular format.
3468
+ */
3469
+ EventId?: string;
3470
+ }
3471
+ interface WriteTitleEventRequest extends IPlayFabRequestCommon {
3472
+ /** Custom event properties. Each property consists of a name (string) and a value (JSON object). */
3473
+ Body?: Record<string, any>;
3474
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3475
+ CustomTags?: Record<string, string | null>;
3476
+ /**
3477
+ * The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it
3478
+ * commonly follows the subject_verb_object pattern (e.g. player_logged_in).
3479
+ */
3480
+ EventName: string;
3481
+ /** The time (in UTC) associated with this event. The value defaults to the current time. */
3482
+ Timestamp?: string;
3483
+ }
3484
+ interface XboxLiveAccountPlayFabIdPair {
3485
+ /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
3486
+ PlayFabId?: string;
3487
+ /** Unique Xbox Live identifier for a user. */
3488
+ XboxLiveAccountId?: string;
3489
+ }
3490
+
3491
+ declare class PlayFabClientApi extends PlayFabCommon {
3492
+ IsClientLoggedIn(): boolean;
3493
+ /**
3494
+ * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
3495
+ * allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
3496
+ * items will be swapped between the two players' inventories.
3497
+ * https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade
3498
+ */
3499
+ AcceptTrade(request: AcceptTradeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AcceptTradeResponse>;
3500
+ /**
3501
+ * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
3502
+ * least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
3503
+ * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
3504
+ */
3505
+ AddFriend(request: AddFriendRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddFriendResult>;
3506
+ /**
3507
+ * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
3508
+ * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
3509
+ * authentication credentials, as the intent is that it is easily accessible by other players.
3510
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid
3511
+ */
3512
+ AddGenericID(request: AddGenericIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddGenericIDResult>;
3513
+ /**
3514
+ * Adds or updates a contact email to the player's profile.
3515
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
3516
+ */
3517
+ AddOrUpdateContactEmail(request: AddOrUpdateContactEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddOrUpdateContactEmailResult>;
3518
+ /**
3519
+ * 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
3520
+ * in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
3521
+ * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3522
+ * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers
3523
+ */
3524
+ AddSharedGroupMembers(request: AddSharedGroupMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
3525
+ /**
3526
+ * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
3527
+ * ID login.
3528
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
3529
+ */
3530
+ AddUsernamePassword(request: AddUsernamePasswordRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddUsernamePasswordResult>;
3531
+ /**
3532
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3533
+ * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
3534
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency
3535
+ */
3536
+ AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
3537
+ /**
3538
+ * Registers the Android device to receive push notifications
3539
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
3540
+ */
3541
+ AndroidDevicePushNotificationRegistration(request: AndroidDevicePushNotificationRegistrationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AndroidDevicePushNotificationRegistrationResult>;
3542
+ /**
3543
+ * Attributes an install for advertisment.
3544
+ * https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
3545
+ */
3546
+ AttributeInstall(request: AttributeInstallRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AttributeInstallResult>;
3547
+ /**
3548
+ * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
3549
+ * can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
3550
+ * players from accepting them, for trades that can be claimed by more than one player).
3551
+ * https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade
3552
+ */
3553
+ CancelTrade(request: CancelTradeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CancelTradeResponse>;
3554
+ /**
3555
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3556
+ * version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
3557
+ * virtual currency balances as appropriate
3558
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
3559
+ */
3560
+ ConfirmPurchase(request: ConfirmPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConfirmPurchaseResult>;
3561
+ /**
3562
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3563
+ * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
3564
+ * inventory.
3565
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
3566
+ */
3567
+ ConsumeItem(request: ConsumeItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
3568
+ /**
3569
+ * Grants the player's current entitlements from Microsoft Store's Collection API
3570
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements
3571
+ */
3572
+ ConsumeMicrosoftStoreEntitlements(request: ConsumeMicrosoftStoreEntitlementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumeMicrosoftStoreEntitlementsResponse>;
3573
+ /**
3574
+ * Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
3575
+ * PlayFab items
3576
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements
3577
+ */
3578
+ ConsumePS5Entitlements(request: ConsumePS5EntitlementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumePS5EntitlementsResult>;
3579
+ /**
3580
+ * Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
3581
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements
3582
+ */
3583
+ ConsumePSNEntitlements(request: ConsumePSNEntitlementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumePSNEntitlementsResult>;
3584
+ /**
3585
+ * Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
3586
+ * player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
3587
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements
3588
+ */
3589
+ ConsumeXboxEntitlements(request: ConsumeXboxEntitlementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumeXboxEntitlementsResult>;
3590
+ /**
3591
+ * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
3592
+ * group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
3593
+ * between a very small number of players, please see our guide:
3594
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3595
+ * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup
3596
+ */
3597
+ CreateSharedGroup(request: CreateSharedGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
3598
+ /**
3599
+ * Deletes title-specific custom properties for a player
3600
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties
3601
+ */
3602
+ DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
3603
+ /**
3604
+ * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
3605
+ * PlayFab ID is the entity ID of the player's master_player_account entity.
3606
+ * https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript
3607
+ */
3608
+ ExecuteCloudScript(request: ExecuteCloudScriptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
3609
+ /**
3610
+ * Retrieves the user's PlayFab account details
3611
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
3612
+ */
3613
+ GetAccountInfo(request: GetAccountInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAccountInfoResult>;
3614
+ /**
3615
+ * Returns a list of ad placements and a reward for each
3616
+ * https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements
3617
+ */
3618
+ GetAdPlacements(request: GetAdPlacementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAdPlacementsResult>;
3619
+ /**
3620
+ * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
3621
+ * evaluated with the parent PlayFabId to guarantee uniqueness.
3622
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
3623
+ */
3624
+ GetAllUsersCharacters(request: ListUsersCharactersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
3625
+ /**
3626
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3627
+ * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
3628
+ * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems
3629
+ */
3630
+ GetCatalogItems(request: GetCatalogItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
3631
+ /**
3632
+ * Retrieves the title-specific custom data for the character which is readable and writable by the client
3633
+ * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata
3634
+ */
3635
+ GetCharacterData(request: GetCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3636
+ /**
3637
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3638
+ * version 2._ Retrieves the specified character's current inventory of virtual goods
3639
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory
3640
+ */
3641
+ GetCharacterInventory(request: GetCharacterInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
3642
+ /**
3643
+ * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
3644
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard
3645
+ */
3646
+ GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
3647
+ /**
3648
+ * Retrieves the title-specific custom data for the character which can only be read by the client
3649
+ * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata
3650
+ */
3651
+ GetCharacterReadOnlyData(request: GetCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3652
+ /**
3653
+ * Retrieves the details of all title-specific statistics for the user
3654
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
3655
+ */
3656
+ GetCharacterStatistics(request: GetCharacterStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
3657
+ /**
3658
+ * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
3659
+ * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
3660
+ * content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded,
3661
+ * the query to retrieve the data will fail. See this post for more information:
3662
+ * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
3663
+ * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
3664
+ * https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl
3665
+ */
3666
+ GetContentDownloadUrl(request: GetContentDownloadUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
3667
+ /**
3668
+ * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
3669
+ * the leaderboard
3670
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard
3671
+ */
3672
+ GetFriendLeaderboard(request: GetFriendLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
3673
+ /**
3674
+ * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
3675
+ * user. If PlayFabId is empty or null will return currently logged in user.
3676
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer
3677
+ */
3678
+ GetFriendLeaderboardAroundPlayer(request: GetFriendLeaderboardAroundPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundPlayerResult>;
3679
+ /**
3680
+ * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
3681
+ * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
3682
+ * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist
3683
+ */
3684
+ GetFriendsList(request: GetFriendsListRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
3685
+ /**
3686
+ * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
3687
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard
3688
+ */
3689
+ GetLeaderboard(request: GetLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
3690
+ /**
3691
+ * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
3692
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter
3693
+ */
3694
+ GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
3695
+ /**
3696
+ * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
3697
+ * null will return currently logged in user.
3698
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
3699
+ */
3700
+ GetLeaderboardAroundPlayer(request: GetLeaderboardAroundPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundPlayerResult>;
3701
+ /**
3702
+ * Retrieves a list of all of the user's characters for the given statistic.
3703
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters
3704
+ */
3705
+ GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
3706
+ /**
3707
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3708
+ * version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
3709
+ * client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
3710
+ * client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
3711
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken
3712
+ */
3713
+ GetPaymentToken(request: GetPaymentTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPaymentTokenResult>;
3714
+ /**
3715
+ * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
3716
+ * https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
3717
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
3718
+ */
3719
+ GetPhotonAuthenticationToken(request: GetPhotonAuthenticationTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPhotonAuthenticationTokenResult>;
3720
+ /**
3721
+ * Retrieves all of the user's different kinds of info.
3722
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo
3723
+ */
3724
+ GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
3725
+ /**
3726
+ * Retrieves a title-specific custom property value for a player.
3727
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
3728
+ */
3729
+ GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
3730
+ /**
3731
+ * Retrieves the player's profile
3732
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
3733
+ */
3734
+ GetPlayerProfile(request: GetPlayerProfileRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
3735
+ /**
3736
+ * List all segments that a player currently belongs to at this moment in time.
3737
+ * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments
3738
+ */
3739
+ GetPlayerSegments(request: GetPlayerSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
3740
+ /**
3741
+ * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
3742
+ * player.
3743
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics
3744
+ */
3745
+ GetPlayerStatistics(request: GetPlayerStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
3746
+ /**
3747
+ * Retrieves the information on the available versions of the specified statistic.
3748
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
3749
+ */
3750
+ GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
3751
+ /**
3752
+ * Get all tags with a given Namespace (optional) from a player profile.
3753
+ * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
3754
+ */
3755
+ GetPlayerTags(request: GetPlayerTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
3756
+ /**
3757
+ * Gets all trades the player has either opened or accepted, optionally filtered by trade status.
3758
+ * https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades
3759
+ */
3760
+ GetPlayerTrades(request: GetPlayerTradesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerTradesResponse>;
3761
+ /**
3762
+ * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
3763
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids
3764
+ */
3765
+ GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
3766
+ /**
3767
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
3768
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids
3769
+ */
3770
+ GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
3771
+ /**
3772
+ * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
3773
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids
3774
+ */
3775
+ GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
3776
+ /**
3777
+ * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
3778
+ * Programming Guide as the Player Identifier).
3779
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids
3780
+ */
3781
+ GetPlayFabIDsFromGameCenterIDs(request: GetPlayFabIDsFromGameCenterIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGameCenterIDsResult>;
3782
+ /**
3783
+ * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
3784
+ * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
3785
+ * added to the player account.
3786
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids
3787
+ */
3788
+ GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
3789
+ /**
3790
+ * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
3791
+ * the user accounts, available as "id" in the Google+ People API calls.
3792
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids
3793
+ */
3794
+ GetPlayFabIDsFromGoogleIDs(request: GetPlayFabIDsFromGoogleIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGoogleIDsResult>;
3795
+ /**
3796
+ * Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
3797
+ * identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
3798
+ * calls.
3799
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids
3800
+ */
3801
+ GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request: GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult>;
3802
+ /**
3803
+ * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
3804
+ * IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
3805
+ * http://developers.kongregate.com/docs/client/getUserId).
3806
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids
3807
+ */
3808
+ GetPlayFabIDsFromKongregateIDs(request: GetPlayFabIDsFromKongregateIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromKongregateIDsResult>;
3809
+ /**
3810
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
3811
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids
3812
+ */
3813
+ GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
3814
+ /**
3815
+ * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
3816
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids
3817
+ */
3818
+ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
3819
+ /**
3820
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
3821
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids
3822
+ */
3823
+ GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
3824
+ /**
3825
+ * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
3826
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids
3827
+ */
3828
+ GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
3829
+ /**
3830
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
3831
+ * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
3832
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids
3833
+ */
3834
+ GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
3835
+ /**
3836
+ * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
3837
+ * names.
3838
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames
3839
+ */
3840
+ GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
3841
+ /**
3842
+ * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
3843
+ * the user accounts, available as "_id" from the Twitch API methods (ex:
3844
+ * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
3845
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids
3846
+ */
3847
+ GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
3848
+ /**
3849
+ * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
3850
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids
3851
+ */
3852
+ GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
3853
+ /**
3854
+ * Retrieves the key-value store of custom publisher settings
3855
+ * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata
3856
+ */
3857
+ GetPublisherData(request: GetPublisherDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
3858
+ /**
3859
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3860
+ * version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
3861
+ * are still active.
3862
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
3863
+ */
3864
+ GetPurchase(request: GetPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPurchaseResult>;
3865
+ /**
3866
+ * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group
3867
+ * may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
3868
+ * Shared Groups are designed for sharing data between a very small number of players, please see our guide:
3869
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
3870
+ * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata
3871
+ */
3872
+ GetSharedGroupData(request: GetSharedGroupDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
3873
+ /**
3874
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3875
+ * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
3876
+ * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems
3877
+ */
3878
+ GetStoreItems(request: GetStoreItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
3879
+ /**
3880
+ * Retrieves the current server time
3881
+ * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
3882
+ */
3883
+ GetTime(request: GetTimeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
3884
+ /**
3885
+ * Retrieves the key-value store of custom title settings
3886
+ * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata
3887
+ */
3888
+ GetTitleData(request: GetTitleDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
3889
+ /**
3890
+ * Retrieves the title news feed, as configured in the developer portal
3891
+ * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews
3892
+ */
3893
+ GetTitleNews(request: GetTitleNewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
3894
+ /**
3895
+ * Returns the title's base 64 encoded RSA CSP blob.
3896
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
3897
+ */
3898
+ GetTitlePublicKey(request: GetTitlePublicKeyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitlePublicKeyResult>;
3899
+ /**
3900
+ * Gets the current status of an existing trade.
3901
+ * https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus
3902
+ */
3903
+ GetTradeStatus(request: GetTradeStatusRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTradeStatusResponse>;
3904
+ /**
3905
+ * Retrieves the title-specific custom data for the user which is readable and writable by the client
3906
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata
3907
+ */
3908
+ GetUserData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3909
+ /**
3910
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3911
+ * version 2._ Retrieves the user's current inventory of virtual goods
3912
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
3913
+ */
3914
+ GetUserInventory(request: GetUserInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
3915
+ /**
3916
+ * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
3917
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata
3918
+ */
3919
+ GetUserPublisherData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3920
+ /**
3921
+ * Retrieves the publisher-specific custom data for the user which can only be read by the client
3922
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata
3923
+ */
3924
+ GetUserPublisherReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3925
+ /**
3926
+ * Retrieves the title-specific custom data for the user which can only be read by the client
3927
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata
3928
+ */
3929
+ GetUserReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3930
+ /**
3931
+ * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
3932
+ * with the parent PlayFabId to guarantee uniqueness.
3933
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
3934
+ */
3935
+ GrantCharacterToUser(request: GrantCharacterToUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
3936
+ /**
3937
+ * Links the Android device identifier to the user's PlayFab account
3938
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
3939
+ */
3940
+ LinkAndroidDeviceID(request: LinkAndroidDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkAndroidDeviceIDResult>;
3941
+ /**
3942
+ * Links the Apple account associated with the token to the user's PlayFab account.
3943
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple
3944
+ */
3945
+ LinkApple(request: LinkAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3946
+ /**
3947
+ * Links the Battle.net account associated with the token to the user's PlayFab account.
3948
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount
3949
+ */
3950
+ LinkBattleNetAccount(request: LinkBattleNetAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3951
+ /**
3952
+ * Links the custom identifier, generated by the title, to the user's PlayFab account
3953
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid
3954
+ */
3955
+ LinkCustomID(request: LinkCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkCustomIDResult>;
3956
+ /**
3957
+ * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
3958
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount
3959
+ */
3960
+ LinkFacebookAccount(request: LinkFacebookAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkFacebookAccountResult>;
3961
+ /**
3962
+ * Links the Facebook Instant Games Id to the user's PlayFab account
3963
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
3964
+ */
3965
+ LinkFacebookInstantGamesId(request: LinkFacebookInstantGamesIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkFacebookInstantGamesIdResult>;
3966
+ /**
3967
+ * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with
3968
+ * a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
3969
+ * in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
3970
+ * page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
3971
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount
3972
+ */
3973
+ LinkGameCenterAccount(request: LinkGameCenterAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkGameCenterAccountResult>;
3974
+ /**
3975
+ * Links the currently signed-in user account to their Google account, using their Google account credentials
3976
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount
3977
+ */
3978
+ LinkGoogleAccount(request: LinkGoogleAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkGoogleAccountResult>;
3979
+ /**
3980
+ * Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
3981
+ * credentials
3982
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
3983
+ */
3984
+ LinkGooglePlayGamesServicesAccount(request: LinkGooglePlayGamesServicesAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkGooglePlayGamesServicesAccountResult>;
3985
+ /**
3986
+ * Links the vendor-specific iOS device identifier to the user's PlayFab account
3987
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid
3988
+ */
3989
+ LinkIOSDeviceID(request: LinkIOSDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkIOSDeviceIDResult>;
3990
+ /**
3991
+ * Links the Kongregate identifier to the user's PlayFab account
3992
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
3993
+ */
3994
+ LinkKongregate(request: LinkKongregateAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkKongregateAccountResult>;
3995
+ /**
3996
+ * Links the Nintendo account associated with the token to the user's PlayFab account.
3997
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount
3998
+ */
3999
+ LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
4000
+ /**
4001
+ * Links the NintendoSwitchDeviceId to the user's PlayFab account
4002
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
4003
+ */
4004
+ LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
4005
+ /**
4006
+ * Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
4007
+ * Open ID Connect provider and the OpenId Connect JWT from that provider.
4008
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
4009
+ */
4010
+ LinkOpenIdConnect(request: LinkOpenIdConnectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
4011
+ /**
4012
+ * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
4013
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount
4014
+ */
4015
+ LinkPSNAccount(request: LinkPSNAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
4016
+ /**
4017
+ * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
4018
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount
4019
+ */
4020
+ LinkSteamAccount(request: LinkSteamAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkSteamAccountResult>;
4021
+ /**
4022
+ * Links the Twitch account associated with the token to the user's PlayFab account.
4023
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch
4024
+ */
4025
+ LinkTwitch(request: LinkTwitchAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkTwitchAccountResult>;
4026
+ /**
4027
+ * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
4028
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount
4029
+ */
4030
+ LinkXboxAccount(request: LinkXboxAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
4031
+ /**
4032
+ * Retrieves title-specific custom property values for a player.
4033
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
4034
+ */
4035
+ ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
4036
+ /**
4037
+ * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
4038
+ * API calls which require an authenticated user
4039
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid
4040
+ */
4041
+ LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4042
+ /**
4043
+ * Signs in the user with a Sign in with Apple identity token.
4044
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
4045
+ */
4046
+ LoginWithApple(request: LoginWithAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4047
+ /**
4048
+ * Sign in the user with a Battle.net identity token
4049
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet
4050
+ */
4051
+ LoginWithBattleNet(request: LoginWithBattleNetRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4052
+ /**
4053
+ * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
4054
+ * subsequently be used for API calls which require an authenticated user
4055
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
4056
+ */
4057
+ LoginWithCustomID(request: LoginWithCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4058
+ /**
4059
+ * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
4060
+ * which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
4061
+ * creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
4062
+ * RegisterPlayFabUser.
4063
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
4064
+ */
4065
+ LoginWithEmailAddress(request: LoginWithEmailAddressRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4066
+ /**
4067
+ * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
4068
+ * calls which require an authenticated user
4069
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook
4070
+ */
4071
+ LoginWithFacebook(request: LoginWithFacebookRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4072
+ /**
4073
+ * Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
4074
+ * API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
4075
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid
4076
+ */
4077
+ LoginWithFacebookInstantGamesId(request: LoginWithFacebookInstantGamesIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4078
+ /**
4079
+ * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be
4080
+ * used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not
4081
+ * include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you
4082
+ * require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and
4083
+ * enabling the 'Require secure authentication only for this app' option.
4084
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter
4085
+ */
4086
+ LoginWithGameCenter(request: LoginWithGameCenterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4087
+ /**
4088
+ * Signs the user in using their Google account credentials
4089
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount
4090
+ */
4091
+ LoginWithGoogleAccount(request: LoginWithGoogleAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4092
+ /**
4093
+ * Signs the user in using their Google Play Games account credentials
4094
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices
4095
+ */
4096
+ LoginWithGooglePlayGamesServices(request: LoginWithGooglePlayGamesServicesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4097
+ /**
4098
+ * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
4099
+ * be used for API calls which require an authenticated user
4100
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid
4101
+ */
4102
+ LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4103
+ /**
4104
+ * Signs the user in using a Kongregate player account.
4105
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate
4106
+ */
4107
+ LoginWithKongregate(request: LoginWithKongregateRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4108
+ /**
4109
+ * Signs in the user with a Nintendo service account token.
4110
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount
4111
+ */
4112
+ LoginWithNintendoServiceAccount(request: LoginWithNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4113
+ /**
4114
+ * Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
4115
+ * API calls which require an authenticated user
4116
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid
4117
+ */
4118
+ LoginWithNintendoSwitchDeviceId(request: LoginWithNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4119
+ /**
4120
+ * Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
4121
+ * provider.
4122
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect
4123
+ */
4124
+ LoginWithOpenIdConnect(request: LoginWithOpenIdConnectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4125
+ /**
4126
+ * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
4127
+ * which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
4128
+ * new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via
4129
+ * RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
4130
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab
4131
+ */
4132
+ LoginWithPlayFab(request: LoginWithPlayFabRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4133
+ /**
4134
+ * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
4135
+ * subsequently be used for API calls which require an authenticated user
4136
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn
4137
+ */
4138
+ LoginWithPSN(request: LoginWithPSNRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4139
+ /**
4140
+ * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
4141
+ * API calls which require an authenticated user
4142
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam
4143
+ */
4144
+ LoginWithSteam(request: LoginWithSteamRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4145
+ /**
4146
+ * Signs the user in using a Twitch access token.
4147
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch
4148
+ */
4149
+ LoginWithTwitch(request: LoginWithTwitchRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4150
+ /**
4151
+ * Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
4152
+ * which require an authenticated user
4153
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox
4154
+ */
4155
+ LoginWithXbox(request: LoginWithXboxRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4156
+ /**
4157
+ * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
4158
+ * https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade
4159
+ */
4160
+ OpenTrade(request: OpenTradeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<OpenTradeResponse>;
4161
+ /**
4162
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4163
+ * version 2._ Selects a payment option for purchase order created via StartPurchase
4164
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase
4165
+ */
4166
+ PayForPurchase(request: PayForPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<PayForPurchaseResult>;
4167
+ /**
4168
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4169
+ * version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
4170
+ * well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
4171
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem
4172
+ */
4173
+ PurchaseItem(request: PurchaseItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<PurchaseItemResult>;
4174
+ /**
4175
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4176
+ * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
4177
+ * Economy->Catalogs tab in the PlayFab Game Manager.
4178
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon
4179
+ */
4180
+ RedeemCoupon(request: RedeemCouponRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
4181
+ /**
4182
+ * Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
4183
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken
4184
+ */
4185
+ RefreshPSNAuthToken(request: RefreshPSNAuthTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4186
+ /**
4187
+ * Registers the iOS device to receive push notifications
4188
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification
4189
+ */
4190
+ RegisterForIOSPushNotification(request: RegisterForIOSPushNotificationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RegisterForIOSPushNotificationResult>;
4191
+ /**
4192
+ * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
4193
+ * require an authenticated user. You must supply a username and an email address.
4194
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser
4195
+ */
4196
+ RegisterPlayFabUser(request: RegisterPlayFabUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RegisterPlayFabUserResult>;
4197
+ /**
4198
+ * Removes a contact email from the player's profile.
4199
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail
4200
+ */
4201
+ RemoveContactEmail(request: RemoveContactEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveContactEmailResult>;
4202
+ /**
4203
+ * Removes a specified user from the friend list of the local user
4204
+ * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend
4205
+ */
4206
+ RemoveFriend(request: RemoveFriendRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveFriendResult>;
4207
+ /**
4208
+ * Removes the specified generic service identifier from the player's PlayFab account.
4209
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid
4210
+ */
4211
+ RemoveGenericID(request: RemoveGenericIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveGenericIDResult>;
4212
+ /**
4213
+ * 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
4214
+ * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
4215
+ * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
4216
+ * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
4217
+ * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers
4218
+ */
4219
+ RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
4220
+ /**
4221
+ * Report player's ad activity
4222
+ * https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity
4223
+ */
4224
+ ReportAdActivity(request: ReportAdActivityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportAdActivityResult>;
4225
+ /**
4226
+ * Write a PlayStream event to describe the provided player device information. This API method is not designed to be
4227
+ * called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
4228
+ * https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo
4229
+ */
4230
+ ReportDeviceInfo(request: DeviceInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4231
+ /**
4232
+ * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
4233
+ * can take action concerning potentially toxic players.
4234
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer
4235
+ */
4236
+ ReportPlayer(request: ReportPlayerClientRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportPlayerClientResult>;
4237
+ /**
4238
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4239
+ * version 2._ Restores all in-app purchases based on the given restore receipt
4240
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases
4241
+ */
4242
+ RestoreIOSPurchases(request: RestoreIOSPurchasesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RestoreIOSPurchasesResult>;
4243
+ /**
4244
+ * Reward player's ad activity
4245
+ * https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity
4246
+ */
4247
+ RewardAdActivity(request: RewardAdActivityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RewardAdActivityResult>;
4248
+ /**
4249
+ * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
4250
+ * change the password.If an account recovery email template ID is provided, an email using the custom email template will
4251
+ * be used.
4252
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail
4253
+ */
4254
+ SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
4255
+ /**
4256
+ * Updates the tag list for a specified user in the friend list of the local user
4257
+ * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags
4258
+ */
4259
+ SetFriendTags(request: SetFriendTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetFriendTagsResult>;
4260
+ /**
4261
+ * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
4262
+ * secret use the Admin or Server API method SetPlayerSecret.
4263
+ * https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret
4264
+ */
4265
+ SetPlayerSecret(request: SetPlayerSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
4266
+ /**
4267
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4268
+ * version 2._ Creates an order for a list of items from the title catalog
4269
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase
4270
+ */
4271
+ StartPurchase(request: StartPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<StartPurchaseResult>;
4272
+ /**
4273
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4274
+ * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
4275
+ * a VC balance negative with this API.
4276
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency
4277
+ */
4278
+ SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
4279
+ /**
4280
+ * Unlinks the related Android device identifier from the user's PlayFab account
4281
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid
4282
+ */
4283
+ UnlinkAndroidDeviceID(request: UnlinkAndroidDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkAndroidDeviceIDResult>;
4284
+ /**
4285
+ * Unlinks the related Apple account from the user's PlayFab account.
4286
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple
4287
+ */
4288
+ UnlinkApple(request: UnlinkAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4289
+ /**
4290
+ * Unlinks the related Battle.net account from the user's PlayFab account.
4291
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount
4292
+ */
4293
+ UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4294
+ /**
4295
+ * Unlinks the related custom identifier from the user's PlayFab account
4296
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid
4297
+ */
4298
+ UnlinkCustomID(request: UnlinkCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkCustomIDResult>;
4299
+ /**
4300
+ * Unlinks the related Facebook account from the user's PlayFab account
4301
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount
4302
+ */
4303
+ UnlinkFacebookAccount(request: UnlinkFacebookAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookAccountResult>;
4304
+ /**
4305
+ * Unlinks the related Facebook Instant Game Ids from the user's PlayFab account
4306
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid
4307
+ */
4308
+ UnlinkFacebookInstantGamesId(request: UnlinkFacebookInstantGamesIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookInstantGamesIdResult>;
4309
+ /**
4310
+ * Unlinks the related Game Center account from the user's PlayFab account
4311
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount
4312
+ */
4313
+ UnlinkGameCenterAccount(request: UnlinkGameCenterAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkGameCenterAccountResult>;
4314
+ /**
4315
+ * Unlinks the related Google account from the user's PlayFab account
4316
+ * (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
4317
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount
4318
+ */
4319
+ UnlinkGoogleAccount(request: UnlinkGoogleAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkGoogleAccountResult>;
4320
+ /**
4321
+ * Unlinks the related Google Play Games account from the user's PlayFab account.
4322
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount
4323
+ */
4324
+ UnlinkGooglePlayGamesServicesAccount(request: UnlinkGooglePlayGamesServicesAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkGooglePlayGamesServicesAccountResult>;
4325
+ /**
4326
+ * Unlinks the related iOS device identifier from the user's PlayFab account
4327
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid
4328
+ */
4329
+ UnlinkIOSDeviceID(request: UnlinkIOSDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkIOSDeviceIDResult>;
4330
+ /**
4331
+ * Unlinks the related Kongregate identifier from the user's PlayFab account
4332
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate
4333
+ */
4334
+ UnlinkKongregate(request: UnlinkKongregateAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkKongregateAccountResult>;
4335
+ /**
4336
+ * Unlinks the related Nintendo account from the user's PlayFab account.
4337
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount
4338
+ */
4339
+ UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4340
+ /**
4341
+ * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
4342
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid
4343
+ */
4344
+ UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
4345
+ /**
4346
+ * Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
4347
+ * between a title and an Open ID Connect provider.
4348
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect
4349
+ */
4350
+ UnlinkOpenIdConnect(request: UnlinkOpenIdConnectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4351
+ /**
4352
+ * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
4353
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount
4354
+ */
4355
+ UnlinkPSNAccount(request: UnlinkPSNAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
4356
+ /**
4357
+ * Unlinks the related Steam account from the user's PlayFab account
4358
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount
4359
+ */
4360
+ UnlinkSteamAccount(request: UnlinkSteamAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkSteamAccountResult>;
4361
+ /**
4362
+ * Unlinks the related Twitch account from the user's PlayFab account.
4363
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch
4364
+ */
4365
+ UnlinkTwitch(request: UnlinkTwitchAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkTwitchAccountResult>;
4366
+ /**
4367
+ * Unlinks the related Xbox Live account from the user's PlayFab account
4368
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount
4369
+ */
4370
+ UnlinkXboxAccount(request: UnlinkXboxAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
4371
+ /**
4372
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4373
+ * version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
4374
+ * opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will
4375
+ * be decremented, consistent with the operation of ConsumeItem.
4376
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance
4377
+ */
4378
+ UnlockContainerInstance(request: UnlockContainerInstanceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
4379
+ /**
4380
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4381
+ * version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
4382
+ * using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are
4383
+ * consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
4384
+ * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem
4385
+ */
4386
+ UnlockContainerItem(request: UnlockContainerItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
4387
+ /**
4388
+ * Update the avatar URL of the player
4389
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl
4390
+ */
4391
+ UpdateAvatarUrl(request: UpdateAvatarUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4392
+ /**
4393
+ * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
4394
+ * https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata
4395
+ */
4396
+ UpdateCharacterData(request: UpdateCharacterDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
4397
+ /**
4398
+ * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
4399
+ * permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
4400
+ * https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics
4401
+ */
4402
+ UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
4403
+ /**
4404
+ * Updates the title-specific custom property values for a player
4405
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties
4406
+ */
4407
+ UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
4408
+ /**
4409
+ * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
4410
+ * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
4411
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics
4412
+ */
4413
+ UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
4414
+ /**
4415
+ * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
4416
+ * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
4417
+ * Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for
4418
+ * sharing data between a very small number of players, please see our guide:
4419
+ * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
4420
+ * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata
4421
+ */
4422
+ UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
4423
+ /**
4424
+ * Creates and updates the title-specific custom data for the user which is readable and writable by the client
4425
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata
4426
+ */
4427
+ UpdateUserData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
4428
+ /**
4429
+ * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client
4430
+ * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata
4431
+ */
4432
+ UpdateUserPublisherData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
4433
+ /**
4434
+ * Updates the title specific display name for the user
4435
+ * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname
4436
+ */
4437
+ UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
4438
+ /**
4439
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4440
+ * version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
4441
+ * the purchased catalog item
4442
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt
4443
+ */
4444
+ ValidateAmazonIAPReceipt(request: ValidateAmazonReceiptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateAmazonReceiptResult>;
4445
+ /**
4446
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4447
+ * version 2._ Validates a Google Play purchase and gives the corresponding item to the player.
4448
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase
4449
+ */
4450
+ ValidateGooglePlayPurchase(request: ValidateGooglePlayPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateGooglePlayPurchaseResult>;
4451
+ /**
4452
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4453
+ * version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
4454
+ * purchased catalog item
4455
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt
4456
+ */
4457
+ ValidateIOSReceipt(request: ValidateIOSReceiptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateIOSReceiptResult>;
4458
+ /**
4459
+ * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4460
+ * version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
4461
+ * matches the purchased catalog item
4462
+ * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt
4463
+ */
4464
+ ValidateWindowsStoreReceipt(request: ValidateWindowsReceiptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateWindowsReceiptResult>;
4465
+ /**
4466
+ * Writes a character-based event into PlayStream.
4467
+ * https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent
4468
+ */
4469
+ WriteCharacterEvent(request: WriteClientCharacterEventRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
4470
+ /**
4471
+ * Writes a player-based event into PlayStream.
4472
+ * https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent
4473
+ */
4474
+ WritePlayerEvent(request: WriteClientPlayerEventRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
4475
+ /**
4476
+ * Writes a title-based event into PlayStream.
4477
+ * https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent
4478
+ */
4479
+ WriteTitleEvent(request: WriteTitleEventRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
4480
+ }
4481
+
4482
+ export { PlayFabClientApi as default };