async-playfab-web-sdk 1.192.250526 → 1.193.250606

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 (126) hide show
  1. package/dist/{Addon.d.mts → Addon.d.ts} +213 -73
  2. package/dist/Addon.js +8 -0
  3. package/dist/Addon.js.map +1 -1
  4. package/dist/{Admin.d.mts → Admin.d.ts} +2547 -356
  5. package/dist/Admin.js +8 -0
  6. package/dist/Admin.js.map +1 -1
  7. package/dist/{Authentication.d.mts → Authentication.d.ts} +36 -9
  8. package/dist/Authentication.js +8 -0
  9. package/dist/Authentication.js.map +1 -1
  10. package/dist/{Client.d.mts → Client.d.ts} +2473 -557
  11. package/dist/Client.js +8 -0
  12. package/dist/Client.js.map +1 -1
  13. package/dist/{CloudScript.d.mts → CloudScript.d.ts} +214 -46
  14. package/dist/CloudScript.js +8 -0
  15. package/dist/CloudScript.js.map +1 -1
  16. package/dist/{Data.d.mts → Data.d.ts} +144 -25
  17. package/dist/Data.js +8 -0
  18. package/dist/Data.js.map +1 -1
  19. package/dist/{Economy.d.mts → Economy.d.ts} +1218 -173
  20. package/dist/Economy.js +8 -0
  21. package/dist/Economy.js.map +1 -1
  22. package/dist/{Events.d.mts → Events.d.ts} +212 -25
  23. package/dist/Events.js +8 -0
  24. package/dist/Events.js.map +1 -1
  25. package/dist/{Experimentation.d.mts → Experimentation.d.ts} +177 -30
  26. package/dist/Experimentation.js +8 -0
  27. package/dist/Experimentation.js.map +1 -1
  28. package/dist/{Groups.d.mts → Groups.d.ts} +306 -67
  29. package/dist/Groups.js +8 -0
  30. package/dist/Groups.js.map +1 -1
  31. package/dist/{Insights.d.mts → Insights.d.ts} +39 -13
  32. package/dist/Insights.js +8 -0
  33. package/dist/Insights.js.map +1 -1
  34. package/dist/{Localization.d.mts → Localization.d.ts} +6 -3
  35. package/dist/Localization.js +8 -0
  36. package/dist/Localization.js.map +1 -1
  37. package/dist/Matchmaker.d.ts +271 -0
  38. package/dist/Matchmaker.js +8 -0
  39. package/dist/Matchmaker.js.map +1 -0
  40. package/dist/{Multiplayer.d.mts → Multiplayer.d.ts} +2829 -301
  41. package/dist/Multiplayer.js +8 -0
  42. package/dist/Multiplayer.js.map +1 -1
  43. package/dist/{PlayFabCommon-BUv4zqXf.d.mts → PlayFabCommon-Dnp_xHg5.d.ts} +6 -10
  44. package/dist/{Profiles.d.mts → Profiles.d.ts} +172 -28
  45. package/dist/Profiles.js +8 -0
  46. package/dist/Profiles.js.map +1 -1
  47. package/dist/{Progression.d.mts → Progression.d.ts} +337 -73
  48. package/dist/Progression.js +8 -0
  49. package/dist/Progression.js.map +1 -1
  50. package/dist/{Server.d.mts → Server.d.ts} +2120 -458
  51. package/dist/Server.js +8 -0
  52. package/dist/Server.js.map +1 -1
  53. package/dist/chunk-5LPKBU65.js +2970 -0
  54. package/dist/chunk-5LPKBU65.js.map +1 -0
  55. package/dist/chunk-ABEEDFKP.js +175 -0
  56. package/dist/chunk-ABEEDFKP.js.map +1 -0
  57. package/dist/chunk-AGNOI6QW.js +2477 -0
  58. package/dist/chunk-AGNOI6QW.js.map +1 -0
  59. package/dist/chunk-B4NQUOWG.js +1048 -0
  60. package/dist/chunk-B4NQUOWG.js.map +1 -0
  61. package/dist/chunk-GERGPHQM.js +76 -0
  62. package/dist/chunk-GERGPHQM.js.map +1 -0
  63. package/dist/chunk-GOZV2MOC.js +2673 -0
  64. package/dist/chunk-GOZV2MOC.js.map +1 -0
  65. package/dist/chunk-GXP64DCJ.js +82 -0
  66. package/dist/chunk-GXP64DCJ.js.map +1 -0
  67. package/dist/chunk-HUS6GF7X.js +270 -0
  68. package/dist/chunk-HUS6GF7X.js.map +1 -0
  69. package/dist/chunk-JIEFHAFU.js +197 -0
  70. package/dist/chunk-JIEFHAFU.js.map +1 -0
  71. package/dist/chunk-LCCANUCE.js +2387 -0
  72. package/dist/chunk-LCCANUCE.js.map +1 -0
  73. package/dist/chunk-MNQCGRC6.js +357 -0
  74. package/dist/chunk-MNQCGRC6.js.map +1 -0
  75. package/dist/chunk-N4R6Y2MM.js +225 -0
  76. package/dist/chunk-N4R6Y2MM.js.map +1 -0
  77. package/dist/{Localization.mjs → chunk-N7LC7KNB.js} +43 -94
  78. package/dist/chunk-N7LC7KNB.js.map +1 -0
  79. package/dist/chunk-NPTN4F4Z.js +22 -0
  80. package/dist/chunk-NPTN4F4Z.js.map +1 -0
  81. package/dist/chunk-QHGWL3NW.js +237 -0
  82. package/dist/chunk-QHGWL3NW.js.map +1 -0
  83. package/dist/chunk-RKXM4KV5.js +421 -0
  84. package/dist/chunk-RKXM4KV5.js.map +1 -0
  85. package/dist/chunk-UDM2ZVXN.js +421 -0
  86. package/dist/chunk-UDM2ZVXN.js.map +1 -0
  87. package/dist/chunk-ZEBSOOZG.js +82 -0
  88. package/dist/chunk-ZEBSOOZG.js.map +1 -0
  89. package/dist/index.d.ts +18 -0
  90. package/dist/index.js +72 -0
  91. package/dist/index.js.map +1 -1
  92. package/package.json +2 -1
  93. package/dist/Addon.mjs +0 -452
  94. package/dist/Addon.mjs.map +0 -1
  95. package/dist/Admin.mjs +0 -1112
  96. package/dist/Admin.mjs.map +0 -1
  97. package/dist/Authentication.mjs +0 -290
  98. package/dist/Authentication.mjs.map +0 -1
  99. package/dist/Client.mjs +0 -1893
  100. package/dist/Client.mjs.map +0 -1
  101. package/dist/CloudScript.mjs +0 -349
  102. package/dist/CloudScript.mjs.map +0 -1
  103. package/dist/Data.mjs +0 -291
  104. package/dist/Data.mjs.map +0 -1
  105. package/dist/Economy.mjs +0 -614
  106. package/dist/Economy.mjs.map +0 -1
  107. package/dist/Events.mjs +0 -327
  108. package/dist/Events.mjs.map +0 -1
  109. package/dist/Experimentation.mjs +0 -333
  110. package/dist/Experimentation.mjs.map +0 -1
  111. package/dist/Groups.mjs +0 -417
  112. package/dist/Groups.mjs.map +0 -1
  113. package/dist/Insights.mjs +0 -286
  114. package/dist/Insights.mjs.map +0 -1
  115. package/dist/Localization.mjs.map +0 -1
  116. package/dist/Multiplayer.mjs +0 -862
  117. package/dist/Multiplayer.mjs.map +0 -1
  118. package/dist/Profiles.mjs +0 -306
  119. package/dist/Profiles.mjs.map +0 -1
  120. package/dist/Progression.mjs +0 -404
  121. package/dist/Progression.mjs.map +0 -1
  122. package/dist/Server.mjs +0 -1377
  123. package/dist/Server.mjs.map +0 -1
  124. package/dist/index.d.mts +0 -17
  125. package/dist/index.mjs +0 -6007
  126. package/dist/index.mjs.map +0 -1
@@ -1,8 +1,8 @@
1
- import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.mjs';
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
2
2
 
3
3
  interface AcceptTradeRequest extends IPlayFabRequestCommon {
4
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
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
6
  * will be null.
7
7
  */
8
8
  AcceptedInventoryInstanceIds?: string[];
@@ -24,13 +24,13 @@ interface AdCampaignAttributionModel {
24
24
  Platform?: string;
25
25
  }
26
26
  interface AddFriendRequest extends IPlayFabRequestCommon {
27
- /** Email address of the user to attempt to add to the local user's friend list. */
27
+ /** Email address of the user to attempt to add to the local user's friend list. */
28
28
  FriendEmail?: string;
29
- /** PlayFab identifier of the user to attempt to add to the local user's friend list. */
29
+ /** PlayFab identifier of the user to attempt to add to the local user's friend list. */
30
30
  FriendPlayFabId?: string;
31
- /** Title-specific display name of the user to attempt to add to the local user's friend list. */
31
+ /** Title-specific display name of the user to attempt to add to the local user's friend list. */
32
32
  FriendTitleDisplayName?: string;
33
- /** PlayFab username of the user to attempt to add to the local user's friend list. */
33
+ /** PlayFab username of the user to attempt to add to the local user's friend list. */
34
34
  FriendUsername?: string;
35
35
  }
36
36
  interface AddFriendResult extends IPlayFabResultCommon {
@@ -133,6 +133,11 @@ interface AndroidDevicePushNotificationRegistrationResult extends IPlayFabResult
133
133
  interface AttributeInstallRequest extends IPlayFabRequestCommon {
134
134
  /** The adid for this device. */
135
135
  Adid?: string;
136
+ /**
137
+ * The android advertising id. This field is deprecated in favor of Adid for clarity.
138
+ * @deprecated Please use Adid instead.
139
+ */
140
+ Android_Id?: string;
136
141
  /** The IdentifierForAdvertisers for iOS Devices. */
137
142
  Idfa?: string;
138
143
  }
@@ -223,7 +228,7 @@ interface CatalogItem {
223
228
  RealCurrencyPrices?: Record<string, number>;
224
229
  /** list of item tags */
225
230
  Tags?: string[];
226
- /** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
231
+ /** price of this item in virtual currencies and &quot;RM&quot; (the base Real Money purchase price, in USD pennies) */
227
232
  VirtualCurrencyPrices?: Record<string, number>;
228
233
  }
229
234
  interface CatalogItemBundleInfo {
@@ -243,7 +248,7 @@ interface CatalogItemConsumableInfo {
243
248
  /**
244
249
  * duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
245
250
  * (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)
251
+ * this item&#39;s details have completed)
247
252
  */
248
253
  UsagePeriod?: number;
249
254
  /**
@@ -285,9 +290,9 @@ interface CharacterLeaderboardEntry {
285
290
  DisplayName?: string;
286
291
  /** PlayFab unique identifier of the user for this leaderboard entry. */
287
292
  PlayFabId?: string;
288
- /** User's overall position in the leaderboard. */
293
+ /** User&#39;s overall position in the leaderboard. */
289
294
  Position: number;
290
- /** Specific value of the user's statistic. */
295
+ /** Specific value of the user&#39;s statistic. */
291
296
  StatValue: number;
292
297
  }
293
298
  interface CharacterResult {
@@ -298,6 +303,16 @@ interface CharacterResult {
298
303
  /** The type-string that was given to this character on creation. */
299
304
  CharacterType?: string;
300
305
  }
306
+ /** @deprecated Do not use */
307
+ interface CollectionFilter {
308
+ /** List of Exclude rules, with any of which if a collection matches, it is excluded by the filter. */
309
+ Excludes?: Container_Dictionary_String_String[];
310
+ /**
311
+ * List of Include rules, with any of which if a collection matches, it is included by the filter, unless it is excluded by
312
+ * one of the Exclude rule
313
+ */
314
+ Includes?: Container_Dictionary_String_String[];
315
+ }
301
316
  interface ConfirmPurchaseRequest extends IPlayFabRequestCommon {
302
317
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
303
318
  CustomTags?: Record<string, string | null>;
@@ -369,7 +384,7 @@ interface ConsumeXboxEntitlementsRequest extends IPlayFabRequestCommon {
369
384
  CatalogVersion?: string;
370
385
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
371
386
  CustomTags?: Record<string, string | null>;
372
- /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
387
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). */
373
388
  XboxToken: string;
374
389
  }
375
390
  interface ConsumeXboxEntitlementsResult extends IPlayFabResultCommon {
@@ -384,6 +399,11 @@ interface ContactEmailInfoModel {
384
399
  /** The verification status of the email */
385
400
  VerificationStatus?: string;
386
401
  }
402
+ /** @deprecated Do not use */
403
+ interface Container_Dictionary_String_String {
404
+ /** Content of data */
405
+ Data?: Record<string, string | null>;
406
+ }
387
407
  interface CreateSharedGroupRequest extends IPlayFabRequestCommon {
388
408
  /** Unique identifier for the shared group (a random identifier will be assigned, if one is not specified). */
389
409
  SharedGroupId?: string;
@@ -392,10 +412,32 @@ interface CreateSharedGroupResult extends IPlayFabResultCommon {
392
412
  /** Unique identifier for the shared group. */
393
413
  SharedGroupId?: string;
394
414
  }
415
+ /** @deprecated Do not use */
416
+ interface CurrentGamesRequest extends IPlayFabRequestCommon {
417
+ /** Build to match against. */
418
+ BuildVersion?: string;
419
+ /** Game mode to look for. */
420
+ GameMode?: string;
421
+ /** Region to check for Game Server Instances. */
422
+ Region?: string;
423
+ /** Statistic name to find statistic-based matches. */
424
+ StatisticName?: string;
425
+ /** Filter to include and/or exclude Game Server Instances associated with certain tags. */
426
+ TagFilter?: CollectionFilter;
427
+ }
428
+ /** @deprecated Do not use */
429
+ interface CurrentGamesResult extends IPlayFabResultCommon {
430
+ /** number of games running */
431
+ GameCount: number;
432
+ /** array of games found */
433
+ Games?: GameInfo[];
434
+ /** total number of players across all servers */
435
+ PlayerCount: number;
436
+ }
395
437
  interface CustomPropertyDetails {
396
- /** The custom property's name. */
438
+ /** The custom property&#39;s name. */
397
439
  Name?: string;
398
- /** The custom property's value. */
440
+ /** The custom property&#39;s value. */
399
441
  Value?: any;
400
442
  }
401
443
  interface DeletedPropertyDetails {
@@ -409,7 +451,7 @@ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
409
451
  CustomTags?: Record<string, string | null>;
410
452
  /**
411
453
  * 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.
454
+ * player&#39;s properties have not been updated by any other clients since the last version.
413
455
  */
414
456
  ExpectedPropertiesVersion?: number;
415
457
  /** A list of property names denoting which properties should be deleted. */
@@ -419,7 +461,7 @@ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
419
461
  /** The list of properties requested to be deleted. */
420
462
  DeletedProperties?: DeletedPropertyDetails[];
421
463
  /**
422
- * Indicates the current version of a player's properties that have been set. This is incremented after updates and
464
+ * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
423
465
  * deletes. This version can be provided in update and delete calls for concurrency control.
424
466
  */
425
467
  PropertiesVersion: number;
@@ -435,6 +477,11 @@ interface EntityKey {
435
477
  Id: string;
436
478
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
437
479
  Type?: string;
480
+ /**
481
+ * Alternate name for Type.
482
+ * @deprecated Please use Type instead.
483
+ */
484
+ TypeString?: string;
438
485
  }
439
486
  interface EntityTokenResponse {
440
487
  /** The entity id and type. */
@@ -452,17 +499,17 @@ interface ExecuteCloudScriptRequest extends IPlayFabRequestCommon {
452
499
  /** Object that is passed in to the function as the first argument */
453
500
  FunctionParameter?: any;
454
501
  /**
455
- * Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other
502
+ * Generate a &#39;player_executed_cloudscript&#39; PlayStream event containing the results of the function execution and other
456
503
  * contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
457
504
  */
458
505
  GeneratePlayStreamEvent?: boolean;
459
506
  /**
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'.
507
+ * Option for which revision of the CloudScript to execute. &#39;Latest&#39; executes the most recently created revision, &#39;Live&#39;
508
+ * executes the current live, published revision, and &#39;Specific&#39; executes the specified revision. The default value is
509
+ * &#39;Specific&#39;, if the SpeificRevision parameter is specified, otherwise it is &#39;Live&#39;.
463
510
  */
464
511
  RevisionSelection?: string;
465
- /** The specivic revision to execute, when RevisionSelection is set to 'Specific' */
512
+ /** The specivic revision to execute, when RevisionSelection is set to &#39;Specific&#39; */
466
513
  SpecificRevision?: number;
467
514
  }
468
515
  interface ExecuteCloudScriptResult extends IPlayFabResultCommon {
@@ -514,6 +561,11 @@ interface FacebookPlayFabIdPair {
514
561
  PlayFabId?: string;
515
562
  }
516
563
  interface FriendInfo {
564
+ /**
565
+ * This field is not populated.
566
+ * @deprecated Do not use
567
+ */
568
+ CurrentMatchmakerLobbyId?: string;
517
569
  /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */
518
570
  FacebookInfo?: UserFacebookInfo;
519
571
  /** PlayFab unique identifier for this friend. */
@@ -547,6 +599,66 @@ interface GameCenterPlayFabIdPair {
547
599
  /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Game Center identifier. */
548
600
  PlayFabId?: string;
549
601
  }
602
+ /** @deprecated Do not use */
603
+ interface GameInfo {
604
+ /** build version this server is running */
605
+ BuildVersion?: string;
606
+ /** game mode this server is running */
607
+ GameMode?: string;
608
+ /** game session custom data */
609
+ GameServerData?: string;
610
+ /**
611
+ * game specific string denoting server configuration
612
+ * @deprecated Please use GameServerStateEnum instead.
613
+ */
614
+ GameServerState?: number;
615
+ /** game specific string denoting server configuration */
616
+ GameServerStateEnum?: string;
617
+ /** last heartbeat of the game server instance, used in external game server provider mode */
618
+ LastHeartbeat?: string;
619
+ /** unique lobby identifier for this game server */
620
+ LobbyID?: string;
621
+ /** maximum players this server can support */
622
+ MaxPlayers?: number;
623
+ /** array of current player IDs on this server */
624
+ PlayerUserIds?: string[];
625
+ /** region to which this server is associated */
626
+ Region?: string;
627
+ /** duration in seconds this server has been running */
628
+ RunTime: number;
629
+ /**
630
+ * IPV4 address of the server
631
+ * @deprecated Please use ServerIPV4Address instead.
632
+ */
633
+ ServerHostname?: string;
634
+ /** IPV4 address of the server */
635
+ ServerIPV4Address?: string;
636
+ /** IPV6 address of the server */
637
+ ServerIPV6Address?: string;
638
+ /** port number to use for non-http communications with the server */
639
+ ServerPort?: number;
640
+ /** Public DNS name (if any) of the server */
641
+ ServerPublicDNSName?: string;
642
+ /** stastic used to match this game in player statistic matchmaking */
643
+ StatisticName?: string;
644
+ /** game session tags */
645
+ Tags?: Record<string, string | null>;
646
+ }
647
+ /** @deprecated Do not use */
648
+ interface GameServerRegionsRequest extends IPlayFabRequestCommon {
649
+ /** version of game server for which stats are being requested */
650
+ BuildVersion: string;
651
+ /**
652
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
653
+ * title has been selected.
654
+ */
655
+ TitleId?: string;
656
+ }
657
+ /** @deprecated Do not use */
658
+ interface GameServerRegionsResult extends IPlayFabResultCommon {
659
+ /** array of regions found matching the request parameters */
660
+ Regions?: RegionInfo[];
661
+ }
550
662
  interface GenericPlayFabIdPair {
551
663
  /** Unique generic service identifier for a user. */
552
664
  GenericId?: GenericServiceId;
@@ -640,6 +752,11 @@ interface GetCharacterInventoryResult extends IPlayFabResultCommon {
640
752
  VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
641
753
  }
642
754
  interface GetCharacterLeaderboardRequest extends IPlayFabRequestCommon {
755
+ /**
756
+ * Optional character type on which to filter the leaderboard entries.
757
+ * @deprecated Do not use
758
+ */
759
+ CharacterType?: string;
643
760
  /** Maximum number of entries to retrieve. Default 10, maximum 100. */
644
761
  MaxResultsCount?: number;
645
762
  /** First entry in the leaderboard to be retrieved. */
@@ -659,6 +776,21 @@ interface GetCharacterStatisticsResult extends IPlayFabResultCommon {
659
776
  /** The requested character statistics. */
660
777
  CharacterStatistics?: Record<string, number>;
661
778
  }
779
+ /** @deprecated Do not use */
780
+ interface GetCloudScriptUrlRequest extends IPlayFabRequestCommon {
781
+ /**
782
+ * Specifies whether the URL returned should be the one for the most recently uploaded Revision of the Cloud Script (true),
783
+ * or the Revision most recently set to live (false). Defaults to false.
784
+ */
785
+ Testing?: boolean;
786
+ /** Cloud Script Version to use. Defaults to 1. */
787
+ Version?: number;
788
+ }
789
+ /** @deprecated Do not use */
790
+ interface GetCloudScriptUrlResult extends IPlayFabResultCommon {
791
+ /** URL of the Cloud Script logic server. */
792
+ Url?: string;
793
+ }
662
794
  interface GetContentDownloadUrlRequest extends IPlayFabRequestCommon {
663
795
  /** HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET. */
664
796
  HttpMethod?: string;
@@ -674,14 +806,59 @@ interface GetContentDownloadUrlResult extends IPlayFabResultCommon {
674
806
  /** URL for downloading content via HTTP GET or HEAD method. The URL will expire in approximately one hour. */
675
807
  URL?: string;
676
808
  }
809
+ /** @deprecated Do not use */
810
+ interface GetFriendLeaderboardAroundCurrentUserRequest extends IPlayFabRequestCommon {
811
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
812
+ CustomTags?: Record<string, string | null>;
813
+ /**
814
+ * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
815
+ * comma-separated list of platforms.
816
+ */
817
+ ExternalPlatformFriends?: string;
818
+ /**
819
+ * Indicates whether Facebook friends should be included in the response. Default is true.
820
+ * @deprecated Please use ExternalPlatformFriends instead.
821
+ */
822
+ IncludeFacebookFriends?: boolean;
823
+ /**
824
+ * Indicates whether Steam service friends should be included in the response. Default is true.
825
+ * @deprecated Please use ExternalPlatformFriends instead.
826
+ */
827
+ IncludeSteamFriends?: boolean;
828
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
829
+ MaxResultsCount?: number;
830
+ /** Statistic used to rank players for this leaderboard. */
831
+ StatisticName: string;
832
+ /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
833
+ XboxToken?: string;
834
+ }
835
+ /** @deprecated Do not use */
836
+ interface GetFriendLeaderboardAroundCurrentUserResult extends IPlayFabResultCommon {
837
+ /** Ordered listing of users and their positions in the requested leaderboard. */
838
+ Leaderboard?: PlayerLeaderboardEntry[];
839
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
840
+ NextReset?: string;
841
+ /** The version of the leaderboard returned. */
842
+ Version: number;
843
+ }
677
844
  interface GetFriendLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
678
845
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
679
846
  CustomTags?: Record<string, string | null>;
680
847
  /**
681
- * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
848
+ * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
682
849
  * comma-separated list of platforms.
683
850
  */
684
851
  ExternalPlatformFriends?: string;
852
+ /**
853
+ * Indicates whether Facebook friends should be included in the response. Default is true.
854
+ * @deprecated Please use ExternalPlatformFriends instead.
855
+ */
856
+ IncludeFacebookFriends?: boolean;
857
+ /**
858
+ * Indicates whether Steam service friends should be included in the response. Default is true.
859
+ * @deprecated Please use ExternalPlatformFriends instead.
860
+ */
861
+ IncludeSteamFriends?: boolean;
685
862
  /** Maximum number of entries to retrieve. Default 10, maximum 100. */
686
863
  MaxResultsCount?: number;
687
864
  /** PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user. */
@@ -689,11 +866,13 @@ interface GetFriendLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon
689
866
  /**
690
867
  * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
691
868
  * 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.
869
+ * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
693
870
  */
694
871
  ProfileConstraints?: PlayerProfileViewConstraints;
695
872
  /** Statistic used to rank players for this leaderboard. */
696
873
  StatisticName: string;
874
+ /** If set to false, Version is considered null. If true, uses the specified Version */
875
+ UseSpecificVersion?: boolean;
697
876
  /** The version of the leaderboard to get. */
698
877
  Version?: number;
699
878
  /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
@@ -711,22 +890,34 @@ interface GetFriendLeaderboardRequest extends IPlayFabRequestCommon {
711
890
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
712
891
  CustomTags?: Record<string, string | null>;
713
892
  /**
714
- * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
893
+ * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
715
894
  * comma-separated list of platforms.
716
895
  */
717
896
  ExternalPlatformFriends?: string;
897
+ /**
898
+ * Indicates whether Facebook friends should be included in the response. Default is true.
899
+ * @deprecated Please use ExternalPlatformFriends instead.
900
+ */
901
+ IncludeFacebookFriends?: boolean;
902
+ /**
903
+ * Indicates whether Steam service friends should be included in the response. Default is true.
904
+ * @deprecated Please use ExternalPlatformFriends instead.
905
+ */
906
+ IncludeSteamFriends?: boolean;
718
907
  /** Maximum number of entries to retrieve. Default 10, maximum 100. */
719
908
  MaxResultsCount?: number;
720
909
  /**
721
910
  * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
722
911
  * 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.
912
+ * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
724
913
  */
725
914
  ProfileConstraints?: PlayerProfileViewConstraints;
726
915
  /** Position in the leaderboard to start this listing (defaults to the first entry). */
727
916
  StartPosition: number;
728
917
  /** Statistic used to rank friends for this leaderboard. */
729
918
  StatisticName: string;
919
+ /** If set to false, Version is considered null. If true, uses the specified Version */
920
+ UseSpecificVersion?: boolean;
730
921
  /** The version of the leaderboard to get. */
731
922
  Version?: number;
732
923
  /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
@@ -736,14 +927,24 @@ interface GetFriendsListRequest extends IPlayFabRequestCommon {
736
927
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
737
928
  CustomTags?: Record<string, string | null>;
738
929
  /**
739
- * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
930
+ * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
740
931
  * comma-separated list of platforms.
741
932
  */
742
933
  ExternalPlatformFriends?: string;
934
+ /**
935
+ * Indicates whether Facebook friends should be included in the response. Default is true.
936
+ * @deprecated Please use ExternalPlatformFriends instead.
937
+ */
938
+ IncludeFacebookFriends?: boolean;
939
+ /**
940
+ * Indicates whether Steam service friends should be included in the response. Default is true.
941
+ * @deprecated Please use ExternalPlatformFriends instead.
942
+ */
943
+ IncludeSteamFriends?: boolean;
743
944
  /**
744
945
  * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
745
946
  * 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.
947
+ * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
747
948
  */
748
949
  ProfileConstraints?: PlayerProfileViewConstraints;
749
950
  /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
@@ -756,6 +957,11 @@ interface GetFriendsListResult extends IPlayFabResultCommon {
756
957
  interface GetLeaderboardAroundCharacterRequest extends IPlayFabRequestCommon {
757
958
  /** Unique PlayFab assigned ID for a specific character on which to center the leaderboard. */
758
959
  CharacterId: string;
960
+ /**
961
+ * Optional character type on which to filter the leaderboard entries.
962
+ * @deprecated Do not use
963
+ */
964
+ CharacterType?: string;
759
965
  /** Maximum number of entries to retrieve. Default 10, maximum 100. */
760
966
  MaxResultsCount?: number;
761
967
  /** Unique identifier for the title-specific statistic for the leaderboard. */
@@ -765,6 +971,24 @@ interface GetLeaderboardAroundCharacterResult extends IPlayFabResultCommon {
765
971
  /** Ordered list of leaderboard entries. */
766
972
  Leaderboard?: CharacterLeaderboardEntry[];
767
973
  }
974
+ /** @deprecated Do not use */
975
+ interface GetLeaderboardAroundCurrentUserRequest extends IPlayFabRequestCommon {
976
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
977
+ CustomTags?: Record<string, string | null>;
978
+ /** Maximum number of entries to retrieve. Default 10, maximum 100. */
979
+ MaxResultsCount?: number;
980
+ /** Statistic used to rank players for this leaderboard. */
981
+ StatisticName: string;
982
+ }
983
+ /** @deprecated Do not use */
984
+ interface GetLeaderboardAroundCurrentUserResult extends IPlayFabResultCommon {
985
+ /** Ordered listing of users and their positions in the requested leaderboard. */
986
+ Leaderboard?: PlayerLeaderboardEntry[];
987
+ /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
988
+ NextReset?: string;
989
+ /** The version of the leaderboard returned. */
990
+ Version: number;
991
+ }
768
992
  interface GetLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
769
993
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
770
994
  CustomTags?: Record<string, string | null>;
@@ -775,11 +999,13 @@ interface GetLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
775
999
  /**
776
1000
  * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
777
1001
  * 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.
1002
+ * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
779
1003
  */
780
1004
  ProfileConstraints?: PlayerProfileViewConstraints;
781
1005
  /** Statistic used to rank players for this leaderboard. */
782
1006
  StatisticName: string;
1007
+ /** If set to false, Version is considered null. If true, uses the specified Version */
1008
+ UseSpecificVersion?: boolean;
783
1009
  /** The version of the leaderboard to get. */
784
1010
  Version?: number;
785
1011
  }
@@ -792,6 +1018,11 @@ interface GetLeaderboardAroundPlayerResult extends IPlayFabResultCommon {
792
1018
  Version: number;
793
1019
  }
794
1020
  interface GetLeaderboardForUsersCharactersRequest extends IPlayFabRequestCommon {
1021
+ /**
1022
+ * Maximum number of entries to retrieve.
1023
+ * @deprecated Please use instead.
1024
+ */
1025
+ MaxResultsCount?: number;
795
1026
  /** Unique identifier for the title-specific statistic for the leaderboard. */
796
1027
  StatisticName: string;
797
1028
  }
@@ -807,13 +1038,15 @@ interface GetLeaderboardRequest extends IPlayFabRequestCommon {
807
1038
  /**
808
1039
  * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
809
1040
  * 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.
1041
+ * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
811
1042
  */
812
1043
  ProfileConstraints?: PlayerProfileViewConstraints;
813
1044
  /** Position in the leaderboard to start this listing (defaults to the first entry). */
814
1045
  StartPosition: number;
815
1046
  /** Statistic used to rank players for this leaderboard. */
816
1047
  StatisticName: string;
1048
+ /** If set to false, Version is considered null. If true, uses the specified Version */
1049
+ UseSpecificVersion?: boolean;
817
1050
  /** The version of the leaderboard to get. */
818
1051
  Version?: number;
819
1052
  }
@@ -830,7 +1063,7 @@ interface GetPaymentTokenRequest extends IPlayFabRequestCommon {
830
1063
  TokenProvider: string;
831
1064
  }
832
1065
  interface GetPaymentTokenResult extends IPlayFabResultCommon {
833
- /** PlayFab's purchase order identifier. */
1066
+ /** PlayFab&#39;s purchase order identifier. */
834
1067
  OrderId?: string;
835
1068
  /** The token from provider. */
836
1069
  ProviderToken?: string;
@@ -862,19 +1095,19 @@ interface GetPlayerCombinedInfoRequestParams {
862
1095
  GetPlayerStatistics: boolean;
863
1096
  /** Whether to get title data. Defaults to false. */
864
1097
  GetTitleData: boolean;
865
- /** Whether to get the player's account Info. Defaults to false */
1098
+ /** Whether to get the player&#39;s account Info. Defaults to false */
866
1099
  GetUserAccountInfo: boolean;
867
- /** Whether to get the player's custom data. Defaults to false */
1100
+ /** Whether to get the player&#39;s custom data. Defaults to false */
868
1101
  GetUserData: boolean;
869
- /** Whether to get the player's inventory. Defaults to false */
1102
+ /** Whether to get the player&#39;s inventory. Defaults to false */
870
1103
  GetUserInventory: boolean;
871
- /** Whether to get the player's read only data. Defaults to false */
1104
+ /** Whether to get the player&#39;s read only data. Defaults to false */
872
1105
  GetUserReadOnlyData: boolean;
873
- /** Whether to get the player's virtual currency balances. Defaults to false */
1106
+ /** Whether to get the player&#39;s virtual currency balances. Defaults to false */
874
1107
  GetUserVirtualCurrency: boolean;
875
1108
  /** Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false */
876
1109
  PlayerStatisticNames?: string[];
877
- /** Specifies the properties to return from the player profile. Defaults to returning the player's display name. */
1110
+ /** Specifies the properties to return from the player profile. Defaults to returning the player&#39;s display name. */
878
1111
  ProfileConstraints?: PlayerProfileViewConstraints;
879
1112
  /** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false */
880
1113
  TitleDataKeys?: string[];
@@ -912,7 +1145,7 @@ interface GetPlayerCombinedInfoResultPayload {
912
1145
  UserData?: Record<string, UserDataRecord>;
913
1146
  /** The version of the UserData that was returned. */
914
1147
  UserDataVersion: number;
915
- /** Array of inventory items in the user's current inventory. */
1148
+ /** Array of inventory items in the user&#39;s current inventory. */
916
1149
  UserInventory?: ItemInstance[];
917
1150
  /** User specific read-only data. */
918
1151
  UserReadOnlyData?: Record<string, UserDataRecord>;
@@ -924,12 +1157,12 @@ interface GetPlayerCombinedInfoResultPayload {
924
1157
  UserVirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
925
1158
  }
926
1159
  interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
927
- /** Specific property name to search for in the player's properties. */
1160
+ /** Specific property name to search for in the player&#39;s properties. */
928
1161
  PropertyName: string;
929
1162
  }
930
1163
  interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
931
1164
  /**
932
- * Indicates the current version of a player's properties that have been set. This is incremented after updates and
1165
+ * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
933
1166
  * deletes. This version can be provided in update and delete calls for concurrency control.
934
1167
  */
935
1168
  PropertiesVersion: number;
@@ -944,7 +1177,7 @@ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
944
1177
  /**
945
1178
  * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
946
1179
  * 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.
1180
+ * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
948
1181
  */
949
1182
  ProfileConstraints?: PlayerProfileViewConstraints;
950
1183
  }
@@ -997,7 +1230,7 @@ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
997
1230
  interface GetPlayerTagsResult extends IPlayFabResultCommon {
998
1231
  /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
999
1232
  PlayFabId: string;
1000
- /** Canonical tags (including namespace and tag's name) for the requested user */
1233
+ /** Canonical tags (including namespace and tag&#39;s name) for the requested user */
1001
1234
  Tags: string[];
1002
1235
  }
1003
1236
  interface GetPlayerTradesRequest extends IPlayFabRequestCommon {
@@ -1089,7 +1322,7 @@ interface GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult extends IPlayFabResult
1089
1322
  }
1090
1323
  interface GetPlayFabIDsFromKongregateIDsRequest extends IPlayFabRequestCommon {
1091
1324
  /**
1092
- * Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The
1325
+ * Array of unique Kongregate identifiers (Kongregate&#39;s user_id) for which the title needs to get PlayFab identifiers. The
1093
1326
  * array cannot exceed 2,000 in length.
1094
1327
  */
1095
1328
  KongregateIDs: string[];
@@ -1147,6 +1380,11 @@ interface GetPlayFabIDsFromPSNOnlineIDsResult extends IPlayFabResultCommon {
1147
1380
  Data?: PSNOnlinePlayFabIdPair[];
1148
1381
  }
1149
1382
  interface GetPlayFabIDsFromSteamIDsRequest extends IPlayFabRequestCommon {
1383
+ /**
1384
+ * Deprecated: Please use SteamStringIDs
1385
+ * @deprecated Please use SteamStringIDs instead.
1386
+ */
1387
+ SteamIDs?: number[];
1150
1388
  /**
1151
1389
  * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array
1152
1390
  * cannot exceed 2,000 in length.
@@ -1170,7 +1408,7 @@ interface GetPlayFabIDsFromSteamNamesResult extends IPlayFabResultCommon {
1170
1408
  }
1171
1409
  interface GetPlayFabIDsFromTwitchIDsRequest extends IPlayFabRequestCommon {
1172
1410
  /**
1173
- * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot
1411
+ * Array of unique Twitch identifiers (Twitch&#39;s _id) for which the title needs to get PlayFab identifiers. The array cannot
1174
1412
  * exceed 2,000 in length.
1175
1413
  */
1176
1414
  TwitchIds: string[];
@@ -1205,6 +1443,11 @@ interface GetPurchaseRequest extends IPlayFabRequestCommon {
1205
1443
  OrderId: string;
1206
1444
  }
1207
1445
  interface GetPurchaseResult extends IPlayFabResultCommon {
1446
+ /**
1447
+ * Array of items purchased.
1448
+ * @deprecated Please use instead.
1449
+ */
1450
+ Items?: ItemInstance[];
1208
1451
  /** Purchase order identifier. */
1209
1452
  OrderId?: string;
1210
1453
  /** Payment provider used for transaction (If not VC) */
@@ -1288,7 +1531,7 @@ interface GetTitleNewsResult extends IPlayFabResultCommon {
1288
1531
  }
1289
1532
  interface GetTitlePublicKeyRequest extends IPlayFabRequestCommon {
1290
1533
  /**
1291
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
1534
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1292
1535
  * title has been selected.
1293
1536
  */
1294
1537
  TitleId: string;
@@ -1296,7 +1539,7 @@ interface GetTitlePublicKeyRequest extends IPlayFabRequestCommon {
1296
1539
  TitleSharedSecret: string;
1297
1540
  }
1298
1541
  interface GetTitlePublicKeyResult extends IPlayFabResultCommon {
1299
- /** Base64 encoded RSA CSP byte array blob containing the title's public RSA key */
1542
+ /** Base64 encoded RSA CSP byte array blob containing the title&#39;s public RSA key */
1300
1543
  RSAPublicKey?: string;
1301
1544
  }
1302
1545
  interface GetTradeStatusRequest extends IPlayFabRequestCommon {
@@ -1309,6 +1552,69 @@ interface GetTradeStatusResponse extends IPlayFabResultCommon {
1309
1552
  /** Information about the requested trade. */
1310
1553
  Trade?: TradeInfo;
1311
1554
  }
1555
+ /** @deprecated Do not use */
1556
+ interface GetUserCombinedInfoRequest extends IPlayFabRequestCommon {
1557
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1558
+ CustomTags?: Record<string, string | null>;
1559
+ /** User email address for the account to find (if no Username is specified). */
1560
+ Email?: string;
1561
+ /** If set to false, account info will not be returned. Defaults to true. */
1562
+ GetAccountInfo?: boolean;
1563
+ /**
1564
+ * If set to false, inventory will not be returned. Defaults to true. Inventory will never be returned for users other than
1565
+ * yourself.
1566
+ */
1567
+ GetInventory?: boolean;
1568
+ /** If set to false, read-only user data will not be returned. Defaults to true. */
1569
+ GetReadOnlyData?: boolean;
1570
+ /** If set to false, custom user data will not be returned. Defaults to true. */
1571
+ GetUserData?: boolean;
1572
+ /**
1573
+ * If set to false, virtual currency balances will not be returned. Defaults to true. Currency balances will never be
1574
+ * returned for users other than yourself.
1575
+ */
1576
+ GetVirtualCurrency?: boolean;
1577
+ /**
1578
+ * Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no
1579
+ * other lookup identifier set.
1580
+ */
1581
+ PlayFabId?: string;
1582
+ /**
1583
+ * User read-only custom data keys to return. If set to null, all keys will be returned. For users other than yourself,
1584
+ * only public data will be returned.
1585
+ */
1586
+ ReadOnlyDataKeys?: string[];
1587
+ /** Title-specific username for the account to find (if no Email is set). */
1588
+ TitleDisplayName?: string;
1589
+ /**
1590
+ * User custom data keys to return. If set to null, all keys will be returned. For users other than yourself, only public
1591
+ * data will be returned.
1592
+ */
1593
+ UserDataKeys?: string[];
1594
+ /** PlayFab Username for the account to find (if no PlayFabId is specified). */
1595
+ Username?: string;
1596
+ }
1597
+ /** @deprecated Do not use */
1598
+ interface GetUserCombinedInfoResult extends IPlayFabResultCommon {
1599
+ /** Account information for the user. */
1600
+ AccountInfo?: UserAccountInfo;
1601
+ /** User specific custom data. */
1602
+ Data?: Record<string, UserDataRecord>;
1603
+ /** The version of the UserData that was returned. */
1604
+ DataVersion: number;
1605
+ /** Array of inventory items in the user&#39;s current inventory. */
1606
+ Inventory?: ItemInstance[];
1607
+ /** Unique PlayFab identifier of the owner of the combined info. */
1608
+ PlayFabId?: string;
1609
+ /** User specific read-only data. */
1610
+ ReadOnlyData?: Record<string, UserDataRecord>;
1611
+ /** The version of the Read-Only UserData that was returned. */
1612
+ ReadOnlyDataVersion: number;
1613
+ /** Array of virtual currency balance(s) belonging to the user. */
1614
+ VirtualCurrency?: Record<string, number>;
1615
+ /** Array of remaining times and timestamps for virtual currencies. */
1616
+ VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
1617
+ }
1312
1618
  interface GetUserDataRequest extends IPlayFabRequestCommon {
1313
1619
  /**
1314
1620
  * The version that currently exists according to the caller. The call will return the data for all of the keys if the
@@ -1344,6 +1650,16 @@ interface GetUserInventoryResult extends IPlayFabResultCommon {
1344
1650
  /** Array of remaining times and timestamps for virtual currencies. */
1345
1651
  VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
1346
1652
  }
1653
+ /** @deprecated Do not use */
1654
+ interface GetUserStatisticsRequest extends IPlayFabRequestCommon {
1655
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1656
+ CustomTags?: Record<string, string | null>;
1657
+ }
1658
+ /** @deprecated Do not use */
1659
+ interface GetUserStatisticsResult extends IPlayFabResultCommon {
1660
+ /** User statistics for the active title. */
1661
+ UserStatistics?: Record<string, number>;
1662
+ }
1347
1663
  interface GooglePlayFabIdPair {
1348
1664
  /** Unique Google identifier for a user. */
1349
1665
  GoogleId?: string;
@@ -1364,7 +1680,7 @@ interface GrantCharacterToUserRequest extends IPlayFabRequestCommon {
1364
1680
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1365
1681
  CustomTags?: Record<string, string | null>;
1366
1682
  /**
1367
- * Catalog item identifier of the item in the user's inventory that corresponds to the character in the catalog to be
1683
+ * Catalog item identifier of the item in the user&#39;s inventory that corresponds to the character in the catalog to be
1368
1684
  * created.
1369
1685
  */
1370
1686
  ItemId: string;
@@ -1391,7 +1707,7 @@ interface ItemInstance {
1391
1707
  CatalogVersion?: string;
1392
1708
  /**
1393
1709
  * 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.
1710
+ * item&#39;s custom data.
1395
1711
  */
1396
1712
  CustomData?: Record<string, string | null>;
1397
1713
  /** CatalogItem.DisplayName at the time this item was purchased. */
@@ -1422,7 +1738,7 @@ interface ItemPurchaseRequest {
1422
1738
  ItemId: string;
1423
1739
  /** How many of this item to purchase. Min 1, maximum 25. */
1424
1740
  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). */
1741
+ /** Items to be upgraded as a result of this purchase (upgraded items are hidden, as they are &quot;replaced&quot; by the new items). */
1426
1742
  UpgradeFromItems?: string[];
1427
1743
  }
1428
1744
  interface KongregatePlayFabIdPair {
@@ -1432,15 +1748,15 @@ interface KongregatePlayFabIdPair {
1432
1748
  PlayFabId?: string;
1433
1749
  }
1434
1750
  interface LinkAndroidDeviceIDRequest extends IPlayFabRequestCommon {
1435
- /** Specific model of the user's device. */
1751
+ /** Specific model of the user&#39;s device. */
1436
1752
  AndroidDevice?: string;
1437
- /** Android device identifier for the user's device. */
1753
+ /** Android device identifier for the user&#39;s device. */
1438
1754
  AndroidDeviceId: string;
1439
1755
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1440
1756
  CustomTags?: Record<string, string | null>;
1441
1757
  /** If another user is already linked to the device, unlink the other user and re-link. */
1442
1758
  ForceLink?: boolean;
1443
- /** Specific Operating System version for the user's device. */
1759
+ /** Specific Operating System version for the user&#39;s device. */
1444
1760
  OS?: string;
1445
1761
  }
1446
1762
  interface LinkAndroidDeviceIDResult extends IPlayFabResultCommon {
@@ -1486,7 +1802,9 @@ interface LinkedPlatformAccountModel {
1486
1802
  }
1487
1803
  interface LinkFacebookAccountRequest extends IPlayFabRequestCommon {
1488
1804
  /** Unique identifier from Facebook for the user. */
1489
- AccessToken: string;
1805
+ AccessToken?: string;
1806
+ /** Token used for limited login authentication. */
1807
+ AuthenticationToken?: string;
1490
1808
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1491
1809
  CustomTags?: Record<string, string | null>;
1492
1810
  /** If another user is already linked to the account, unlink the other user and re-link. */
@@ -1522,13 +1840,18 @@ interface LinkGameCenterAccountRequest extends IPlayFabRequestCommon {
1522
1840
  Signature?: string;
1523
1841
  /**
1524
1842
  * 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.
1843
+ * signatures not within 10 minutes of the server&#39;s current time.
1526
1844
  */
1527
1845
  Timestamp?: string;
1528
1846
  }
1529
1847
  interface LinkGameCenterAccountResult extends IPlayFabResultCommon {
1530
1848
  }
1531
1849
  interface LinkGoogleAccountRequest extends IPlayFabRequestCommon {
1850
+ /**
1851
+ * OAuth 2.0 access token obtained on the client by calling the getAccessToken() Google client API.
1852
+ * @deprecated Please use ServerAuthCode instead.
1853
+ */
1854
+ AccessToken?: string;
1532
1855
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1533
1856
  CustomTags?: Record<string, string | null>;
1534
1857
  /**
@@ -1563,13 +1886,13 @@ interface LinkGooglePlayGamesServicesAccountResult extends IPlayFabResultCommon
1563
1886
  interface LinkIOSDeviceIDRequest extends IPlayFabRequestCommon {
1564
1887
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1565
1888
  CustomTags?: Record<string, string | null>;
1566
- /** Vendor-specific iOS identifier for the user's device. */
1889
+ /** Vendor-specific iOS identifier for the user&#39;s device. */
1567
1890
  DeviceId: string;
1568
- /** Specific model of the user's device. */
1891
+ /** Specific model of the user&#39;s device. */
1569
1892
  DeviceModel?: string;
1570
1893
  /** If another user is already linked to the device, unlink the other user and re-link. */
1571
1894
  ForceLink?: boolean;
1572
- /** Specific Operating System version for the user's device. */
1895
+ /** Specific Operating System version for the user&#39;s device. */
1573
1896
  OS?: string;
1574
1897
  }
1575
1898
  interface LinkIOSDeviceIDResult extends IPlayFabResultCommon {
@@ -1602,7 +1925,7 @@ interface LinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
1602
1925
  CustomTags?: Record<string, string | null>;
1603
1926
  /** If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link. */
1604
1927
  ForceLink?: boolean;
1605
- /** Nintendo Switch unique identifier for the user's device. */
1928
+ /** Nintendo Switch unique identifier for the user&#39;s device. */
1606
1929
  NintendoSwitchDeviceId: string;
1607
1930
  }
1608
1931
  interface LinkNintendoSwitchDeviceIdResult extends IPlayFabResultCommon {
@@ -1616,7 +1939,7 @@ interface LinkOpenIdConnectRequest extends IPlayFabRequestCommon {
1616
1939
  ForceLink?: boolean;
1617
1940
  /**
1618
1941
  * 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.
1942
+ * identity provider&#39;s response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.
1620
1943
  */
1621
1944
  IdToken: string;
1622
1945
  }
@@ -1641,11 +1964,11 @@ interface LinkSteamAccountRequest extends IPlayFabRequestCommon {
1641
1964
  ForceLink?: boolean;
1642
1965
  /**
1643
1966
  * 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").
1967
+ * 0x08 should become &quot;08&quot;).
1645
1968
  */
1646
1969
  SteamTicket: string;
1647
1970
  /**
1648
- * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string.
1971
+ * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using &quot;AzurePlayFab&quot; as the identity string.
1649
1972
  * False if the ticket was generated with ISteamUser::GetAuthSessionTicket().
1650
1973
  */
1651
1974
  TicketIsServiceSpecific?: boolean;
@@ -1667,7 +1990,7 @@ interface LinkXboxAccountRequest extends IPlayFabRequestCommon {
1667
1990
  CustomTags?: Record<string, string | null>;
1668
1991
  /** If another user is already linked to the account, unlink the other user and re-link. */
1669
1992
  ForceLink?: boolean;
1670
- /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
1993
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). */
1671
1994
  XboxToken: string;
1672
1995
  }
1673
1996
  interface LinkXboxAccountResult extends IPlayFabResultCommon {
@@ -1678,7 +2001,7 @@ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
1678
2001
  /** Player specific properties and their corresponding values for this title. */
1679
2002
  Properties?: CustomPropertyDetails[];
1680
2003
  /**
1681
- * Indicates the current version of a player's properties that have been set. This is incremented after updates and
2004
+ * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
1682
2005
  * deletes. This version can be provided in update and delete calls for concurrency control.
1683
2006
  */
1684
2007
  PropertiesVersion: number;
@@ -1703,6 +2026,30 @@ interface LocationModel {
1703
2026
  /** Longitude coordinate of the geographic location. */
1704
2027
  Longitude?: number;
1705
2028
  }
2029
+ /** @deprecated Do not use */
2030
+ interface LogEventRequest extends IPlayFabRequestCommon {
2031
+ /**
2032
+ * Contains all the data for this event. Event Values can be strings, booleans or numerics (float, double, integer, long)
2033
+ * and must be consistent on a per-event basis (if the Value for Key &#39;A&#39; in Event &#39;Foo&#39; is an integer the first time it is
2034
+ * sent, it must be an integer in all subsequent &#39;Foo&#39; events). As with event names, Keys must also not use reserved words
2035
+ * (see above). Finally, the size of the Body for an event must be less than 32KB (UTF-8 format).
2036
+ */
2037
+ Body?: Record<string, any>;
2038
+ /**
2039
+ * A unique event name which will be used as the table name in the Redshift database. The name will be made lower case, and
2040
+ * cannot not contain spaces. The use of underscores is recommended, for readability. Events also cannot match reserved
2041
+ * terms. The PlayFab reserved terms are &#39;log_in&#39; and &#39;purchase&#39;, &#39;create&#39; and &#39;request&#39;, while the Redshift reserved terms
2042
+ * can be found here: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html.
2043
+ */
2044
+ EventName?: string;
2045
+ /** Flag to set event Body as profile details in the Redshift database as well as a standard event. */
2046
+ ProfileSetEvent: boolean;
2047
+ /** Optional timestamp for this event. If null, the a timestamp is auto-assigned to the event on the server. */
2048
+ Timestamp?: string;
2049
+ }
2050
+ /** @deprecated Do not use */
2051
+ interface LogEventResult extends IPlayFabResultCommon {
2052
+ }
1706
2053
  interface LoginResult extends IPlayFabResultCommon {
1707
2054
  /**
1708
2055
  * If LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and
@@ -1711,11 +2058,11 @@ interface LoginResult extends IPlayFabResultCommon {
1711
2058
  EntityToken?: EntityTokenResponse;
1712
2059
  /** Results for requested info. */
1713
2060
  InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
1714
- /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */
2061
+ /** The time of this user&#39;s previous login. If there was no previous login, then it&#39;s DateTime.MinValue */
1715
2062
  LastLoginTime?: string;
1716
2063
  /** True if the master_player_account was newly created on this login. */
1717
2064
  NewlyCreated: boolean;
1718
- /** Player's unique PlayFabId. */
2065
+ /** Player&#39;s unique PlayFabId. */
1719
2066
  PlayFabId?: string;
1720
2067
  /** Unique token authorizing the user and game at the server level, for the current session. */
1721
2068
  SessionTicket?: string;
@@ -1725,24 +2072,29 @@ interface LoginResult extends IPlayFabResultCommon {
1725
2072
  TreatmentAssignment?: TreatmentAssignment;
1726
2073
  }
1727
2074
  interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
1728
- /** Specific model of the user's device. */
2075
+ /** Specific model of the user&#39;s device. */
1729
2076
  AndroidDevice?: string;
1730
- /** Android device identifier for the user's device. */
2077
+ /** Android device identifier for the user&#39;s device. */
1731
2078
  AndroidDeviceId?: string;
1732
2079
  /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1733
2080
  CreateAccount?: boolean;
1734
2081
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1735
2082
  CustomTags?: Record<string, string | null>;
1736
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2083
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1737
2084
  EncryptedRequest?: string;
1738
2085
  /** Flags for which pieces of info to return for the user. */
1739
2086
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1740
- /** Specific Operating System version for the user's device. */
2087
+ /**
2088
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2089
+ * @deprecated Do not use
2090
+ */
2091
+ LoginTitlePlayerAccountEntity?: boolean;
2092
+ /** Specific Operating System version for the user&#39;s device. */
1741
2093
  OS?: string;
1742
2094
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1743
2095
  PlayerSecret?: string;
1744
2096
  /**
1745
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2097
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1746
2098
  * title has been selected.
1747
2099
  */
1748
2100
  TitleId?: string;
@@ -1752,7 +2104,7 @@ interface LoginWithAppleRequest extends IPlayFabRequestCommon {
1752
2104
  CreateAccount?: boolean;
1753
2105
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1754
2106
  CustomTags?: Record<string, string | null>;
1755
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2107
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1756
2108
  EncryptedRequest?: string;
1757
2109
  /**
1758
2110
  * The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization
@@ -1762,10 +2114,15 @@ interface LoginWithAppleRequest extends IPlayFabRequestCommon {
1762
2114
  IdentityToken: string;
1763
2115
  /** Flags for which pieces of info to return for the user. */
1764
2116
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2117
+ /**
2118
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2119
+ * @deprecated Do not use
2120
+ */
2121
+ LoginTitlePlayerAccountEntity?: boolean;
1765
2122
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1766
2123
  PlayerSecret?: string;
1767
2124
  /**
1768
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2125
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1769
2126
  * title has been selected.
1770
2127
  */
1771
2128
  TitleId?: string;
@@ -1775,16 +2132,21 @@ interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
1775
2132
  CreateAccount?: boolean;
1776
2133
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1777
2134
  CustomTags?: Record<string, string | null>;
1778
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2135
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1779
2136
  EncryptedRequest?: string;
1780
2137
  /** The JSON Web Token (JWT) returned by Battle.net after login */
1781
2138
  IdentityToken: string;
1782
2139
  /** Flags for which pieces of info to return for the user. */
1783
2140
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2141
+ /**
2142
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2143
+ * @deprecated Do not use
2144
+ */
2145
+ LoginTitlePlayerAccountEntity?: boolean;
1784
2146
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1785
2147
  PlayerSecret?: string;
1786
2148
  /**
1787
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2149
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1788
2150
  * title has been selected.
1789
2151
  */
1790
2152
  TitleId?: string;
@@ -1796,14 +2158,19 @@ interface LoginWithCustomIDRequest extends IPlayFabRequestCommon {
1796
2158
  CustomId?: string;
1797
2159
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1798
2160
  CustomTags?: Record<string, string | null>;
1799
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2161
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1800
2162
  EncryptedRequest?: string;
1801
2163
  /** Flags for which pieces of info to return for the user. */
1802
2164
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2165
+ /**
2166
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2167
+ * @deprecated Do not use
2168
+ */
2169
+ LoginTitlePlayerAccountEntity?: boolean;
1803
2170
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1804
2171
  PlayerSecret?: string;
1805
2172
  /**
1806
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2173
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1807
2174
  * title has been selected.
1808
2175
  */
1809
2176
  TitleId?: string;
@@ -1815,10 +2182,15 @@ interface LoginWithEmailAddressRequest extends IPlayFabRequestCommon {
1815
2182
  Email: string;
1816
2183
  /** Flags for which pieces of info to return for the user. */
1817
2184
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2185
+ /**
2186
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2187
+ * @deprecated Do not use
2188
+ */
2189
+ LoginTitlePlayerAccountEntity?: boolean;
1818
2190
  /** Password for the PlayFab account (6-100 characters) */
1819
2191
  Password: string;
1820
2192
  /**
1821
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2193
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1822
2194
  * title has been selected.
1823
2195
  */
1824
2196
  TitleId?: string;
@@ -1828,16 +2200,21 @@ interface LoginWithFacebookInstantGamesIdRequest extends IPlayFabRequestCommon {
1828
2200
  CreateAccount?: boolean;
1829
2201
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1830
2202
  CustomTags?: Record<string, string | null>;
1831
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2203
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1832
2204
  EncryptedRequest?: string;
1833
2205
  /** Facebook Instant Games signature for the user. */
1834
2206
  FacebookInstantGamesSignature: string;
1835
2207
  /** Flags for which pieces of info to return for the user. */
1836
2208
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2209
+ /**
2210
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2211
+ * @deprecated Do not use
2212
+ */
2213
+ LoginTitlePlayerAccountEntity?: boolean;
1837
2214
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1838
2215
  PlayerSecret?: string;
1839
2216
  /**
1840
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2217
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1841
2218
  * title has been selected.
1842
2219
  */
1843
2220
  TitleId?: string;
@@ -1851,14 +2228,19 @@ interface LoginWithFacebookRequest extends IPlayFabRequestCommon {
1851
2228
  CreateAccount?: boolean;
1852
2229
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1853
2230
  CustomTags?: Record<string, string | null>;
1854
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2231
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1855
2232
  EncryptedRequest?: string;
1856
2233
  /** Flags for which pieces of info to return for the user. */
1857
2234
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2235
+ /**
2236
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2237
+ * @deprecated Do not use
2238
+ */
2239
+ LoginTitlePlayerAccountEntity?: boolean;
1858
2240
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1859
2241
  PlayerSecret?: string;
1860
2242
  /**
1861
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2243
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1862
2244
  * title has been selected.
1863
2245
  */
1864
2246
  TitleId?: string;
@@ -1868,10 +2250,15 @@ interface LoginWithGameCenterRequest extends IPlayFabRequestCommon {
1868
2250
  CreateAccount?: boolean;
1869
2251
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1870
2252
  CustomTags?: Record<string, string | null>;
1871
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2253
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1872
2254
  EncryptedRequest?: string;
1873
2255
  /** Flags for which pieces of info to return for the user. */
1874
2256
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2257
+ /**
2258
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2259
+ * @deprecated Do not use
2260
+ */
2261
+ LoginTitlePlayerAccountEntity?: boolean;
1875
2262
  /** Unique Game Center player id. */
1876
2263
  PlayerId?: string;
1877
2264
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
@@ -1884,26 +2271,41 @@ interface LoginWithGameCenterRequest extends IPlayFabRequestCommon {
1884
2271
  Signature?: string;
1885
2272
  /**
1886
2273
  * 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.
2274
+ * signatures not within 10 minutes of the server&#39;s current time.
1888
2275
  */
1889
2276
  Timestamp?: string;
1890
2277
  /**
1891
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2278
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1892
2279
  * title has been selected.
1893
2280
  */
1894
2281
  TitleId?: string;
1895
2282
  }
1896
2283
  interface LoginWithGoogleAccountRequest extends IPlayFabRequestCommon {
2284
+ /**
2285
+ * OAuth 2.0 access token obtained on the client by calling the getAccessToken() Google client API.
2286
+ * @deprecated Please use ServerAuthCode instead.
2287
+ */
2288
+ AccessToken?: string;
1897
2289
  /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1898
2290
  CreateAccount?: boolean;
1899
2291
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1900
2292
  CustomTags?: Record<string, string | null>;
1901
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2293
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1902
2294
  EncryptedRequest?: string;
1903
2295
  /** Flags for which pieces of info to return for the user. */
1904
2296
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2297
+ /**
2298
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2299
+ * @deprecated Do not use
2300
+ */
2301
+ LoginTitlePlayerAccountEntity?: boolean;
1905
2302
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1906
2303
  PlayerSecret?: string;
2304
+ /**
2305
+ * Deprecated - Do not use
2306
+ * @deprecated Do not use
2307
+ */
2308
+ PublisherId?: string;
1907
2309
  /**
1908
2310
  * OAuth 2.0 server authentication code obtained on the client by calling the getServerAuthCode()
1909
2311
  * (https://developers.google.com/identity/sign-in/android/offline-access) Google client API.
@@ -1912,7 +2314,7 @@ interface LoginWithGoogleAccountRequest extends IPlayFabRequestCommon {
1912
2314
  /** Optional boolean to opt out of setting the MPA email when creating a Google account, defaults to true. */
1913
2315
  SetEmail?: boolean;
1914
2316
  /**
1915
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2317
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1916
2318
  * title has been selected.
1917
2319
  */
1918
2320
  TitleId?: string;
@@ -1922,10 +2324,15 @@ interface LoginWithGooglePlayGamesServicesRequest extends IPlayFabRequestCommon
1922
2324
  CreateAccount?: boolean;
1923
2325
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1924
2326
  CustomTags?: Record<string, string | null>;
1925
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2327
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1926
2328
  EncryptedRequest?: string;
1927
2329
  /** Flags for which pieces of info to return for the user. */
1928
2330
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2331
+ /**
2332
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2333
+ * @deprecated Do not use
2334
+ */
2335
+ LoginTitlePlayerAccountEntity?: boolean;
1929
2336
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1930
2337
  PlayerSecret?: string;
1931
2338
  /**
@@ -1934,7 +2341,7 @@ interface LoginWithGooglePlayGamesServicesRequest extends IPlayFabRequestCommon
1934
2341
  */
1935
2342
  ServerAuthCode?: string;
1936
2343
  /**
1937
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2344
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1938
2345
  * title has been selected.
1939
2346
  */
1940
2347
  TitleId?: string;
@@ -1944,41 +2351,51 @@ interface LoginWithIOSDeviceIDRequest extends IPlayFabRequestCommon {
1944
2351
  CreateAccount?: boolean;
1945
2352
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1946
2353
  CustomTags?: Record<string, string | null>;
1947
- /** Vendor-specific iOS identifier for the user's device. */
2354
+ /** Vendor-specific iOS identifier for the user&#39;s device. */
1948
2355
  DeviceId?: string;
1949
- /** Specific model of the user's device. */
2356
+ /** Specific model of the user&#39;s device. */
1950
2357
  DeviceModel?: string;
1951
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2358
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1952
2359
  EncryptedRequest?: string;
1953
2360
  /** Flags for which pieces of info to return for the user. */
1954
2361
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1955
- /** Specific Operating System version for the user's device. */
2362
+ /**
2363
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2364
+ * @deprecated Do not use
2365
+ */
2366
+ LoginTitlePlayerAccountEntity?: boolean;
2367
+ /** Specific Operating System version for the user&#39;s device. */
1956
2368
  OS?: string;
1957
2369
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1958
2370
  PlayerSecret?: string;
1959
2371
  /**
1960
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2372
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1961
2373
  * title has been selected.
1962
2374
  */
1963
2375
  TitleId?: string;
1964
2376
  }
1965
2377
  interface LoginWithKongregateRequest extends IPlayFabRequestCommon {
1966
- /** Token issued by Kongregate's client API for the user. */
2378
+ /** Token issued by Kongregate&#39;s client API for the user. */
1967
2379
  AuthTicket?: string;
1968
2380
  /** Automatically create a PlayFab account if one is not currently linked to this ID. */
1969
2381
  CreateAccount?: boolean;
1970
2382
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1971
2383
  CustomTags?: Record<string, string | null>;
1972
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2384
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1973
2385
  EncryptedRequest?: string;
1974
2386
  /** Flags for which pieces of info to return for the user. */
1975
2387
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
1976
2388
  /** Numeric user ID assigned by Kongregate */
1977
2389
  KongregateId?: string;
2390
+ /**
2391
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2392
+ * @deprecated Do not use
2393
+ */
2394
+ LoginTitlePlayerAccountEntity?: boolean;
1978
2395
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1979
2396
  PlayerSecret?: string;
1980
2397
  /**
1981
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2398
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
1982
2399
  * title has been selected.
1983
2400
  */
1984
2401
  TitleId?: string;
@@ -1988,16 +2405,21 @@ interface LoginWithNintendoServiceAccountRequest extends IPlayFabRequestCommon {
1988
2405
  CreateAccount?: boolean;
1989
2406
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
1990
2407
  CustomTags?: Record<string, string | null>;
1991
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2408
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
1992
2409
  EncryptedRequest?: string;
1993
2410
  /** The JSON Web token (JWT) returned by Nintendo after login. */
1994
2411
  IdentityToken: string;
1995
2412
  /** Flags for which pieces of info to return for the user. */
1996
2413
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2414
+ /**
2415
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2416
+ * @deprecated Do not use
2417
+ */
2418
+ LoginTitlePlayerAccountEntity?: boolean;
1997
2419
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
1998
2420
  PlayerSecret?: string;
1999
2421
  /**
2000
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2422
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2001
2423
  * title has been selected.
2002
2424
  */
2003
2425
  TitleId?: string;
@@ -2007,16 +2429,21 @@ interface LoginWithNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
2007
2429
  CreateAccount?: boolean;
2008
2430
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2009
2431
  CustomTags?: Record<string, string | null>;
2010
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2432
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2011
2433
  EncryptedRequest?: string;
2012
2434
  /** Flags for which pieces of info to return for the user. */
2013
2435
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2014
- /** Nintendo Switch unique identifier for the user's device. */
2436
+ /**
2437
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2438
+ * @deprecated Do not use
2439
+ */
2440
+ LoginTitlePlayerAccountEntity?: boolean;
2441
+ /** Nintendo Switch unique identifier for the user&#39;s device. */
2015
2442
  NintendoSwitchDeviceId?: string;
2016
2443
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2017
2444
  PlayerSecret?: string;
2018
2445
  /**
2019
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2446
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2020
2447
  * title has been selected.
2021
2448
  */
2022
2449
  TitleId?: string;
@@ -2028,19 +2455,24 @@ interface LoginWithOpenIdConnectRequest extends IPlayFabRequestCommon {
2028
2455
  CreateAccount?: boolean;
2029
2456
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2030
2457
  CustomTags?: Record<string, string | null>;
2031
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2458
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2032
2459
  EncryptedRequest?: string;
2033
2460
  /**
2034
2461
  * 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.
2462
+ * identity provider&#39;s response.
2036
2463
  */
2037
2464
  IdToken: string;
2038
2465
  /** Flags for which pieces of info to return for the user. */
2039
2466
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2467
+ /**
2468
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2469
+ * @deprecated Do not use
2470
+ */
2471
+ LoginTitlePlayerAccountEntity?: boolean;
2040
2472
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2041
2473
  PlayerSecret?: string;
2042
2474
  /**
2043
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2475
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2044
2476
  * title has been selected.
2045
2477
  */
2046
2478
  TitleId?: string;
@@ -2050,10 +2482,15 @@ interface LoginWithPlayFabRequest extends IPlayFabRequestCommon {
2050
2482
  CustomTags?: Record<string, string | null>;
2051
2483
  /** Flags for which pieces of info to return for the user. */
2052
2484
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2485
+ /**
2486
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2487
+ * @deprecated Do not use
2488
+ */
2489
+ LoginTitlePlayerAccountEntity?: boolean;
2053
2490
  /** Password for the PlayFab account (6-100 characters) */
2054
2491
  Password: string;
2055
2492
  /**
2056
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2493
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2057
2494
  * title has been selected.
2058
2495
  */
2059
2496
  TitleId?: string;
@@ -2067,18 +2504,23 @@ interface LoginWithPSNRequest extends IPlayFabRequestCommon {
2067
2504
  CreateAccount?: boolean;
2068
2505
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2069
2506
  CustomTags?: Record<string, string | null>;
2070
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2507
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2071
2508
  EncryptedRequest?: string;
2072
2509
  /** Flags for which pieces of info to return for the user. */
2073
2510
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2074
2511
  /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
2075
2512
  IssuerId?: number;
2513
+ /**
2514
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2515
+ * @deprecated Do not use
2516
+ */
2517
+ LoginTitlePlayerAccountEntity?: boolean;
2076
2518
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2077
2519
  PlayerSecret?: string;
2078
2520
  /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
2079
2521
  RedirectUri?: string;
2080
2522
  /**
2081
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2523
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2082
2524
  * title has been selected.
2083
2525
  */
2084
2526
  TitleId?: string;
@@ -2088,43 +2530,53 @@ interface LoginWithSteamRequest extends IPlayFabRequestCommon {
2088
2530
  CreateAccount?: boolean;
2089
2531
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2090
2532
  CustomTags?: Record<string, string | null>;
2091
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2533
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2092
2534
  EncryptedRequest?: string;
2093
2535
  /** Flags for which pieces of info to return for the user. */
2094
2536
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2537
+ /**
2538
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2539
+ * @deprecated Do not use
2540
+ */
2541
+ LoginTitlePlayerAccountEntity?: boolean;
2095
2542
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2096
2543
  PlayerSecret?: string;
2097
2544
  /**
2098
2545
  * 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").
2546
+ * 0x08 should become &quot;08&quot;).
2100
2547
  */
2101
2548
  SteamTicket?: string;
2102
2549
  /**
2103
- * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string.
2550
+ * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using &quot;AzurePlayFab&quot; as the identity string.
2104
2551
  * False if the ticket was generated with ISteamUser::GetAuthSessionTicket().
2105
2552
  */
2106
2553
  TicketIsServiceSpecific?: boolean;
2107
2554
  /**
2108
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2555
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2109
2556
  * title has been selected.
2110
2557
  */
2111
2558
  TitleId?: string;
2112
2559
  }
2113
2560
  interface LoginWithTwitchRequest extends IPlayFabRequestCommon {
2114
- /** Token issued by Twitch's API for the user. */
2561
+ /** Token issued by Twitch&#39;s API for the user. */
2115
2562
  AccessToken?: string;
2116
2563
  /** Automatically create a PlayFab account if one is not currently linked to this ID. */
2117
2564
  CreateAccount?: boolean;
2118
2565
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2119
2566
  CustomTags?: Record<string, string | null>;
2120
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2567
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2121
2568
  EncryptedRequest?: string;
2122
2569
  /** Flags for which pieces of info to return for the user. */
2123
2570
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2571
+ /**
2572
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2573
+ * @deprecated Do not use
2574
+ */
2575
+ LoginTitlePlayerAccountEntity?: boolean;
2124
2576
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2125
2577
  PlayerSecret?: string;
2126
2578
  /**
2127
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2579
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2128
2580
  * title has been selected.
2129
2581
  */
2130
2582
  TitleId?: string;
@@ -2134,27 +2586,84 @@ interface LoginWithXboxRequest extends IPlayFabRequestCommon {
2134
2586
  CreateAccount?: boolean;
2135
2587
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2136
2588
  CustomTags?: Record<string, string | null>;
2137
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
2589
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2138
2590
  EncryptedRequest?: string;
2139
2591
  /** Flags for which pieces of info to return for the user. */
2140
2592
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
2593
+ /**
2594
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
2595
+ * @deprecated Do not use
2596
+ */
2597
+ LoginTitlePlayerAccountEntity?: boolean;
2141
2598
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2142
2599
  PlayerSecret?: string;
2143
2600
  /**
2144
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
2601
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2145
2602
  * title has been selected.
2146
2603
  */
2147
2604
  TitleId?: string;
2148
- /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
2605
+ /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). */
2149
2606
  XboxToken?: string;
2150
2607
  }
2151
2608
  interface LogStatement {
2152
2609
  /** Optional object accompanying the message as contextual information */
2153
2610
  Data?: any;
2154
- /** 'Debug', 'Info', or 'Error' */
2611
+ /** &#39;Debug&#39;, &#39;Info&#39;, or &#39;Error&#39; */
2155
2612
  Level?: string;
2156
2613
  Message?: string;
2157
2614
  }
2615
+ /** @deprecated Do not use */
2616
+ interface MatchmakeRequest extends IPlayFabRequestCommon {
2617
+ /** Build version to match against. [Note: Required if LobbyId is not specified] */
2618
+ BuildVersion?: string;
2619
+ /** Character to use for stats based matching. Leave null to use account stats. */
2620
+ CharacterId?: string;
2621
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2622
+ CustomTags?: Record<string, string | null>;
2623
+ /**
2624
+ * Deprecated - Do not use
2625
+ * @deprecated Do not use
2626
+ */
2627
+ EnableQueue?: boolean;
2628
+ /** Game mode to match make against. [Note: Required if LobbyId is not specified] */
2629
+ GameMode?: string;
2630
+ /** Lobby identifier to match make against. This is used to select a specific Game Server Instance. */
2631
+ LobbyId?: string;
2632
+ /** Region to match make against. [Note: Required if LobbyId is not specified] */
2633
+ Region?: string;
2634
+ /** Start a game session if one with an open slot is not found. Defaults to true. */
2635
+ StartNewIfNoneFound?: boolean;
2636
+ /** Player statistic to use in finding a match. May be null for no stat-based matching. */
2637
+ StatisticName?: string;
2638
+ /** Filter to include and/or exclude Game Server Instances associated with certain Tags */
2639
+ TagFilter?: CollectionFilter;
2640
+ }
2641
+ /** @deprecated Do not use */
2642
+ interface MatchmakeResult extends IPlayFabResultCommon {
2643
+ /** timestamp for when the server will expire, if applicable */
2644
+ Expires?: string;
2645
+ /** unique lobby identifier of the server matched */
2646
+ LobbyID?: string;
2647
+ /** time in milliseconds the application is configured to wait on matchmaking results */
2648
+ PollWaitTimeMS?: number;
2649
+ /**
2650
+ * IPV4 address of the server
2651
+ * @deprecated Please use ServerIPV4Address instead.
2652
+ */
2653
+ ServerHostname?: string;
2654
+ /** IPV4 address of the server */
2655
+ ServerIPV4Address?: string;
2656
+ /** IPV6 address of the server */
2657
+ ServerIPV6Address?: string;
2658
+ /** port number to use for non-http communications with the server */
2659
+ ServerPort?: number;
2660
+ /** Public DNS name (if any) of the server */
2661
+ ServerPublicDNSName?: string;
2662
+ /** result of match making process */
2663
+ Status?: string;
2664
+ /** server authorization ticket (used by RedeemMatchmakerTicket to validate user insertion into the game) */
2665
+ Ticket?: string;
2666
+ }
2158
2667
  interface MembershipModel {
2159
2668
  /** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
2160
2669
  IsActive: boolean;
@@ -2167,6 +2676,8 @@ interface MembershipModel {
2167
2676
  * overridden, this will be the new expiration time.
2168
2677
  */
2169
2678
  OverrideExpiration?: string;
2679
+ /** Whether the override expiration is set. */
2680
+ OverrideIsSet?: boolean;
2170
2681
  /** The list of subscriptions that this player has for this membership */
2171
2682
  Subscriptions?: SubscriptionModel[];
2172
2683
  }
@@ -2176,7 +2687,7 @@ interface MicrosoftStorePayload {
2176
2687
  /** If collectionsMsIdKey is provided, this will verify the user id in the collectionsMsIdKey is the same. */
2177
2688
  UserId?: string;
2178
2689
  /**
2179
- * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). This is
2690
+ * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). This is
2180
2691
  * optional. Alternatively can use CollectionsMsIdKey
2181
2692
  */
2182
2693
  XboxToken?: string;
@@ -2185,7 +2696,7 @@ interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
2185
2696
  /** Balance of the virtual currency after modification. */
2186
2697
  Balance: number;
2187
2698
  /**
2188
- * Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
2699
+ * Amount added or subtracted from the user&#39;s virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
2189
2700
  * over this value will be discarded.
2190
2701
  */
2191
2702
  BalanceChange: number;
@@ -2279,17 +2790,17 @@ interface PlayerLeaderboardEntry {
2279
2790
  DisplayName?: string;
2280
2791
  /** PlayFab unique identifier of the user for this leaderboard entry. */
2281
2792
  PlayFabId?: string;
2282
- /** User's overall position in the leaderboard. */
2793
+ /** User&#39;s overall position in the leaderboard. */
2283
2794
  Position: number;
2284
2795
  /** The profile of the user, if requested. */
2285
2796
  Profile?: PlayerProfileModel;
2286
- /** Specific value of the user's statistic. */
2797
+ /** Specific value of the user&#39;s statistic. */
2287
2798
  StatValue: number;
2288
2799
  }
2289
2800
  interface PlayerProfileModel {
2290
2801
  /** List of advertising campaigns the player has been attributed to */
2291
2802
  AdCampaignAttributions?: AdCampaignAttributionModel[];
2292
- /** URL of the player's avatar image */
2803
+ /** URL of the player&#39;s avatar image */
2293
2804
  AvatarUrl?: string;
2294
2805
  /** If the player is currently banned, the UTC Date when the ban expires */
2295
2806
  BannedUntil?: string;
@@ -2323,20 +2834,20 @@ interface PlayerProfileModel {
2323
2834
  PushNotificationRegistrations?: PushNotificationRegistrationModel[];
2324
2835
  /** List of leaderboard statistic values for the player */
2325
2836
  Statistics?: StatisticModel[];
2326
- /** List of player's tags for segmentation */
2837
+ /** List of player&#39;s tags for segmentation */
2327
2838
  Tags?: TagModel[];
2328
2839
  /** Title ID this player profile applies to */
2329
2840
  TitleId?: string;
2330
2841
  /**
2331
- * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
2842
+ * Sum of the player&#39;s purchases made with real-money currencies, converted to US dollars equivalent and represented as a
2332
2843
  * whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
2333
2844
  */
2334
2845
  TotalValueToDateInUSD?: number;
2335
- /** List of the player's lifetime purchase totals, summed by real-money currency */
2846
+ /** List of the player&#39;s lifetime purchase totals, summed by real-money currency */
2336
2847
  ValuesToDate?: ValueToDateModel[];
2337
2848
  }
2338
2849
  interface PlayerProfileViewConstraints {
2339
- /** Whether to show player's avatar URL. Defaults to false */
2850
+ /** Whether to show player&#39;s avatar URL. Defaults to false */
2340
2851
  ShowAvatarUrl: boolean;
2341
2852
  /** Whether to show the banned until time. Defaults to false */
2342
2853
  ShowBannedUntil: boolean;
@@ -2348,15 +2859,15 @@ interface PlayerProfileViewConstraints {
2348
2859
  ShowCreated: boolean;
2349
2860
  /** Whether to show the display name. Defaults to false */
2350
2861
  ShowDisplayName: boolean;
2351
- /** Whether to show player's experiment variants. Defaults to false */
2862
+ /** Whether to show player&#39;s experiment variants. Defaults to false */
2352
2863
  ShowExperimentVariants: boolean;
2353
2864
  /** Whether to show the last login time. Defaults to false */
2354
2865
  ShowLastLogin: boolean;
2355
2866
  /** Whether to show the linked accounts. Defaults to false */
2356
2867
  ShowLinkedAccounts: boolean;
2357
- /** Whether to show player's locations. Defaults to false */
2868
+ /** Whether to show player&#39;s locations. Defaults to false */
2358
2869
  ShowLocations: boolean;
2359
- /** Whether to show player's membership information. Defaults to false */
2870
+ /** Whether to show player&#39;s membership information. Defaults to false */
2360
2871
  ShowMemberships: boolean;
2361
2872
  /** Whether to show origination. Defaults to false */
2362
2873
  ShowOrigination: boolean;
@@ -2433,8 +2944,8 @@ interface PurchaseReceiptFulfillment {
2433
2944
  /** Items granted to the player in fulfillment of the validated receipt. */
2434
2945
  FulfilledItems?: ItemInstance[];
2435
2946
  /**
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
2947
+ * Source of the payment price information for the recorded purchase transaction. A value of &#39;Request&#39; indicates that the
2948
+ * price specified in the request was used, whereas a value of &#39;Catalog&#39; indicates that the real-money price of the catalog
2438
2949
  * item matching the product ID in the validated receipt transaction and the currency specified in the request (defaulting
2439
2950
  * to USD) was used.
2440
2951
  */
@@ -2472,6 +2983,17 @@ interface RefreshPSNAuthTokenRequest extends IPlayFabRequestCommon {
2472
2983
  /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
2473
2984
  RedirectUri: string;
2474
2985
  }
2986
+ /** @deprecated Do not use */
2987
+ interface RegionInfo {
2988
+ /** indicates whether the server specified is available in this region */
2989
+ Available: boolean;
2990
+ /** name of the region */
2991
+ Name?: string;
2992
+ /** url to ping to get roundtrip time */
2993
+ PingUrl?: string;
2994
+ /** unique identifier for the region */
2995
+ Region?: string;
2996
+ }
2475
2997
  interface RegisterForIOSPushNotificationRequest extends IPlayFabRequestCommon {
2476
2998
  /** Message to display when confirming push notification. */
2477
2999
  ConfirmationMessage?: string;
@@ -2489,10 +3011,21 @@ interface RegisterPlayFabUserRequest extends IPlayFabRequestCommon {
2489
3011
  DisplayName?: string;
2490
3012
  /** User email address attached to their account */
2491
3013
  Email?: string;
2492
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
3014
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2493
3015
  EncryptedRequest?: string;
2494
3016
  /** Flags for which pieces of info to return for the user. */
2495
3017
  InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
3018
+ /**
3019
+ * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
3020
+ * @deprecated Do not use
3021
+ */
3022
+ LoginTitlePlayerAccountEntity?: boolean;
3023
+ /**
3024
+ * The Origination of a user is determined by the API call used to create the account. In the case of RegisterPlayFabUser,
3025
+ * it will be Organic.
3026
+ * @deprecated Do not use
3027
+ */
3028
+ Origination?: string;
2496
3029
  /** Password for the PlayFab account (6-100 characters) */
2497
3030
  Password?: string;
2498
3031
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
@@ -2504,7 +3037,7 @@ interface RegisterPlayFabUserRequest extends IPlayFabRequestCommon {
2504
3037
  */
2505
3038
  RequireBothUsernameAndEmail?: boolean;
2506
3039
  /**
2507
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
3040
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2508
3041
  * title has been selected.
2509
3042
  */
2510
3043
  TitleId?: string;
@@ -2575,6 +3108,11 @@ interface ReportPlayerClientRequest extends IPlayFabRequestCommon {
2575
3108
  interface ReportPlayerClientResult extends IPlayFabResultCommon {
2576
3109
  /** The number of remaining reports which may be filed today. */
2577
3110
  SubmissionsRemaining: number;
3111
+ /**
3112
+ * Deprecated: Always true
3113
+ * @deprecated Do not use
3114
+ */
3115
+ Updated?: boolean;
2578
3116
  }
2579
3117
  interface RestoreIOSPurchasesRequest extends IPlayFabRequestCommon {
2580
3118
  /** Catalog version of the restored items. If null, defaults to primary catalog. */
@@ -2612,6 +3150,32 @@ interface RewardAdActivityResult extends IPlayFabResultCommon {
2612
3150
  /** Reward results */
2613
3151
  RewardResults?: AdRewardResults;
2614
3152
  }
3153
+ /** @deprecated Do not use */
3154
+ interface RunCloudScriptRequest extends IPlayFabRequestCommon {
3155
+ /** server action to trigger */
3156
+ ActionId: string;
3157
+ /** parameters to pass into the action (If you use this, don&#39;t use ParamsEncoded) */
3158
+ Params?: any;
3159
+ /** json-encoded parameters to pass into the action (If you use this, don&#39;t use Params) */
3160
+ ParamsEncoded?: string;
3161
+ }
3162
+ /** @deprecated Do not use */
3163
+ interface RunCloudScriptResult extends IPlayFabResultCommon {
3164
+ /** id of Cloud Script run */
3165
+ ActionId?: string;
3166
+ /** any log statements generated during the run of this action */
3167
+ ActionLog?: string;
3168
+ /** time this script took to run, in seconds */
3169
+ ExecutionTime: number;
3170
+ /** return values from the server action as a dynamic object */
3171
+ Results?: any;
3172
+ /** return values from the server action as a JSON encoded string */
3173
+ ResultsEncoded?: string;
3174
+ /** revision of Cloud Script run */
3175
+ Revision: number;
3176
+ /** version of Cloud Script run */
3177
+ Version: number;
3178
+ }
2615
3179
  interface ScriptExecutionError {
2616
3180
  /**
2617
3181
  * Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
@@ -2631,7 +3195,12 @@ interface SendAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
2631
3195
  /** The email template id of the account recovery email template to send. */
2632
3196
  EmailTemplateId?: string;
2633
3197
  /**
2634
- * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
3198
+ * Deprecated - Do not use
3199
+ * @deprecated Do not use
3200
+ */
3201
+ PublisherId?: string;
3202
+ /**
3203
+ * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
2635
3204
  * title has been selected.
2636
3205
  */
2637
3206
  TitleId: string;
@@ -2647,7 +3216,7 @@ interface SetFriendTagsRequest extends IPlayFabRequestCommon {
2647
3216
  interface SetFriendTagsResult extends IPlayFabResultCommon {
2648
3217
  }
2649
3218
  interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
2650
- /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
3219
+ /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
2651
3220
  EncryptedRequest?: string;
2652
3221
  /** Player secret that is used to verify API request signatures (Enterprise Only). */
2653
3222
  PlayerSecret?: string;
@@ -2664,6 +3233,47 @@ interface SharedGroupDataRecord {
2664
3233
  /** Data stored for the specified group data key. */
2665
3234
  Value?: string;
2666
3235
  }
3236
+ /** @deprecated Do not use */
3237
+ interface StartGameRequest extends IPlayFabRequestCommon {
3238
+ /** version information for the build of the game server which is to be started */
3239
+ BuildVersion: string;
3240
+ /** character to use for stats based matching. Leave null to use account stats */
3241
+ CharacterId?: string;
3242
+ /** custom command line argument when starting game server process */
3243
+ CustomCommandLineData?: string;
3244
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3245
+ CustomTags?: Record<string, string | null>;
3246
+ /** the title-defined game mode this server is to be running (defaults to 0 if there is only one mode) */
3247
+ GameMode: string;
3248
+ /** the region to associate this server with for match filtering */
3249
+ Region: string;
3250
+ /** player statistic for others to use in finding this game. May be null for no stat-based matching */
3251
+ StatisticName?: string;
3252
+ }
3253
+ /** @deprecated Do not use */
3254
+ interface StartGameResult extends IPlayFabResultCommon {
3255
+ /** timestamp for when the server should expire, if applicable */
3256
+ Expires?: string;
3257
+ /** unique identifier for the lobby of the server started */
3258
+ LobbyID?: string;
3259
+ /** password required to log into the server */
3260
+ Password?: string;
3261
+ /**
3262
+ * server IPV4 address
3263
+ * @deprecated Please use ServerIPV4Address instead.
3264
+ */
3265
+ ServerHostname?: string;
3266
+ /** server IPV4 address */
3267
+ ServerIPV4Address?: string;
3268
+ /** server IPV6 address */
3269
+ ServerIPV6Address?: string;
3270
+ /** port on the server to be used for communication */
3271
+ ServerPort?: number;
3272
+ /** server public DNS name */
3273
+ ServerPublicDNSName?: string;
3274
+ /** unique identifier for the server */
3275
+ Ticket?: string;
3276
+ }
2667
3277
  interface StartPurchaseRequest extends IPlayFabRequestCommon {
2668
3278
  /** Catalog version for the items to be purchased. Defaults to most recent catalog. */
2669
3279
  CatalogVersion?: string;
@@ -2726,6 +3336,11 @@ interface SteamNamePlayFabIdPair {
2726
3336
  interface SteamPlayFabIdPair {
2727
3337
  /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
2728
3338
  PlayFabId?: string;
3339
+ /**
3340
+ * Deprecated: Please use SteamStringId
3341
+ * @deprecated Please use SteamStringId instead.
3342
+ */
3343
+ SteamId?: number;
2729
3344
  /** Unique Steam identifier for a user. */
2730
3345
  SteamStringId?: string;
2731
3346
  }
@@ -2741,7 +3356,7 @@ interface StoreItem {
2741
3356
  ItemId: string;
2742
3357
  /** Override prices for this item for specific currencies */
2743
3358
  RealCurrencyPrices?: Record<string, number>;
2744
- /** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
3359
+ /** Override prices for this item in virtual currencies and &quot;RM&quot; (the base Real Money purchase price, in USD pennies) */
2745
3360
  VirtualCurrencyPrices?: Record<string, number>;
2746
3361
  }
2747
3362
  interface StoreMarketingModel {
@@ -2757,7 +3372,7 @@ interface SubscriptionModel {
2757
3372
  Expiration: string;
2758
3373
  /** The time the subscription was orignially purchased */
2759
3374
  InitialSubscriptionTime: string;
2760
- /** Whether this subscription is currently active. That is, if Expiration > now. */
3375
+ /** Whether this subscription is currently active. That is, if Expiration &gt; now. */
2761
3376
  IsActive: boolean;
2762
3377
  /** The status of this subscription, according to the subscription provider. */
2763
3378
  Status?: string;
@@ -2832,7 +3447,7 @@ interface TwitchPlayFabIdPair {
2832
3447
  }
2833
3448
  interface UnlinkAndroidDeviceIDRequest extends IPlayFabRequestCommon {
2834
3449
  /**
2835
- * Android device identifier for the user's device. If not specified, the most recently signed in Android Device ID will be
3450
+ * Android device identifier for the user&#39;s device. If not specified, the most recently signed in Android Device ID will be
2836
3451
  * used.
2837
3452
  */
2838
3453
  AndroidDeviceId?: string;
@@ -2896,7 +3511,7 @@ interface UnlinkIOSDeviceIDRequest extends IPlayFabRequestCommon {
2896
3511
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2897
3512
  CustomTags?: Record<string, string | null>;
2898
3513
  /**
2899
- * Vendor-specific iOS identifier for the user's device. If not specified, the most recently signed in iOS Device ID will
3514
+ * Vendor-specific iOS identifier for the user&#39;s device. If not specified, the most recently signed in iOS Device ID will
2900
3515
  * be used.
2901
3516
  */
2902
3517
  DeviceId?: string;
@@ -2953,6 +3568,11 @@ interface UnlinkTwitchAccountResult extends IPlayFabResultCommon {
2953
3568
  interface UnlinkXboxAccountRequest extends IPlayFabRequestCommon {
2954
3569
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
2955
3570
  CustomTags?: Record<string, string | null>;
3571
+ /**
3572
+ * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;).
3573
+ * @deprecated Do not use
3574
+ */
3575
+ XboxToken?: string;
2956
3576
  }
2957
3577
  interface UnlinkXboxAccountResult extends IPlayFabResultCommon {
2958
3578
  }
@@ -3008,7 +3628,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
3008
3628
  CustomTags?: Record<string, string | null>;
3009
3629
  /**
3010
3630
  * 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.
3631
+ * not begin with a &#39;!&#39; character or be null.
3012
3632
  */
3013
3633
  Data?: Record<string, string | null>;
3014
3634
  /**
@@ -3016,7 +3636,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
3016
3636
  * constraints. Use this to delete the keys directly.
3017
3637
  */
3018
3638
  KeysToRemove?: string[];
3019
- /** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
3639
+ /** Permission to be applied to all user data keys written in this request. Defaults to &quot;private&quot; if not set. */
3020
3640
  Permission?: string;
3021
3641
  }
3022
3642
  interface UpdateCharacterDataResult extends IPlayFabResultCommon {
@@ -3041,7 +3661,7 @@ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
3041
3661
  CustomTags?: Record<string, string | null>;
3042
3662
  /**
3043
3663
  * 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.
3664
+ * player&#39;s properties have not been updated by any other clients since last the version.
3045
3665
  */
3046
3666
  ExpectedPropertiesVersion?: number;
3047
3667
  /** Collection of properties to be set for a player. */
@@ -3049,7 +3669,7 @@ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
3049
3669
  }
3050
3670
  interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
3051
3671
  /**
3052
- * Indicates the current version of a player's properties that have been set. This is incremented after updates and
3672
+ * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
3053
3673
  * deletes. This version can be provided in update and delete calls for concurrency control.
3054
3674
  */
3055
3675
  PropertiesVersion: number;
@@ -3073,7 +3693,7 @@ interface UpdateSharedGroupDataRequest extends IPlayFabRequestCommon {
3073
3693
  CustomTags?: Record<string, string | null>;
3074
3694
  /**
3075
3695
  * 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.
3696
+ * not begin with a &#39;!&#39; character or be null.
3077
3697
  */
3078
3698
  Data?: Record<string, string | null>;
3079
3699
  /**
@@ -3093,7 +3713,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
3093
3713
  CustomTags?: Record<string, string | null>;
3094
3714
  /**
3095
3715
  * 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.
3716
+ * not begin with a &#39;!&#39; character or be null.
3097
3717
  */
3098
3718
  Data?: Record<string, string | null>;
3099
3719
  /**
@@ -3102,7 +3722,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
3102
3722
  */
3103
3723
  KeysToRemove?: string[];
3104
3724
  /**
3105
- * Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. This is used
3725
+ * Permission to be applied to all user data keys written in this request. Defaults to &quot;private&quot; if not set. This is used
3106
3726
  * for requests by one player for information about another player; those requests will only return Public keys.
3107
3727
  */
3108
3728
  Permission?: string;
@@ -3114,6 +3734,19 @@ interface UpdateUserDataResult extends IPlayFabResultCommon {
3114
3734
  */
3115
3735
  DataVersion: number;
3116
3736
  }
3737
+ /** @deprecated Do not use */
3738
+ interface UpdateUserStatisticsRequest extends IPlayFabRequestCommon {
3739
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3740
+ CustomTags?: Record<string, string | null>;
3741
+ /**
3742
+ * Statistics to be updated with the provided values. UserStatistics object must follow the Key(string), Value(int)
3743
+ * pattern.
3744
+ */
3745
+ UserStatistics?: Record<string, number>;
3746
+ }
3747
+ /** @deprecated Do not use */
3748
+ interface UpdateUserStatisticsResult extends IPlayFabResultCommon {
3749
+ }
3117
3750
  interface UpdateUserTitleDisplayNameRequest extends IPlayFabRequestCommon {
3118
3751
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
3119
3752
  CustomTags?: Record<string, string | null>;
@@ -3298,7 +3931,7 @@ interface UserSteamInfo {
3298
3931
  SteamName?: string;
3299
3932
  }
3300
3933
  interface UserTitleInfo {
3301
- /** URL to the player's avatar. */
3934
+ /** URL to the player&#39;s avatar. */
3302
3935
  AvatarUrl?: string;
3303
3936
  /**
3304
3937
  * timestamp indicating when the user was first associated with this game (this can differ significantly from when the user
@@ -3406,12 +4039,12 @@ interface ValueToDateModel {
3406
4039
  Currency?: string;
3407
4040
  /**
3408
4041
  * 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')
4042
+ * ninety-nine cents when Currency is &#39;USD&#39;)
3410
4043
  */
3411
4044
  TotalValue: number;
3412
4045
  /**
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'.
4046
+ * Total value of the purchases in a string representation of decimal monetary units. For example, &#39;9.99&#39; indicates nine
4047
+ * dollars and ninety-nine cents when Currency is &#39;USD&#39;.
3415
4048
  */
3416
4049
  TotalValueAsDecimal?: string;
3417
4050
  }
@@ -3494,166 +4127,368 @@ declare class PlayFabClientApi extends PlayFabCommon {
3494
4127
  * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
3495
4128
  * allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
3496
4129
  * 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>;
4130
+ *
4131
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade Microsoft Documentation}
4132
+ * @example
4133
+ * await clientClient.AcceptTrade({
4134
+ * "OfferingPlayerId": "CD803BF233CE76CC",
4135
+ * "TradeId": "D819CEC225EA9948C351",
4136
+ * "AcceptedInventoryInstanceIds": [
4137
+ * "95C1797ADDAC24DC0383",
4138
+ * "0F7793DF55CCEAF21B84"
4139
+ * ]
4140
+ * });
4141
+ */
4142
+ AcceptTrade(request: AcceptTradeRequest, extraHeaders?: Record<string, string>): Promise<AcceptTradeResponse>;
3500
4143
  /**
3501
4144
  * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
3502
4145
  * least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
3503
- * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
4146
+ *
4147
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend Microsoft Documentation}
4148
+ * @example
4149
+ * await clientClient.AddFriend({
4150
+ * "FriendPlayFabId": "29837799"
4151
+ * });
3504
4152
  */
3505
- AddFriend(request: AddFriendRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddFriendResult>;
4153
+ AddFriend(request: AddFriendRequest, extraHeaders?: Record<string, string>): Promise<AddFriendResult>;
3506
4154
  /**
3507
4155
  * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
3508
4156
  * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
3509
4157
  * 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>;
4158
+ *
4159
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid Microsoft Documentation}
4160
+ * @example
4161
+ * await clientClient.AddGenericID({
4162
+ * "GenericId": {
4163
+ * "ServiceName": "BigBizSocial",
4164
+ * "UserId": "1234567890"
4165
+ * }
4166
+ * });
4167
+ */
4168
+ AddGenericID(request: AddGenericIDRequest, extraHeaders?: Record<string, string>): Promise<AddGenericIDResult>;
3513
4169
  /**
3514
4170
  * Adds or updates a contact email to the player's profile.
3515
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
4171
+ *
4172
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail Microsoft Documentation}
4173
+ * @example
4174
+ * await clientClient.AddOrUpdateContactEmail({
4175
+ * "EmailAddress": "theuser@domain.com"
4176
+ * });
3516
4177
  */
3517
- AddOrUpdateContactEmail(request: AddOrUpdateContactEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddOrUpdateContactEmailResult>;
4178
+ AddOrUpdateContactEmail(request: AddOrUpdateContactEmailRequest, extraHeaders?: Record<string, string>): Promise<AddOrUpdateContactEmailResult>;
3518
4179
  /**
3519
4180
  * 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
4181
  * in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
3521
4182
  * 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>;
4183
+ *
4184
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers Microsoft Documentation}
4185
+ * @example
4186
+ * await clientClient.AddSharedGroupMembers({
4187
+ * "SharedGroupId": "Clan Data",
4188
+ * "PlayFabIds": [
4189
+ * "D984A64B832",
4190
+ * "F74A523E1562"
4191
+ * ]
4192
+ * });
4193
+ */
4194
+ AddSharedGroupMembers(request: AddSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
3525
4195
  /**
3526
4196
  * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
3527
4197
  * ID login.
3528
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
4198
+ *
4199
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword Microsoft Documentation}
4200
+ * @example
4201
+ * await clientClient.AddUsernamePassword({
4202
+ * "Username": "theuser",
4203
+ * "Email": "me@here.com",
4204
+ * "Password": "ExampleSecret"
4205
+ * });
3529
4206
  */
3530
- AddUsernamePassword(request: AddUsernamePasswordRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AddUsernamePasswordResult>;
4207
+ AddUsernamePassword(request: AddUsernamePasswordRequest, extraHeaders?: Record<string, string>): Promise<AddUsernamePasswordResult>;
3531
4208
  /**
3532
4209
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3533
4210
  * 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
4211
+ *
4212
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency Microsoft Documentation}
4213
+ * @example
4214
+ * await clientClient.AddUserVirtualCurrency({
4215
+ * "VirtualCurrency": "GC",
4216
+ * "Amount": 100
4217
+ * });
3535
4218
  */
3536
- AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
4219
+ AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
3537
4220
  /**
3538
4221
  * Registers the Android device to receive push notifications
3539
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
4222
+ *
4223
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration Microsoft Documentation}
4224
+ * @example
4225
+ * await clientClient.AndroidDevicePushNotificationRegistration({
4226
+ * "DeviceToken": "59872d98fa632brn8hg3770",
4227
+ * "SendPushNotificationConfirmation": true,
4228
+ * "ConfirmationMessage": "Welcome to PlayFab!"
4229
+ * });
3540
4230
  */
3541
- AndroidDevicePushNotificationRegistration(request: AndroidDevicePushNotificationRegistrationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AndroidDevicePushNotificationRegistrationResult>;
4231
+ AndroidDevicePushNotificationRegistration(request: AndroidDevicePushNotificationRegistrationRequest, extraHeaders?: Record<string, string>): Promise<AndroidDevicePushNotificationRegistrationResult>;
3542
4232
  /**
3543
4233
  * Attributes an install for advertisment.
3544
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
4234
+ *
4235
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall Microsoft Documentation}
4236
+ * @example
4237
+ * await clientClient.AttributeInstall({
4238
+ * "Idfa": "11098810"
4239
+ * });
3545
4240
  */
3546
- AttributeInstall(request: AttributeInstallRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<AttributeInstallResult>;
4241
+ AttributeInstall(request: AttributeInstallRequest, extraHeaders?: Record<string, string>): Promise<AttributeInstallResult>;
3547
4242
  /**
3548
4243
  * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
3549
4244
  * can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
3550
4245
  * 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
4246
+ *
4247
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade Microsoft Documentation}
4248
+ * @example
4249
+ * await clientClient.CancelTrade({
4250
+ * "TradeId": "D819CEC225EA9948C351"
4251
+ * });
3552
4252
  */
3553
- CancelTrade(request: CancelTradeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CancelTradeResponse>;
4253
+ CancelTrade(request: CancelTradeRequest, extraHeaders?: Record<string, string>): Promise<CancelTradeResponse>;
3554
4254
  /**
3555
4255
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3556
4256
  * version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
3557
4257
  * virtual currency balances as appropriate
3558
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
4258
+ *
4259
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase Microsoft Documentation}
4260
+ * @example
4261
+ * await clientClient.ConfirmPurchase({
4262
+ * "OrderId": "8853591446005860822"
4263
+ * });
3559
4264
  */
3560
- ConfirmPurchase(request: ConfirmPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConfirmPurchaseResult>;
4265
+ ConfirmPurchase(request: ConfirmPurchaseRequest, extraHeaders?: Record<string, string>): Promise<ConfirmPurchaseResult>;
3561
4266
  /**
3562
4267
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3563
4268
  * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
3564
4269
  * inventory.
3565
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
4270
+ *
4271
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem Microsoft Documentation}
4272
+ * @example
4273
+ * await clientClient.ConsumeItem({
4274
+ * "ItemInstanceId": "94585729",
4275
+ * "ConsumeCount": 1
4276
+ * });
3566
4277
  */
3567
- ConsumeItem(request: ConsumeItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
4278
+ ConsumeItem(request: ConsumeItemRequest, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
3568
4279
  /**
3569
4280
  * 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>;
4281
+ *
4282
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements Microsoft Documentation}
4283
+ * @example
4284
+ * await clientClient.ConsumeMicrosoftStoreEntitlements({
4285
+ * "MarketplaceSpecificData": {
4286
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
4287
+ * "userId": "46239871",
4288
+ * "collectionsMsIdKey": "MicrosoftStoreIdKey"
4289
+ * },
4290
+ * "CatalogVersion": "MainCatalog"
4291
+ * });
4292
+ */
4293
+ ConsumeMicrosoftStoreEntitlements(request: ConsumeMicrosoftStoreEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumeMicrosoftStoreEntitlementsResponse>;
3573
4294
  /**
3574
4295
  * Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
3575
4296
  * 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>;
4297
+ *
4298
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements Microsoft Documentation}
4299
+ * @example
4300
+ * await clientClient.ConsumePS5Entitlements({
4301
+ * "MarketplaceSpecificData": {
4302
+ * "ServiceLabel": "1"
4303
+ * },
4304
+ * "CatalogVersion": "MainCatalog"
4305
+ * });
4306
+ */
4307
+ ConsumePS5Entitlements(request: ConsumePS5EntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumePS5EntitlementsResult>;
3579
4308
  /**
3580
4309
  * 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
4310
+ *
4311
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements Microsoft Documentation}
4312
+ * @example
4313
+ * await clientClient.ConsumePSNEntitlements({
4314
+ * "ServiceLabel": 1
4315
+ * });
3582
4316
  */
3583
- ConsumePSNEntitlements(request: ConsumePSNEntitlementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumePSNEntitlementsResult>;
4317
+ ConsumePSNEntitlements(request: ConsumePSNEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumePSNEntitlementsResult>;
3584
4318
  /**
3585
4319
  * Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
3586
4320
  * 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
4321
+ *
4322
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements Microsoft Documentation}
4323
+ * @example
4324
+ * await clientClient.ConsumeXboxEntitlements({
4325
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
4326
+ * "CatalogVersion": "XboxItems"
4327
+ * });
3588
4328
  */
3589
- ConsumeXboxEntitlements(request: ConsumeXboxEntitlementsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ConsumeXboxEntitlementsResult>;
4329
+ ConsumeXboxEntitlements(request: ConsumeXboxEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumeXboxEntitlementsResult>;
3590
4330
  /**
3591
4331
  * Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the
3592
4332
  * group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
3593
4333
  * between a very small number of players, please see our guide:
3594
4334
  * 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
4335
+ *
4336
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup Microsoft Documentation}
4337
+ * @example
4338
+ * await clientClient.CreateSharedGroup({
4339
+ * "SharedGroupId": "Clan Data"
4340
+ * });
3596
4341
  */
3597
- CreateSharedGroup(request: CreateSharedGroupRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
4342
+ CreateSharedGroup(request: CreateSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
3598
4343
  /**
3599
4344
  * 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>;
4345
+ *
4346
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties Microsoft Documentation}
4347
+ * @example
4348
+ * await clientClient.DeletePlayerCustomProperties({
4349
+ * "PropertyNames": [
4350
+ * "level",
4351
+ * "created"
4352
+ * ],
4353
+ * "ExpectedPropertiesVersion": 12
4354
+ * });
4355
+ */
4356
+ DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
3603
4357
  /**
3604
4358
  * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
3605
4359
  * 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>;
4360
+ *
4361
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript Microsoft Documentation}
4362
+ * @example
4363
+ * await clientClient.ExecuteCloudScript({
4364
+ * "FunctionName": "levelCompleted",
4365
+ * "FunctionParameter": {
4366
+ * "level": 3,
4367
+ * "points": 400
4368
+ * },
4369
+ * "RevisionSelection": "Live",
4370
+ * "GeneratePlayStreamEvent": true
4371
+ * });
4372
+ */
4373
+ ExecuteCloudScript(request: ExecuteCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
3609
4374
  /**
3610
4375
  * Retrieves the user's PlayFab account details
3611
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
4376
+ *
4377
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo Microsoft Documentation}
4378
+ * @example
4379
+ * await clientClient.GetAccountInfo({
4380
+ * "PlayFabId": "10931252888739651331"
4381
+ * });
3612
4382
  */
3613
- GetAccountInfo(request: GetAccountInfoRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetAccountInfoResult>;
4383
+ GetAccountInfo(request: GetAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<GetAccountInfoResult>;
3614
4384
  /**
3615
4385
  * 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>;
4386
+ *
4387
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements Microsoft Documentation}
4388
+ * @example
4389
+ * await clientClient.GetAdPlacements({
4390
+ * "AppId": "A12784B",
4391
+ * "Identifier": {
4392
+ * "Name": "PowerBonusInterstitial"
4393
+ * }
4394
+ * });
4395
+ */
4396
+ GetAdPlacements(request: GetAdPlacementsRequest, extraHeaders?: Record<string, string>): Promise<GetAdPlacementsResult>;
3619
4397
  /**
3620
4398
  * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
3621
4399
  * evaluated with the parent PlayFabId to guarantee uniqueness.
3622
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
4400
+ *
4401
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters Microsoft Documentation}
4402
+ * @example
4403
+ * await clientClient.GetAllUsersCharacters({
4404
+ * "PlayFabId": "98333765432"
4405
+ * });
3623
4406
  */
3624
- GetAllUsersCharacters(request: ListUsersCharactersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
4407
+ GetAllUsersCharacters(request: ListUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
3625
4408
  /**
3626
4409
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3627
4410
  * 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
4411
+ *
4412
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems Microsoft Documentation}
4413
+ * @example
4414
+ * await clientClient.GetCatalogItems({
4415
+ * "CatalogVersion": "1"
4416
+ * });
3629
4417
  */
3630
- GetCatalogItems(request: GetCatalogItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
4418
+ GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
3631
4419
  /**
3632
4420
  * 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>;
4421
+ *
4422
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata Microsoft Documentation}
4423
+ * @example
4424
+ * await clientClient.GetCharacterData({
4425
+ * "PlayFabId": "2039475",
4426
+ * "CharacterId": "98342357",
4427
+ * "Keys": [
4428
+ * "preferences",
4429
+ * "progress"
4430
+ * ]
4431
+ * });
4432
+ */
4433
+ GetCharacterData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3636
4434
  /**
3637
4435
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3638
4436
  * 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
4437
+ *
4438
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory Microsoft Documentation}
4439
+ * @example
4440
+ * await clientClient.GetCharacterInventory({
4441
+ * "CharacterId": "9890723423",
4442
+ * "CatalogVersion": "5"
4443
+ * });
3640
4444
  */
3641
- GetCharacterInventory(request: GetCharacterInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
4445
+ GetCharacterInventory(request: GetCharacterInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
3642
4446
  /**
3643
4447
  * 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>;
4448
+ *
4449
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard Microsoft Documentation}
4450
+ * @example
4451
+ * await clientClient.GetCharacterLeaderboard({
4452
+ * "CharacterType": "blue_warrior",
4453
+ * "StatisticName": "Kills",
4454
+ * "StartPosition": 0,
4455
+ * "MaxResultsCount": 20
4456
+ * });
4457
+ */
4458
+ GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
3647
4459
  /**
3648
4460
  * 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>;
4461
+ *
4462
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata Microsoft Documentation}
4463
+ * @example
4464
+ * await clientClient.GetCharacterReadOnlyData({
4465
+ * "PlayFabId": "2039475",
4466
+ * "CharacterId": "98342357",
4467
+ * "Keys": [
4468
+ * "preferences",
4469
+ * "progress"
4470
+ * ]
4471
+ * });
4472
+ */
4473
+ GetCharacterReadOnlyData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
3652
4474
  /**
3653
4475
  * Retrieves the details of all title-specific statistics for the user
3654
- * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
4476
+ *
4477
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics Microsoft Documentation}
4478
+ * @example
4479
+ * await clientClient.GetCharacterStatistics({
4480
+ * "CharacterId": "98765432"
4481
+ * });
4482
+ */
4483
+ GetCharacterStatistics(request: GetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
4484
+ /**
4485
+ * Retrieves the title-specific URL for Cloud Script servers. This must be queried once, prior to making any calls to
4486
+ * RunCloudScript.
4487
+ *
4488
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/getcloudscripturl Microsoft Documentation}
4489
+ * @deprecated Please use ExecuteCloudScript instead.
3655
4490
  */
3656
- GetCharacterStatistics(request: GetCharacterStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
4491
+ GetCloudScriptUrl(request: GetCloudScriptUrlRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptUrlResult>;
3657
4492
  /**
3658
4493
  * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
3659
4494
  * URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the
@@ -3661,822 +4496,1903 @@ declare class PlayFabClientApi extends PlayFabCommon {
3661
4496
  * the query to retrieve the data will fail. See this post for more information:
3662
4497
  * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
3663
4498
  * 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
4499
+ *
4500
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl Microsoft Documentation}
4501
+ * @example
4502
+ * await clientClient.GetContentDownloadUrl({
4503
+ * "Key": "images/sword_icon.png"
4504
+ * });
4505
+ */
4506
+ GetContentDownloadUrl(request: GetContentDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
4507
+ /**
4508
+ * Get details about all current running game servers matching the given parameters.
4509
+ *
4510
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/getcurrentgames Microsoft Documentation}
4511
+ * @deprecated Please use MultiplayerServer/ListMultiplayerServers instead.
3665
4512
  */
3666
- GetContentDownloadUrl(request: GetContentDownloadUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
4513
+ GetCurrentGames(request: CurrentGamesRequest, extraHeaders?: Record<string, string>): Promise<CurrentGamesResult>;
3667
4514
  /**
3668
4515
  * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
3669
4516
  * 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>;
4517
+ *
4518
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard Microsoft Documentation}
4519
+ * @example
4520
+ * await clientClient.GetFriendLeaderboard({
4521
+ * "StatisticName": "Kills",
4522
+ * "StartPosition": 1258,
4523
+ * "MaxResultsCount": 20,
4524
+ * "ExternalPlatformFriends": "Facebook, Xbox, Psn"
4525
+ * });
4526
+ */
4527
+ GetFriendLeaderboard(request: GetFriendLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
4528
+ /**
4529
+ * Retrieves a list of ranked friends of the current player for the given statistic, centered on the currently signed-in
4530
+ * user
4531
+ *
4532
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundcurrentuser Microsoft Documentation}
4533
+ * @deprecated Please use GetFriendLeaderboardAroundPlayer instead.
4534
+ */
4535
+ GetFriendLeaderboardAroundCurrentUser(request: GetFriendLeaderboardAroundCurrentUserRequest, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundCurrentUserResult>;
3673
4536
  /**
3674
4537
  * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
3675
4538
  * 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
4539
+ *
4540
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer Microsoft Documentation}
4541
+ * @example
4542
+ * await clientClient.GetFriendLeaderboardAroundPlayer({
4543
+ * "StatisticName": "Kills",
4544
+ * "MaxResultsCount": 20,
4545
+ * "ExternalPlatformFriends": "None"
4546
+ * });
3677
4547
  */
3678
- GetFriendLeaderboardAroundPlayer(request: GetFriendLeaderboardAroundPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundPlayerResult>;
4548
+ GetFriendLeaderboardAroundPlayer(request: GetFriendLeaderboardAroundPlayerRequest, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundPlayerResult>;
3679
4549
  /**
3680
4550
  * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
3681
4551
  * 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
4552
+ *
4553
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist Microsoft Documentation}
4554
+ * @example
4555
+ * await clientClient.GetFriendsList({
4556
+ * "ExternalPlatformFriends": "Steam"
4557
+ * });
4558
+ */
4559
+ GetFriendsList(request: GetFriendsListRequest, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
4560
+ /**
4561
+ * Get details about the regions hosting game servers matching the given parameters.
4562
+ *
4563
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/getgameserverregions Microsoft Documentation}
4564
+ * @deprecated Please use MultiplayerServer/ListMultiplayerServers instead.
3683
4565
  */
3684
- GetFriendsList(request: GetFriendsListRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
4566
+ GetGameServerRegions(request: GameServerRegionsRequest, extraHeaders?: Record<string, string>): Promise<GameServerRegionsResult>;
3685
4567
  /**
3686
4568
  * 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
4569
+ *
4570
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard Microsoft Documentation}
4571
+ * @example
4572
+ * await clientClient.GetLeaderboard({
4573
+ * "StatisticName": "Kills",
4574
+ * "StartPosition": 0,
4575
+ * "MaxResultsCount": 20
4576
+ * });
3688
4577
  */
3689
- GetLeaderboard(request: GetLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
4578
+ GetLeaderboard(request: GetLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
3690
4579
  /**
3691
4580
  * 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
4581
+ *
4582
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter Microsoft Documentation}
4583
+ * @example
4584
+ * await clientClient.GetLeaderboardAroundCharacter({
4585
+ * "StatisticName": "Kills",
4586
+ * "CharacterId": "987343220",
4587
+ * "MaxResultsCount": 20
4588
+ * });
4589
+ */
4590
+ GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
4591
+ /**
4592
+ * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
4593
+ *
4594
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundcurrentuser Microsoft Documentation}
4595
+ * @deprecated Please use GetLeaderboardAroundPlayer instead.
3693
4596
  */
3694
- GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
4597
+ GetLeaderboardAroundCurrentUser(request: GetLeaderboardAroundCurrentUserRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCurrentUserResult>;
3695
4598
  /**
3696
4599
  * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
3697
4600
  * null will return currently logged in user.
3698
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
4601
+ *
4602
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer Microsoft Documentation}
4603
+ * @example
4604
+ * await clientClient.GetLeaderboardAroundPlayer({
4605
+ * "StatisticName": "Kills",
4606
+ * "MaxResultsCount": 20
4607
+ * });
3699
4608
  */
3700
- GetLeaderboardAroundPlayer(request: GetLeaderboardAroundPlayerRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundPlayerResult>;
4609
+ GetLeaderboardAroundPlayer(request: GetLeaderboardAroundPlayerRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundPlayerResult>;
3701
4610
  /**
3702
4611
  * 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
4612
+ *
4613
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters Microsoft Documentation}
4614
+ * @example
4615
+ * await clientClient.GetLeaderboardForUserCharacters({
4616
+ * "StatisticName": "Kills"
4617
+ * });
3704
4618
  */
3705
- GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
4619
+ GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
3706
4620
  /**
3707
4621
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3708
4622
  * version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
3709
4623
  * client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
3710
4624
  * 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
4625
+ *
4626
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken Microsoft Documentation}
4627
+ * @example
4628
+ * await clientClient.GetPaymentToken({
4629
+ * "TokenProvider": "xsolla"
4630
+ * });
3712
4631
  */
3713
- GetPaymentToken(request: GetPaymentTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPaymentTokenResult>;
4632
+ GetPaymentToken(request: GetPaymentTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPaymentTokenResult>;
3714
4633
  /**
3715
4634
  * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
3716
4635
  * https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
3717
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
4636
+ *
4637
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken Microsoft Documentation}
4638
+ * @example
4639
+ * await clientClient.GetPhotonAuthenticationToken({
4640
+ * "PhotonApplicationId": "acaa26f3-fcdb-4af4-8c76-3a3d4dd3066f"
4641
+ * });
3718
4642
  */
3719
- GetPhotonAuthenticationToken(request: GetPhotonAuthenticationTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPhotonAuthenticationTokenResult>;
4643
+ GetPhotonAuthenticationToken(request: GetPhotonAuthenticationTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPhotonAuthenticationTokenResult>;
3720
4644
  /**
3721
4645
  * 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>;
4646
+ *
4647
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo Microsoft Documentation}
4648
+ * @example
4649
+ * await clientClient.GetPlayerCombinedInfo({
4650
+ * "PlayFabId": "4027527BF22653D1",
4651
+ * "InfoRequestParameters": {
4652
+ * "GetUserAccountInfo": true,
4653
+ * "GetUserInventory": false,
4654
+ * "GetUserVirtualCurrency": true,
4655
+ * "GetUserData": true,
4656
+ * "UserDataKeys": [
4657
+ * "preferences",
4658
+ * "progress"
4659
+ * ],
4660
+ * "GetUserReadOnlyData": false,
4661
+ * "GetCharacterInventories": false,
4662
+ * "GetCharacterList": false,
4663
+ * "GetTitleData": false,
4664
+ * "GetPlayerStatistics": false,
4665
+ * "GetPlayerProfile": false,
4666
+ * "GetEntityLineage": false
4667
+ * }
4668
+ * });
4669
+ */
4670
+ GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
3725
4671
  /**
3726
4672
  * Retrieves a title-specific custom property value for a player.
3727
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
4673
+ *
4674
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty Microsoft Documentation}
4675
+ * @example
4676
+ * await clientClient.GetPlayerCustomProperty({
4677
+ * "PropertyName": "level"
4678
+ * });
3728
4679
  */
3729
- GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
4680
+ GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
3730
4681
  /**
3731
4682
  * Retrieves the player's profile
3732
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
4683
+ *
4684
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile Microsoft Documentation}
4685
+ * @example
4686
+ * await clientClient.GetPlayerProfile({
4687
+ * "PlayFabId": "621EF20237534A44"
4688
+ * });
3733
4689
  */
3734
- GetPlayerProfile(request: GetPlayerProfileRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
4690
+ GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
3735
4691
  /**
3736
4692
  * 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
4693
+ *
4694
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments Microsoft Documentation}
4695
+ * @example
4696
+ * await clientClient.GetPlayerSegments({});
3738
4697
  */
3739
- GetPlayerSegments(request: GetPlayerSegmentsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
4698
+ GetPlayerSegments(request: GetPlayerSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
3740
4699
  /**
3741
4700
  * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
3742
4701
  * 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>;
4702
+ *
4703
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics Microsoft Documentation}
4704
+ * @example
4705
+ * await clientClient.GetPlayerStatistics({
4706
+ * "StatisticNames": [
4707
+ * "Points",
4708
+ * "Wins"
4709
+ * ]
4710
+ * });
4711
+ */
4712
+ GetPlayerStatistics(request: GetPlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
3746
4713
  /**
3747
4714
  * Retrieves the information on the available versions of the specified statistic.
3748
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
4715
+ *
4716
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions Microsoft Documentation}
4717
+ * @example
4718
+ * await clientClient.GetPlayerStatisticVersions({
4719
+ * "StatisticName": "headshots"
4720
+ * });
3749
4721
  */
3750
- GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
4722
+ GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
3751
4723
  /**
3752
4724
  * Get all tags with a given Namespace (optional) from a player profile.
3753
- * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
4725
+ *
4726
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags Microsoft Documentation}
4727
+ * @example
4728
+ * await clientClient.GetPlayerTags({
4729
+ * "PlayFabId": "10931252888739651331",
4730
+ * "Namespace": "title.AAA"
4731
+ * });
3754
4732
  */
3755
- GetPlayerTags(request: GetPlayerTagsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
4733
+ GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
3756
4734
  /**
3757
4735
  * 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
4736
+ *
4737
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades Microsoft Documentation}
4738
+ * @example
4739
+ * await clientClient.GetPlayerTrades({
4740
+ * "StatusFilter": "Filled"
4741
+ * });
3759
4742
  */
3760
- GetPlayerTrades(request: GetPlayerTradesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPlayerTradesResponse>;
4743
+ GetPlayerTrades(request: GetPlayerTradesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTradesResponse>;
3761
4744
  /**
3762
4745
  * 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>;
4746
+ *
4747
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids Microsoft Documentation}
4748
+ * @example
4749
+ * await clientClient.GetPlayFabIDsFromBattleNetAccountIds({
4750
+ * "BattleNetAccountIds": [
4751
+ * "526f79204261747478",
4752
+ * "526f79204261747479"
4753
+ * ]
4754
+ * });
4755
+ */
4756
+ GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
3766
4757
  /**
3767
4758
  * 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>;
4759
+ *
4760
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids Microsoft Documentation}
4761
+ * @example
4762
+ * await clientClient.GetPlayFabIDsFromFacebookIDs({
4763
+ * "FacebookIDs": [
4764
+ * "857498576495",
4765
+ * "759374651209"
4766
+ * ]
4767
+ * });
4768
+ */
4769
+ GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
3771
4770
  /**
3772
4771
  * 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>;
4772
+ *
4773
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids Microsoft Documentation}
4774
+ * @example
4775
+ * await clientClient.GetPlayFabIDsFromFacebookInstantGamesIds({
4776
+ * "FacebookInstantGamesIds": [
4777
+ * "1114685845316172",
4778
+ * "1114685845316173"
4779
+ * ]
4780
+ * });
4781
+ */
4782
+ GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
3776
4783
  /**
3777
4784
  * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
3778
4785
  * 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>;
4786
+ *
4787
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids Microsoft Documentation}
4788
+ * @example
4789
+ * await clientClient.GetPlayFabIDsFromGameCenterIDs({
4790
+ * "GameCenterIDs": [
4791
+ * "857498576495",
4792
+ * "759374651209"
4793
+ * ]
4794
+ * });
4795
+ */
4796
+ GetPlayFabIDsFromGameCenterIDs(request: GetPlayFabIDsFromGameCenterIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGameCenterIDsResult>;
3782
4797
  /**
3783
4798
  * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
3784
4799
  * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
3785
4800
  * 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>;
4801
+ *
4802
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids Microsoft Documentation}
4803
+ * @example
4804
+ * await clientClient.GetPlayFabIDsFromGenericIDs({
4805
+ * "GenericIDs": [
4806
+ * {
4807
+ * "ServiceName": "BigBizSocial",
4808
+ * "UserId": "1234567890"
4809
+ * },
4810
+ * {
4811
+ * "ServiceName": "VeeCeeMe",
4812
+ * "UserId": "og5igh85gf43gf"
4813
+ * }
4814
+ * ]
4815
+ * });
4816
+ */
4817
+ GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
3789
4818
  /**
3790
4819
  * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
3791
4820
  * 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>;
4821
+ *
4822
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids Microsoft Documentation}
4823
+ * @example
4824
+ * await clientClient.GetPlayFabIDsFromGoogleIDs({
4825
+ * "GoogleIDs": [
4826
+ * "857498576495",
4827
+ * "759374651209"
4828
+ * ]
4829
+ * });
4830
+ */
4831
+ GetPlayFabIDsFromGoogleIDs(request: GetPlayFabIDsFromGoogleIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGoogleIDsResult>;
3795
4832
  /**
3796
4833
  * Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
3797
4834
  * identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
3798
4835
  * 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>;
4836
+ *
4837
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids Microsoft Documentation}
4838
+ * @example
4839
+ * await clientClient.GetPlayFabIDsFromGooglePlayGamesPlayerIDs({
4840
+ * "GooglePlayGamesPlayerIDs": [
4841
+ * "857498576495",
4842
+ * "759374651209"
4843
+ * ]
4844
+ * });
4845
+ */
4846
+ GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request: GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult>;
3802
4847
  /**
3803
4848
  * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
3804
4849
  * IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
3805
4850
  * 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>;
4851
+ *
4852
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids Microsoft Documentation}
4853
+ * @example
4854
+ * await clientClient.GetPlayFabIDsFromKongregateIDs({
4855
+ * "KongregateIDs": [
4856
+ * "857498576495",
4857
+ * "759374651209"
4858
+ * ]
4859
+ * });
4860
+ */
4861
+ GetPlayFabIDsFromKongregateIDs(request: GetPlayFabIDsFromKongregateIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromKongregateIDsResult>;
3809
4862
  /**
3810
4863
  * 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>;
4864
+ *
4865
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids Microsoft Documentation}
4866
+ * @example
4867
+ * await clientClient.GetPlayFabIDsFromNintendoServiceAccountIds({
4868
+ * "NintendoAccountIds": [
4869
+ * "526f79204261747478",
4870
+ * "526f79204261747479"
4871
+ * ]
4872
+ * });
4873
+ */
4874
+ GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
3814
4875
  /**
3815
4876
  * 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>;
4877
+ *
4878
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids Microsoft Documentation}
4879
+ * @example
4880
+ * await clientClient.GetPlayFabIDsFromNintendoSwitchDeviceIds({
4881
+ * "NintendoSwitchDeviceIds": [
4882
+ * "526f79204261747478",
4883
+ * "526f79204261747479"
4884
+ * ]
4885
+ * });
4886
+ */
4887
+ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
3819
4888
  /**
3820
4889
  * 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>;
4890
+ *
4891
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids Microsoft Documentation}
4892
+ * @example
4893
+ * await clientClient.GetPlayFabIDsFromPSNAccountIDs({
4894
+ * "PSNAccountIDs": [
4895
+ * "857498576495",
4896
+ * "759374651209"
4897
+ * ]
4898
+ * });
4899
+ */
4900
+ GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
3824
4901
  /**
3825
4902
  * 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>;
4903
+ *
4904
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids Microsoft Documentation}
4905
+ * @example
4906
+ * await clientClient.GetPlayFabIDsFromPSNOnlineIDs({
4907
+ * "PSNOnlineIDs": [
4908
+ * "857555576495",
4909
+ * "759345551209"
4910
+ * ]
4911
+ * });
4912
+ */
4913
+ GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
3829
4914
  /**
3830
4915
  * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
3831
4916
  * 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>;
4917
+ *
4918
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids Microsoft Documentation}
4919
+ * @example
4920
+ * await clientClient.GetPlayFabIDsFromSteamIDs({
4921
+ * "SteamStringIDs": [
4922
+ * "857498576495",
4923
+ * "759374651209"
4924
+ * ]
4925
+ * });
4926
+ */
4927
+ GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
3835
4928
  /**
3836
4929
  * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
3837
4930
  * 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>;
4931
+ *
4932
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames Microsoft Documentation}
4933
+ * @example
4934
+ * await clientClient.GetPlayFabIDsFromSteamNames({
4935
+ * "SteamNames": [
4936
+ * "steamPersonaName1",
4937
+ * "steamPersonaName2"
4938
+ * ]
4939
+ * });
4940
+ */
4941
+ GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
3841
4942
  /**
3842
4943
  * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
3843
4944
  * the user accounts, available as "_id" from the Twitch API methods (ex:
3844
4945
  * 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>;
4946
+ *
4947
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids Microsoft Documentation}
4948
+ * @example
4949
+ * await clientClient.GetPlayFabIDsFromTwitchIDs({
4950
+ * "TwitchIds": [
4951
+ * "127168541",
4952
+ * "88315720"
4953
+ * ]
4954
+ * });
4955
+ */
4956
+ GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
3848
4957
  /**
3849
4958
  * 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>;
4959
+ *
4960
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids Microsoft Documentation}
4961
+ * @example
4962
+ * await clientClient.GetPlayFabIDsFromXboxLiveIDs({
4963
+ * "XboxLiveAccountIDs": [
4964
+ * "857498576495",
4965
+ * "759374651209"
4966
+ * ],
4967
+ * "Sandbox": "RETAIL"
4968
+ * });
4969
+ */
4970
+ GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
3853
4971
  /**
3854
4972
  * 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>;
4973
+ *
4974
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata Microsoft Documentation}
4975
+ * @example
4976
+ * await clientClient.GetPublisherData({
4977
+ * "Keys": [
4978
+ * "color",
4979
+ * "propertyA"
4980
+ * ]
4981
+ * });
4982
+ */
4983
+ GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
3858
4984
  /**
3859
4985
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3860
4986
  * version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
3861
4987
  * are still active.
3862
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
4988
+ *
4989
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase Microsoft Documentation}
4990
+ * @example
4991
+ * await clientClient.GetPurchase({
4992
+ * "OrderId": "8853591446005860822"
4993
+ * });
3863
4994
  */
3864
- GetPurchase(request: GetPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetPurchaseResult>;
4995
+ GetPurchase(request: GetPurchaseRequest, extraHeaders?: Record<string, string>): Promise<GetPurchaseResult>;
3865
4996
  /**
3866
4997
  * Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group
3867
4998
  * may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
3868
4999
  * Shared Groups are designed for sharing data between a very small number of players, please see our guide:
3869
5000
  * 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>;
5001
+ *
5002
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata Microsoft Documentation}
5003
+ * @example
5004
+ * await clientClient.GetSharedGroupData({
5005
+ * "SharedGroupId": "Clan Data",
5006
+ * "Keys": [
5007
+ * "ClanKills",
5008
+ * "LastClanUpdate"
5009
+ * ],
5010
+ * "GetMembers": true
5011
+ * });
5012
+ */
5013
+ GetSharedGroupData(request: GetSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
3873
5014
  /**
3874
5015
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3875
5016
  * 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
5017
+ *
5018
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems Microsoft Documentation}
5019
+ * @example
5020
+ * await clientClient.GetStoreItems({
5021
+ * "StoreId": "BonusStore"
5022
+ * });
3877
5023
  */
3878
- GetStoreItems(request: GetStoreItemsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
5024
+ GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
3879
5025
  /**
3880
5026
  * Retrieves the current server time
3881
- * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
5027
+ *
5028
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime Microsoft Documentation}
5029
+ * @example
5030
+ * await clientClient.GetTime({});
3882
5031
  */
3883
- GetTime(request: GetTimeRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
5032
+ GetTime(request: GetTimeRequest, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
3884
5033
  /**
3885
5034
  * 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>;
5035
+ *
5036
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata Microsoft Documentation}
5037
+ * @example
5038
+ * await clientClient.GetTitleData({
5039
+ * "Keys": [
5040
+ * "color",
5041
+ * "propertyA"
5042
+ * ]
5043
+ * });
5044
+ */
5045
+ GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
3889
5046
  /**
3890
5047
  * 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
5048
+ *
5049
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews Microsoft Documentation}
5050
+ * @example
5051
+ * await clientClient.GetTitleNews({
5052
+ * "Count": 25
5053
+ * });
3892
5054
  */
3893
- GetTitleNews(request: GetTitleNewsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
5055
+ GetTitleNews(request: GetTitleNewsRequest, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
3894
5056
  /**
3895
5057
  * Returns the title's base 64 encoded RSA CSP blob.
3896
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
5058
+ *
5059
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey Microsoft Documentation}
5060
+ * @example
5061
+ * await clientClient.GetTitlePublicKey({
5062
+ * "TitleId": "ID",
5063
+ * "TitleSharedSecret": "ExampleSecret"
5064
+ * });
3897
5065
  */
3898
- GetTitlePublicKey(request: GetTitlePublicKeyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetTitlePublicKeyResult>;
5066
+ GetTitlePublicKey(request: GetTitlePublicKeyRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePublicKeyResult>;
3899
5067
  /**
3900
5068
  * 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>;
5069
+ *
5070
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus Microsoft Documentation}
5071
+ * @example
5072
+ * await clientClient.GetTradeStatus({
5073
+ * "OfferingPlayerId": "CD803BF233CE76CC",
5074
+ * "TradeId": "D819CEC225EA9948C351"
5075
+ * });
5076
+ */
5077
+ GetTradeStatus(request: GetTradeStatusRequest, extraHeaders?: Record<string, string>): Promise<GetTradeStatusResponse>;
5078
+ /**
5079
+ * NOTE: This call will be deprecated soon. For fetching the data for a given user use GetPlayerCombinedInfo. For looking
5080
+ * up users from the client api, we are in the process of adding a new api call. Once that call is ready, this one will be
5081
+ * deprecated. Retrieves all requested data for a user in one unified request. By default, this API returns all data for
5082
+ * the locally signed-in user. The input parameters may be used to limit the data retrieved to any subset of the available
5083
+ * data, as well as retrieve the available data for a different user. Note that certain data, including inventory, virtual
5084
+ * currency balances, and personally identifying information, may only be retrieved for the locally signed-in user. In the
5085
+ * example below, a request is made for the account details, virtual currency balances, and specified user data for the
5086
+ * locally signed-in user.
5087
+ *
5088
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getusercombinedinfo Microsoft Documentation}
5089
+ * @deprecated Please use GetPlayerCombinedInfo instead.
5090
+ */
5091
+ GetUserCombinedInfo(request: GetUserCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetUserCombinedInfoResult>;
3904
5092
  /**
3905
5093
  * 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>;
5094
+ *
5095
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata Microsoft Documentation}
5096
+ * @example
5097
+ * await clientClient.GetUserData({
5098
+ * "Keys": [
5099
+ * "preferences",
5100
+ * "progress"
5101
+ * ]
5102
+ * });
5103
+ */
5104
+ GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3909
5105
  /**
3910
5106
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
3911
5107
  * version 2._ Retrieves the user's current inventory of virtual goods
3912
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
5108
+ *
5109
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory Microsoft Documentation}
5110
+ * @example
5111
+ * await clientClient.GetUserInventory({});
3913
5112
  */
3914
- GetUserInventory(request: GetUserInventoryRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
5113
+ GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
3915
5114
  /**
3916
5115
  * 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>;
5116
+ *
5117
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata Microsoft Documentation}
5118
+ * @example
5119
+ * await clientClient.GetUserPublisherData({
5120
+ * "Keys": [
5121
+ * "preferences",
5122
+ * "progress"
5123
+ * ]
5124
+ * });
5125
+ */
5126
+ GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3920
5127
  /**
3921
5128
  * 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>;
5129
+ *
5130
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
5131
+ * @example
5132
+ * await clientClient.GetUserPublisherReadOnlyData({
5133
+ * "Keys": [
5134
+ * "preferences",
5135
+ * "progress"
5136
+ * ]
5137
+ * });
5138
+ */
5139
+ GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
3925
5140
  /**
3926
5141
  * 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
5142
+ *
5143
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata Microsoft Documentation}
5144
+ * @example
5145
+ * await clientClient.GetUserReadOnlyData({
5146
+ * "Keys": [
5147
+ * "preferences",
5148
+ * "progress"
5149
+ * ]
5150
+ * });
5151
+ */
5152
+ GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
5153
+ /**
5154
+ * Retrieves the details of all title-specific statistics for the user
5155
+ *
5156
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserstatistics Microsoft Documentation}
5157
+ * @deprecated Please use GetPlayerStatistics instead.
3928
5158
  */
3929
- GetUserReadOnlyData(request: GetUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
5159
+ GetUserStatistics(request: GetUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetUserStatisticsResult>;
3930
5160
  /**
3931
5161
  * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
3932
5162
  * with the parent PlayFabId to guarantee uniqueness.
3933
- * https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
5163
+ *
5164
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser Microsoft Documentation}
5165
+ * @example
5166
+ * await clientClient.GrantCharacterToUser({
5167
+ * "CatalogVersion": "2.2",
5168
+ * "ItemId": "Blue Warrior",
5169
+ * "CharacterName": "FighterDude"
5170
+ * });
3934
5171
  */
3935
- GrantCharacterToUser(request: GrantCharacterToUserRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
5172
+ GrantCharacterToUser(request: GrantCharacterToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
3936
5173
  /**
3937
5174
  * Links the Android device identifier to the user's PlayFab account
3938
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
5175
+ *
5176
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid Microsoft Documentation}
5177
+ * @example
5178
+ * await clientClient.LinkAndroidDeviceID({
5179
+ * "AndroidDeviceId": "526f79204261747479",
5180
+ * "OS": "5.0",
5181
+ * "AndroidDevice": "Nexus 6"
5182
+ * });
3939
5183
  */
3940
- LinkAndroidDeviceID(request: LinkAndroidDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkAndroidDeviceIDResult>;
5184
+ LinkAndroidDeviceID(request: LinkAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LinkAndroidDeviceIDResult>;
3941
5185
  /**
3942
5186
  * 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
5187
+ *
5188
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple Microsoft Documentation}
5189
+ * @example
5190
+ * await clientClient.LinkApple({
5191
+ * "IdentityToken": "eyJraWQi..."
5192
+ * });
3944
5193
  */
3945
- LinkApple(request: LinkAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
5194
+ LinkApple(request: LinkAppleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
3946
5195
  /**
3947
5196
  * 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
5197
+ *
5198
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount Microsoft Documentation}
5199
+ * @example
5200
+ * await clientClient.LinkBattleNetAccount({
5201
+ * "IdentityToken": "eyJraWQi..."
5202
+ * });
3949
5203
  */
3950
- LinkBattleNetAccount(request: LinkBattleNetAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
5204
+ LinkBattleNetAccount(request: LinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
3951
5205
  /**
3952
5206
  * 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
5207
+ *
5208
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid Microsoft Documentation}
5209
+ * @example
5210
+ * await clientClient.LinkCustomID({
5211
+ * "CustomId": "67AB-5397-CC54-EA31"
5212
+ * });
3954
5213
  */
3955
- LinkCustomID(request: LinkCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkCustomIDResult>;
5214
+ LinkCustomID(request: LinkCustomIDRequest, extraHeaders?: Record<string, string>): Promise<LinkCustomIDResult>;
3956
5215
  /**
3957
5216
  * 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
5217
+ *
5218
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount Microsoft Documentation}
5219
+ * @example
5220
+ * await clientClient.LinkFacebookAccount({
5221
+ * "AccessToken": "FaceAccessTokenID"
5222
+ * });
3959
5223
  */
3960
- LinkFacebookAccount(request: LinkFacebookAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkFacebookAccountResult>;
5224
+ LinkFacebookAccount(request: LinkFacebookAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkFacebookAccountResult>;
3961
5225
  /**
3962
5226
  * Links the Facebook Instant Games Id to the user's PlayFab account
3963
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
5227
+ *
5228
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid Microsoft Documentation}
5229
+ * @example
5230
+ * await clientClient.LinkFacebookInstantGamesId({
5231
+ * "FacebookInstantGamesSignature": "abcdef"
5232
+ * });
3964
5233
  */
3965
- LinkFacebookInstantGamesId(request: LinkFacebookInstantGamesIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkFacebookInstantGamesIdResult>;
5234
+ LinkFacebookInstantGamesId(request: LinkFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<LinkFacebookInstantGamesIdResult>;
3966
5235
  /**
3967
5236
  * Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with
3968
5237
  * a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
3969
5238
  * in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
3970
5239
  * 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
5240
+ *
5241
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount Microsoft Documentation}
5242
+ * @example
5243
+ * await clientClient.LinkGameCenterAccount({
5244
+ * "GameCenterId": "2998h2998f0b000d0993"
5245
+ * });
3972
5246
  */
3973
- LinkGameCenterAccount(request: LinkGameCenterAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkGameCenterAccountResult>;
5247
+ LinkGameCenterAccount(request: LinkGameCenterAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGameCenterAccountResult>;
3974
5248
  /**
3975
5249
  * 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
5250
+ *
5251
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount Microsoft Documentation}
5252
+ * @example
5253
+ * await clientClient.LinkGoogleAccount({
5254
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#"
5255
+ * });
3977
5256
  */
3978
- LinkGoogleAccount(request: LinkGoogleAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkGoogleAccountResult>;
5257
+ LinkGoogleAccount(request: LinkGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGoogleAccountResult>;
3979
5258
  /**
3980
5259
  * Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
3981
5260
  * credentials
3982
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
5261
+ *
5262
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount Microsoft Documentation}
5263
+ * @example
5264
+ * await clientClient.LinkGooglePlayGamesServicesAccount({
5265
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#"
5266
+ * });
3983
5267
  */
3984
- LinkGooglePlayGamesServicesAccount(request: LinkGooglePlayGamesServicesAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkGooglePlayGamesServicesAccountResult>;
5268
+ LinkGooglePlayGamesServicesAccount(request: LinkGooglePlayGamesServicesAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGooglePlayGamesServicesAccountResult>;
3985
5269
  /**
3986
5270
  * 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
5271
+ *
5272
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid Microsoft Documentation}
5273
+ * @example
5274
+ * await clientClient.LinkIOSDeviceID({
5275
+ * "DeviceId": "29848d9bh8900a0b003",
5276
+ * "OS": "7.11",
5277
+ * "DeviceModel": "Iphone 5s"
5278
+ * });
3988
5279
  */
3989
- LinkIOSDeviceID(request: LinkIOSDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkIOSDeviceIDResult>;
5280
+ LinkIOSDeviceID(request: LinkIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LinkIOSDeviceIDResult>;
3990
5281
  /**
3991
5282
  * Links the Kongregate identifier to the user's PlayFab account
3992
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
5283
+ *
5284
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate Microsoft Documentation}
5285
+ * @example
5286
+ * await clientClient.LinkKongregate({
5287
+ * "KongregateId": "457332",
5288
+ * "AuthTicket": "{123-456-78931212}"
5289
+ * });
3993
5290
  */
3994
- LinkKongregate(request: LinkKongregateAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkKongregateAccountResult>;
5291
+ LinkKongregate(request: LinkKongregateAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkKongregateAccountResult>;
3995
5292
  /**
3996
5293
  * 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
5294
+ *
5295
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount Microsoft Documentation}
5296
+ * @example
5297
+ * await clientClient.LinkNintendoServiceAccount({
5298
+ * "IdentityToken": "eyJraWQi..."
5299
+ * });
3998
5300
  */
3999
- LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
5301
+ LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
4000
5302
  /**
4001
5303
  * Links the NintendoSwitchDeviceId to the user's PlayFab account
4002
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
5304
+ *
5305
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid Microsoft Documentation}
5306
+ * @example
5307
+ * await clientClient.LinkNintendoSwitchDeviceId({
5308
+ * "NintendoSwitchDeviceId": "526f79204261747479"
5309
+ * });
4003
5310
  */
4004
- LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
5311
+ LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
4005
5312
  /**
4006
5313
  * Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
4007
5314
  * Open ID Connect provider and the OpenId Connect JWT from that provider.
4008
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
5315
+ *
5316
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect Microsoft Documentation}
5317
+ * @example
5318
+ * await clientClient.LinkOpenIdConnect({
5319
+ * "ConnectionId": "exampleprovider",
5320
+ * "IdToken": "eyJraWQi..."
5321
+ * });
4009
5322
  */
4010
- LinkOpenIdConnect(request: LinkOpenIdConnectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
5323
+ LinkOpenIdConnect(request: LinkOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
4011
5324
  /**
4012
5325
  * 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
5326
+ *
5327
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount Microsoft Documentation}
5328
+ * @example
5329
+ * await clientClient.LinkPSNAccount({
5330
+ * "AuthCode": "LKJDG7DDE",
5331
+ * "RedirectUri": "orbis://games"
5332
+ * });
4014
5333
  */
4015
- LinkPSNAccount(request: LinkPSNAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
5334
+ LinkPSNAccount(request: LinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
4016
5335
  /**
4017
5336
  * 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
5337
+ *
5338
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount Microsoft Documentation}
5339
+ * @example
5340
+ * await clientClient.LinkSteamAccount({
5341
+ * "SteamTicket": "steamTicketID",
5342
+ * "TicketIsServiceSpecific": true
5343
+ * });
4019
5344
  */
4020
- LinkSteamAccount(request: LinkSteamAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkSteamAccountResult>;
5345
+ LinkSteamAccount(request: LinkSteamAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkSteamAccountResult>;
4021
5346
  /**
4022
5347
  * 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
5348
+ *
5349
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch Microsoft Documentation}
5350
+ * @example
5351
+ * await clientClient.LinkTwitch({
5352
+ * "AccessToken": "TwitchAccessToken"
5353
+ * });
4024
5354
  */
4025
- LinkTwitch(request: LinkTwitchAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkTwitchAccountResult>;
5355
+ LinkTwitch(request: LinkTwitchAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkTwitchAccountResult>;
4026
5356
  /**
4027
5357
  * 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
5358
+ *
5359
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount Microsoft Documentation}
5360
+ * @example
5361
+ * await clientClient.LinkXboxAccount({
5362
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad"
5363
+ * });
4029
5364
  */
4030
- LinkXboxAccount(request: LinkXboxAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
5365
+ LinkXboxAccount(request: LinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
4031
5366
  /**
4032
5367
  * Retrieves title-specific custom property values for a player.
4033
- * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
5368
+ *
5369
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties Microsoft Documentation}
5370
+ * @example
5371
+ * await clientClient.ListPlayerCustomProperties({});
5372
+ */
5373
+ ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
5374
+ /**
5375
+ * Logs a custom analytics event
5376
+ *
5377
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/logevent Microsoft Documentation}
5378
+ * @deprecated Please use WritePlayerEvent instead.
4034
5379
  */
4035
- ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
5380
+ LogEvent(request: LogEventRequest, extraHeaders?: Record<string, string>): Promise<LogEventResult>;
4036
5381
  /**
4037
5382
  * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
4038
5383
  * 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>;
5384
+ *
5385
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid Microsoft Documentation}
5386
+ * @example
5387
+ * await clientClient.LoginWithAndroidDeviceID({
5388
+ * "AndroidDeviceId": "526f79204261747479",
5389
+ * "OS": "5.0",
5390
+ * "AndroidDevice": "Nexus 6",
5391
+ * "CreateAccount": false,
5392
+ * "TitleId": "144"
5393
+ * });
5394
+ */
5395
+ LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4042
5396
  /**
4043
5397
  * Signs in the user with a Sign in with Apple identity token.
4044
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
5398
+ *
5399
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple Microsoft Documentation}
5400
+ * @example
5401
+ * await clientClient.LoginWithApple({
5402
+ * "IdentityToken": "eyJraWQi...",
5403
+ * "TitleId": "144"
5404
+ * });
4045
5405
  */
4046
- LoginWithApple(request: LoginWithAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5406
+ LoginWithApple(request: LoginWithAppleRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4047
5407
  /**
4048
5408
  * Sign in the user with a Battle.net identity token
4049
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet
5409
+ *
5410
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet Microsoft Documentation}
5411
+ * @example
5412
+ * await clientClient.LoginWithBattleNet({
5413
+ * "IdentityToken": "eyJraWQi...",
5414
+ * "TitleId": "144"
5415
+ * });
4050
5416
  */
4051
- LoginWithBattleNet(request: LoginWithBattleNetRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5417
+ LoginWithBattleNet(request: LoginWithBattleNetRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4052
5418
  /**
4053
5419
  * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
4054
5420
  * subsequently be used for API calls which require an authenticated user
4055
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
5421
+ *
5422
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid Microsoft Documentation}
5423
+ * @example
5424
+ * await clientClient.LoginWithCustomID({
5425
+ * "CustomId": "67AB-5397-CC54-EA31",
5426
+ * "CreateAccount": false,
5427
+ * "TitleId": "144"
5428
+ * });
4056
5429
  */
4057
- LoginWithCustomID(request: LoginWithCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5430
+ LoginWithCustomID(request: LoginWithCustomIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4058
5431
  /**
4059
5432
  * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
4060
5433
  * which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
4061
5434
  * creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
4062
5435
  * RegisterPlayFabUser.
4063
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
5436
+ *
5437
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress Microsoft Documentation}
5438
+ * @example
5439
+ * await clientClient.LoginWithEmailAddress({
5440
+ * "Email": "theuser@domain.com",
5441
+ * "Password": "thepassword",
5442
+ * "TitleId": "144"
5443
+ * });
4064
5444
  */
4065
- LoginWithEmailAddress(request: LoginWithEmailAddressRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5445
+ LoginWithEmailAddress(request: LoginWithEmailAddressRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4066
5446
  /**
4067
5447
  * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
4068
5448
  * calls which require an authenticated user
4069
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook
5449
+ *
5450
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook Microsoft Documentation}
5451
+ * @example
5452
+ * await clientClient.LoginWithFacebook({
5453
+ * "AccessToken": "FaceAccessTokenID",
5454
+ * "CreateAccount": false,
5455
+ * "TitleId": "144"
5456
+ * });
4070
5457
  */
4071
- LoginWithFacebook(request: LoginWithFacebookRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5458
+ LoginWithFacebook(request: LoginWithFacebookRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4072
5459
  /**
4073
5460
  * Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
4074
5461
  * 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
5462
+ *
5463
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid Microsoft Documentation}
5464
+ * @example
5465
+ * await clientClient.LoginWithFacebookInstantGamesId({
5466
+ * "FacebookInstantGamesSignature": "abcdef",
5467
+ * "CreateAccount": false,
5468
+ * "TitleId": "144"
5469
+ * });
4076
5470
  */
4077
- LoginWithFacebookInstantGamesId(request: LoginWithFacebookInstantGamesIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5471
+ LoginWithFacebookInstantGamesId(request: LoginWithFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4078
5472
  /**
4079
5473
  * Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be
4080
5474
  * used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not
4081
5475
  * include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you
4082
5476
  * require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and
4083
5477
  * enabling the 'Require secure authentication only for this app' option.
4084
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter
5478
+ *
5479
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter Microsoft Documentation}
5480
+ * @example
5481
+ * await clientClient.LoginWithGameCenter({
5482
+ * "PlayerId": "pachycephalosaurus01",
5483
+ * "CreateAccount": false,
5484
+ * "TitleId": "144"
5485
+ * });
4085
5486
  */
4086
- LoginWithGameCenter(request: LoginWithGameCenterRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5487
+ LoginWithGameCenter(request: LoginWithGameCenterRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4087
5488
  /**
4088
5489
  * 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>;
5490
+ *
5491
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount Microsoft Documentation}
5492
+ * @example
5493
+ * await clientClient.LoginWithGoogleAccount({
5494
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#",
5495
+ * "CreateAccount": false,
5496
+ * "SetEmail": true,
5497
+ * "TitleId": "144"
5498
+ * });
5499
+ */
5500
+ LoginWithGoogleAccount(request: LoginWithGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4092
5501
  /**
4093
5502
  * Signs the user in using their Google Play Games account credentials
4094
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices
5503
+ *
5504
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices Microsoft Documentation}
5505
+ * @example
5506
+ * await clientClient.LoginWithGooglePlayGamesServices({
5507
+ * "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#",
5508
+ * "CreateAccount": false,
5509
+ * "TitleId": "144"
5510
+ * });
4095
5511
  */
4096
- LoginWithGooglePlayGamesServices(request: LoginWithGooglePlayGamesServicesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5512
+ LoginWithGooglePlayGamesServices(request: LoginWithGooglePlayGamesServicesRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4097
5513
  /**
4098
5514
  * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
4099
5515
  * 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>;
5516
+ *
5517
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid Microsoft Documentation}
5518
+ * @example
5519
+ * await clientClient.LoginWithIOSDeviceID({
5520
+ * "DeviceId": "29848d9bh8900a0b003",
5521
+ * "OS": "7.11",
5522
+ * "DeviceModel": "Iphone 5s",
5523
+ * "CreateAccount": false,
5524
+ * "TitleId": "144"
5525
+ * });
5526
+ */
5527
+ LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4103
5528
  /**
4104
5529
  * 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>;
5530
+ *
5531
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate Microsoft Documentation}
5532
+ * @example
5533
+ * await clientClient.LoginWithKongregate({
5534
+ * "KongregateId": "457332",
5535
+ * "AuthTicket": "SomeKongregateTokenHere",
5536
+ * "CreateAccount": false,
5537
+ * "TitleId": "144"
5538
+ * });
5539
+ */
5540
+ LoginWithKongregate(request: LoginWithKongregateRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4108
5541
  /**
4109
5542
  * Signs in the user with a Nintendo service account token.
4110
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount
5543
+ *
5544
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount Microsoft Documentation}
5545
+ * @example
5546
+ * await clientClient.LoginWithNintendoServiceAccount({
5547
+ * "IdentityToken": "eyJraWQi...",
5548
+ * "TitleId": "144"
5549
+ * });
4111
5550
  */
4112
- LoginWithNintendoServiceAccount(request: LoginWithNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5551
+ LoginWithNintendoServiceAccount(request: LoginWithNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4113
5552
  /**
4114
5553
  * Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
4115
5554
  * API calls which require an authenticated user
4116
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid
5555
+ *
5556
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid Microsoft Documentation}
5557
+ * @example
5558
+ * await clientClient.LoginWithNintendoSwitchDeviceId({
5559
+ * "NintendoSwitchDeviceId": "526f79204261747479",
5560
+ * "CreateAccount": false,
5561
+ * "TitleId": "144"
5562
+ * });
4117
5563
  */
4118
- LoginWithNintendoSwitchDeviceId(request: LoginWithNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5564
+ LoginWithNintendoSwitchDeviceId(request: LoginWithNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4119
5565
  /**
4120
5566
  * Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
4121
5567
  * provider.
4122
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect
5568
+ *
5569
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect Microsoft Documentation}
5570
+ * @example
5571
+ * await clientClient.LoginWithOpenIdConnect({
5572
+ * "ConnectionId": "exampleprovider",
5573
+ * "IdToken": "eyJraWQi...",
5574
+ * "TitleId": "144"
5575
+ * });
4123
5576
  */
4124
- LoginWithOpenIdConnect(request: LoginWithOpenIdConnectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5577
+ LoginWithOpenIdConnect(request: LoginWithOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4125
5578
  /**
4126
5579
  * Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls
4127
5580
  * which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
4128
5581
  * new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via
4129
5582
  * RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
4130
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab
5583
+ *
5584
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab Microsoft Documentation}
5585
+ * @example
5586
+ * await clientClient.LoginWithPlayFab({
5587
+ * "Username": "theuser",
5588
+ * "Password": "ExampleSecret",
5589
+ * "TitleId": "144"
5590
+ * });
4131
5591
  */
4132
- LoginWithPlayFab(request: LoginWithPlayFabRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5592
+ LoginWithPlayFab(request: LoginWithPlayFabRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4133
5593
  /**
4134
5594
  * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
4135
5595
  * 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>;
5596
+ *
5597
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn Microsoft Documentation}
5598
+ * @example
5599
+ * await clientClient.LoginWithPSN({
5600
+ * "AuthCode": "LKJ6D896D",
5601
+ * "RedirectUri": "orbis://games",
5602
+ * "CreateAccount": false,
5603
+ * "TitleId": "144"
5604
+ * });
5605
+ */
5606
+ LoginWithPSN(request: LoginWithPSNRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4139
5607
  /**
4140
5608
  * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
4141
5609
  * 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>;
5610
+ *
5611
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam Microsoft Documentation}
5612
+ * @example
5613
+ * await clientClient.LoginWithSteam({
5614
+ * "SteamTicket": "steamTicketID",
5615
+ * "CreateAccount": false,
5616
+ * "TicketIsServiceSpecific": true,
5617
+ * "TitleId": "144"
5618
+ * });
5619
+ */
5620
+ LoginWithSteam(request: LoginWithSteamRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4145
5621
  /**
4146
5622
  * Signs the user in using a Twitch access token.
4147
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch
5623
+ *
5624
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch Microsoft Documentation}
5625
+ * @example
5626
+ * await clientClient.LoginWithTwitch({
5627
+ * "AccessToken": "SomeTwitchTokenHere",
5628
+ * "CreateAccount": false,
5629
+ * "TitleId": "144"
5630
+ * });
4148
5631
  */
4149
- LoginWithTwitch(request: LoginWithTwitchRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5632
+ LoginWithTwitch(request: LoginWithTwitchRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
4150
5633
  /**
4151
5634
  * Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
4152
5635
  * 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>;
5636
+ *
5637
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox Microsoft Documentation}
5638
+ * @example
5639
+ * await clientClient.LoginWithXbox({
5640
+ * "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
5641
+ * "CreateAccount": false,
5642
+ * "TitleId": "144"
5643
+ * });
5644
+ */
5645
+ LoginWithXbox(request: LoginWithXboxRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
5646
+ /**
5647
+ * Attempts to locate a game session matching the given parameters. If the goal is to match the player into a specific
5648
+ * active session, only the LobbyId is required. Otherwise, the BuildVersion, GameMode, and Region are all required
5649
+ * parameters. Note that parameters specified in the search are required (they are not weighting factors). If a slot is
5650
+ * found in a server instance matching the parameters, the slot will be assigned to that player, removing it from the
5651
+ * availabe set. In that case, the information on the game session will be returned, otherwise the Status returned will be
5652
+ * GameNotFound.
5653
+ *
5654
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/matchmake Microsoft Documentation}
5655
+ * @deprecated Please use Match/CreateMatchmakingTicket instead.
5656
+ */
5657
+ Matchmake(request: MatchmakeRequest, extraHeaders?: Record<string, string>): Promise<MatchmakeResult>;
4156
5658
  /**
4157
5659
  * 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>;
5660
+ *
5661
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade Microsoft Documentation}
5662
+ * @example
5663
+ * await clientClient.OpenTrade({
5664
+ * "OfferedInventoryInstanceIds": [
5665
+ * "1359447",
5666
+ * "635691"
5667
+ * ],
5668
+ * "RequestedCatalogItemIds": [
5669
+ * "rare_hat_7"
5670
+ * ]
5671
+ * });
5672
+ */
5673
+ OpenTrade(request: OpenTradeRequest, extraHeaders?: Record<string, string>): Promise<OpenTradeResponse>;
4161
5674
  /**
4162
5675
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4163
5676
  * 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
5677
+ *
5678
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase Microsoft Documentation}
5679
+ * @example
5680
+ * await clientClient.PayForPurchase({
5681
+ * "OrderId": "8853591446005860822",
5682
+ * "ProviderName": "PayPal",
5683
+ * "Currency": "RM"
5684
+ * });
4165
5685
  */
4166
- PayForPurchase(request: PayForPurchaseRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<PayForPurchaseResult>;
5686
+ PayForPurchase(request: PayForPurchaseRequest, extraHeaders?: Record<string, string>): Promise<PayForPurchaseResult>;
4167
5687
  /**
4168
5688
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4169
5689
  * version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
4170
5690
  * 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
5691
+ *
5692
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem Microsoft Documentation}
5693
+ * @example
5694
+ * await clientClient.PurchaseItem({
5695
+ * "ItemId": "shield_level_5",
5696
+ * "VirtualCurrency": "GV",
5697
+ * "Price": 25
5698
+ * });
4172
5699
  */
4173
- PurchaseItem(request: PurchaseItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<PurchaseItemResult>;
5700
+ PurchaseItem(request: PurchaseItemRequest, extraHeaders?: Record<string, string>): Promise<PurchaseItemResult>;
4174
5701
  /**
4175
5702
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4176
5703
  * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
4177
5704
  * Economy->Catalogs tab in the PlayFab Game Manager.
4178
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon
5705
+ *
5706
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon Microsoft Documentation}
5707
+ * @example
5708
+ * await clientClient.RedeemCoupon({
5709
+ * "CouponCode": "123-1234-123",
5710
+ * "CatalogVersion": "5"
5711
+ * });
4179
5712
  */
4180
- RedeemCoupon(request: RedeemCouponRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
5713
+ RedeemCoupon(request: RedeemCouponRequest, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
4181
5714
  /**
4182
5715
  * 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
5716
+ *
5717
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken Microsoft Documentation}
5718
+ * @example
5719
+ * await clientClient.RefreshPSNAuthToken({
5720
+ * "AuthCode": "LKJDG7DDE",
5721
+ * "RedirectUri": "orbis://games"
5722
+ * });
4184
5723
  */
4185
- RefreshPSNAuthToken(request: RefreshPSNAuthTokenRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
5724
+ RefreshPSNAuthToken(request: RefreshPSNAuthTokenRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4186
5725
  /**
4187
5726
  * Registers the iOS device to receive push notifications
4188
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification
5727
+ *
5728
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification Microsoft Documentation}
5729
+ * @example
5730
+ * await clientClient.RegisterForIOSPushNotification({
5731
+ * "DeviceToken": "39872f98eb882brn8hg3889",
5732
+ * "SendPushNotificationConfirmation": true,
5733
+ * "ConfirmationMessage": "Welcome to PlayFab"
5734
+ * });
4189
5735
  */
4190
- RegisterForIOSPushNotification(request: RegisterForIOSPushNotificationRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RegisterForIOSPushNotificationResult>;
5736
+ RegisterForIOSPushNotification(request: RegisterForIOSPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<RegisterForIOSPushNotificationResult>;
4191
5737
  /**
4192
5738
  * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
4193
5739
  * 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>;
5740
+ *
5741
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser Microsoft Documentation}
5742
+ * @example
5743
+ * await clientClient.RegisterPlayFabUser({
5744
+ * "Username": "theuser",
5745
+ * "Email": "me@here.com",
5746
+ * "Password": "ExampleSecret",
5747
+ * "TitleId": "1"
5748
+ * });
5749
+ */
5750
+ RegisterPlayFabUser(request: RegisterPlayFabUserRequest, extraHeaders?: Record<string, string>): Promise<RegisterPlayFabUserResult>;
4197
5751
  /**
4198
5752
  * Removes a contact email from the player's profile.
4199
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail
5753
+ *
5754
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail Microsoft Documentation}
5755
+ * @example
5756
+ * await clientClient.RemoveContactEmail({});
4200
5757
  */
4201
- RemoveContactEmail(request: RemoveContactEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveContactEmailResult>;
5758
+ RemoveContactEmail(request: RemoveContactEmailRequest, extraHeaders?: Record<string, string>): Promise<RemoveContactEmailResult>;
4202
5759
  /**
4203
5760
  * 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
5761
+ *
5762
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend Microsoft Documentation}
5763
+ * @example
5764
+ * await clientClient.RemoveFriend({
5765
+ * "FriendPlayFabId": "29837799"
5766
+ * });
4205
5767
  */
4206
- RemoveFriend(request: RemoveFriendRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RemoveFriendResult>;
5768
+ RemoveFriend(request: RemoveFriendRequest, extraHeaders?: Record<string, string>): Promise<RemoveFriendResult>;
4207
5769
  /**
4208
5770
  * 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>;
5771
+ *
5772
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid Microsoft Documentation}
5773
+ * @example
5774
+ * await clientClient.RemoveGenericID({
5775
+ * "GenericId": {
5776
+ * "ServiceName": "BigBizSocial",
5777
+ * "UserId": "1234567890"
5778
+ * }
5779
+ * });
5780
+ */
5781
+ RemoveGenericID(request: RemoveGenericIDRequest, extraHeaders?: Record<string, string>): Promise<RemoveGenericIDResult>;
4212
5782
  /**
4213
5783
  * 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
5784
  * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
4215
5785
  * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
4216
5786
  * 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>;
5787
+ *
5788
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers Microsoft Documentation}
5789
+ * @example
5790
+ * await clientClient.RemoveSharedGroupMembers({
5791
+ * "SharedGroupId": "Clan Data",
5792
+ * "PlayFabIds": [
5793
+ * "D984A64B832",
5794
+ * "F74A523E1562"
5795
+ * ]
5796
+ * });
5797
+ */
5798
+ RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
4220
5799
  /**
4221
5800
  * Report player's ad activity
4222
- * https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity
5801
+ *
5802
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity Microsoft Documentation}
5803
+ * @example
5804
+ * await clientClient.ReportAdActivity({
5805
+ * "PlacementId": "A124572382B",
5806
+ * "RewardId": "B2674981A",
5807
+ * "Activity": "End"
5808
+ * });
4223
5809
  */
4224
- ReportAdActivity(request: ReportAdActivityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportAdActivityResult>;
5810
+ ReportAdActivity(request: ReportAdActivityRequest, extraHeaders?: Record<string, string>): Promise<ReportAdActivityResult>;
4225
5811
  /**
4226
5812
  * Write a PlayStream event to describe the provided player device information. This API method is not designed to be
4227
5813
  * 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>;
5814
+ *
5815
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo Microsoft Documentation}
5816
+ * @example
5817
+ * await clientClient.ReportDeviceInfo({
5818
+ * "Info": {
5819
+ * "UserAgent": "Some Browser",
5820
+ * "ScreenResolution": "640x480",
5821
+ * "processorCount": "2"
5822
+ * }
5823
+ * });
5824
+ */
5825
+ ReportDeviceInfo(request: DeviceInfoRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4231
5826
  /**
4232
5827
  * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
4233
5828
  * can take action concerning potentially toxic players.
4234
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer
5829
+ *
5830
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer Microsoft Documentation}
5831
+ * @example
5832
+ * await clientClient.ReportPlayer({
5833
+ * "ReporteeId": "1a46086aed40f142",
5834
+ * "Comment": "cheating"
5835
+ * });
4235
5836
  */
4236
- ReportPlayer(request: ReportPlayerClientRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ReportPlayerClientResult>;
5837
+ ReportPlayer(request: ReportPlayerClientRequest, extraHeaders?: Record<string, string>): Promise<ReportPlayerClientResult>;
4237
5838
  /**
4238
5839
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4239
5840
  * 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
5841
+ *
5842
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases Microsoft Documentation}
5843
+ * @example
5844
+ * await clientClient.RestoreIOSPurchases({
5845
+ * "ReceiptData": "F00000000000000000000"
5846
+ * });
4241
5847
  */
4242
- RestoreIOSPurchases(request: RestoreIOSPurchasesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<RestoreIOSPurchasesResult>;
5848
+ RestoreIOSPurchases(request: RestoreIOSPurchasesRequest, extraHeaders?: Record<string, string>): Promise<RestoreIOSPurchasesResult>;
4243
5849
  /**
4244
5850
  * 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>;
5851
+ *
5852
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity Microsoft Documentation}
5853
+ * @example
5854
+ * await clientClient.RewardAdActivity({
5855
+ * "PlacementId": "A124572382B",
5856
+ * "RewardId": "B2674981A"
5857
+ * });
5858
+ */
5859
+ RewardAdActivity(request: RewardAdActivityRequest, extraHeaders?: Record<string, string>): Promise<RewardAdActivityResult>;
5860
+ /**
5861
+ * Triggers a particular server action, passing the provided inputs to the hosted Cloud Script. An action in this context
5862
+ * is a handler in the JavaScript. NOTE: Before calling this API, you must call GetCloudScriptUrl to be assigned a Cloud
5863
+ * Script server URL. When using an official PlayFab SDK, this URL is stored internally in the SDK, but GetCloudScriptUrl
5864
+ * must still be manually called.
5865
+ *
5866
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/runcloudscript Microsoft Documentation}
5867
+ * @deprecated Please use ExecuteCloudScript instead.
5868
+ */
5869
+ RunCloudScript(request: RunCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<RunCloudScriptResult>;
4248
5870
  /**
4249
5871
  * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
4250
5872
  * change the password.If an account recovery email template ID is provided, an email using the custom email template will
4251
5873
  * be used.
4252
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail
5874
+ *
5875
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail Microsoft Documentation}
5876
+ * @example
5877
+ * await clientClient.SendAccountRecoveryEmail({
5878
+ * "Email": "Me@here.com",
5879
+ * "TitleId": "1000",
5880
+ * "EmailTemplateId": "D53AB15D8F12E330"
5881
+ * });
4253
5882
  */
4254
- SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
5883
+ SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
4255
5884
  /**
4256
5885
  * 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>;
5886
+ *
5887
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags Microsoft Documentation}
5888
+ * @example
5889
+ * await clientClient.SetFriendTags({
5890
+ * "FriendPlayFabId": "29837799",
5891
+ * "Tags": [
5892
+ * "great sniper",
5893
+ * "no good at melee"
5894
+ * ]
5895
+ * });
5896
+ */
5897
+ SetFriendTags(request: SetFriendTagsRequest, extraHeaders?: Record<string, string>): Promise<SetFriendTagsResult>;
4260
5898
  /**
4261
5899
  * 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
5900
  * secret use the Admin or Server API method SetPlayerSecret.
4263
- * https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret
5901
+ *
5902
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret Microsoft Documentation}
5903
+ * @example
5904
+ * await clientClient.SetPlayerSecret({
5905
+ * "PlayerSecret": "A cryptographically strong string"
5906
+ * });
5907
+ */
5908
+ SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
5909
+ /**
5910
+ * Start a new game server with a given configuration, add the current player and return the connection information.
5911
+ *
5912
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/startgame Microsoft Documentation}
5913
+ * @deprecated Do not use
4264
5914
  */
4265
- SetPlayerSecret(request: SetPlayerSecretRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
5915
+ StartGame(request: StartGameRequest, extraHeaders?: Record<string, string>): Promise<StartGameResult>;
4266
5916
  /**
4267
5917
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4268
5918
  * 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>;
5919
+ *
5920
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase Microsoft Documentation}
5921
+ * @example
5922
+ * await clientClient.StartPurchase({
5923
+ * "CatalogVersion": "0",
5924
+ * "StoreId": "BonusStore",
5925
+ * "Items": [
5926
+ * {
5927
+ * "ItemId": "something",
5928
+ * "Quantity": 1,
5929
+ * "Annotation": "totally buying something"
5930
+ * }
5931
+ * ]
5932
+ * });
5933
+ */
5934
+ StartPurchase(request: StartPurchaseRequest, extraHeaders?: Record<string, string>): Promise<StartPurchaseResult>;
4272
5935
  /**
4273
5936
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4274
5937
  * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
4275
5938
  * a VC balance negative with this API.
4276
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency
5939
+ *
5940
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
5941
+ * @example
5942
+ * await clientClient.SubtractUserVirtualCurrency({
5943
+ * "VirtualCurrency": "GC",
5944
+ * "Amount": 100
5945
+ * });
4277
5946
  */
4278
- SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
5947
+ SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
4279
5948
  /**
4280
5949
  * Unlinks the related Android device identifier from the user's PlayFab account
4281
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid
5950
+ *
5951
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid Microsoft Documentation}
5952
+ * @example
5953
+ * await clientClient.UnlinkAndroidDeviceID({
5954
+ * "AndroidDeviceId": "526f79204261747479"
5955
+ * });
4282
5956
  */
4283
- UnlinkAndroidDeviceID(request: UnlinkAndroidDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkAndroidDeviceIDResult>;
5957
+ UnlinkAndroidDeviceID(request: UnlinkAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkAndroidDeviceIDResult>;
4284
5958
  /**
4285
5959
  * Unlinks the related Apple account from the user's PlayFab account.
4286
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple
5960
+ *
5961
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple Microsoft Documentation}
5962
+ * @example
5963
+ * await clientClient.UnlinkApple({});
4287
5964
  */
4288
- UnlinkApple(request: UnlinkAppleRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
5965
+ UnlinkApple(request: UnlinkAppleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4289
5966
  /**
4290
5967
  * Unlinks the related Battle.net account from the user's PlayFab account.
4291
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount
5968
+ *
5969
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount Microsoft Documentation}
5970
+ * @example
5971
+ * await clientClient.UnlinkBattleNetAccount({});
4292
5972
  */
4293
- UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
5973
+ UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4294
5974
  /**
4295
5975
  * Unlinks the related custom identifier from the user's PlayFab account
4296
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid
5976
+ *
5977
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid Microsoft Documentation}
5978
+ * @example
5979
+ * await clientClient.UnlinkCustomID({
5980
+ * "CustomId": "67AB-5397-CC54-EA31"
5981
+ * });
4297
5982
  */
4298
- UnlinkCustomID(request: UnlinkCustomIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkCustomIDResult>;
5983
+ UnlinkCustomID(request: UnlinkCustomIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkCustomIDResult>;
4299
5984
  /**
4300
5985
  * Unlinks the related Facebook account from the user's PlayFab account
4301
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount
5986
+ *
5987
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount Microsoft Documentation}
5988
+ * @example
5989
+ * await clientClient.UnlinkFacebookAccount({});
4302
5990
  */
4303
- UnlinkFacebookAccount(request: UnlinkFacebookAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookAccountResult>;
5991
+ UnlinkFacebookAccount(request: UnlinkFacebookAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookAccountResult>;
4304
5992
  /**
4305
5993
  * 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
5994
+ *
5995
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid Microsoft Documentation}
5996
+ * @example
5997
+ * await clientClient.UnlinkFacebookInstantGamesId({
5998
+ * "FacebookInstantGamesId": "1114685845316173"
5999
+ * });
4307
6000
  */
4308
- UnlinkFacebookInstantGamesId(request: UnlinkFacebookInstantGamesIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookInstantGamesIdResult>;
6001
+ UnlinkFacebookInstantGamesId(request: UnlinkFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookInstantGamesIdResult>;
4309
6002
  /**
4310
6003
  * Unlinks the related Game Center account from the user's PlayFab account
4311
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount
6004
+ *
6005
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount Microsoft Documentation}
6006
+ * @example
6007
+ * await clientClient.UnlinkGameCenterAccount({});
4312
6008
  */
4313
- UnlinkGameCenterAccount(request: UnlinkGameCenterAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkGameCenterAccountResult>;
6009
+ UnlinkGameCenterAccount(request: UnlinkGameCenterAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGameCenterAccountResult>;
4314
6010
  /**
4315
6011
  * Unlinks the related Google account from the user's PlayFab account
4316
6012
  * (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
6013
+ *
6014
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount Microsoft Documentation}
6015
+ * @example
6016
+ * await clientClient.UnlinkGoogleAccount({});
4318
6017
  */
4319
- UnlinkGoogleAccount(request: UnlinkGoogleAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkGoogleAccountResult>;
6018
+ UnlinkGoogleAccount(request: UnlinkGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGoogleAccountResult>;
4320
6019
  /**
4321
6020
  * 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
6021
+ *
6022
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount Microsoft Documentation}
6023
+ * @example
6024
+ * await clientClient.UnlinkGooglePlayGamesServicesAccount({});
4323
6025
  */
4324
- UnlinkGooglePlayGamesServicesAccount(request: UnlinkGooglePlayGamesServicesAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkGooglePlayGamesServicesAccountResult>;
6026
+ UnlinkGooglePlayGamesServicesAccount(request: UnlinkGooglePlayGamesServicesAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGooglePlayGamesServicesAccountResult>;
4325
6027
  /**
4326
6028
  * Unlinks the related iOS device identifier from the user's PlayFab account
4327
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid
6029
+ *
6030
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid Microsoft Documentation}
6031
+ * @example
6032
+ * await clientClient.UnlinkIOSDeviceID({
6033
+ * "DeviceId": "29848d9bh8900a0b003"
6034
+ * });
4328
6035
  */
4329
- UnlinkIOSDeviceID(request: UnlinkIOSDeviceIDRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkIOSDeviceIDResult>;
6036
+ UnlinkIOSDeviceID(request: UnlinkIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkIOSDeviceIDResult>;
4330
6037
  /**
4331
6038
  * Unlinks the related Kongregate identifier from the user's PlayFab account
4332
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate
6039
+ *
6040
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate Microsoft Documentation}
6041
+ * @example
6042
+ * await clientClient.UnlinkKongregate({});
4333
6043
  */
4334
- UnlinkKongregate(request: UnlinkKongregateAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkKongregateAccountResult>;
6044
+ UnlinkKongregate(request: UnlinkKongregateAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkKongregateAccountResult>;
4335
6045
  /**
4336
6046
  * Unlinks the related Nintendo account from the user's PlayFab account.
4337
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount
6047
+ *
6048
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount Microsoft Documentation}
6049
+ * @example
6050
+ * await clientClient.UnlinkNintendoServiceAccount({});
4338
6051
  */
4339
- UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
6052
+ UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4340
6053
  /**
4341
6054
  * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
4342
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid
6055
+ *
6056
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid Microsoft Documentation}
6057
+ * @example
6058
+ * await clientClient.UnlinkNintendoSwitchDeviceId({
6059
+ * "NintendoSwitchDeviceId": "526f79204261747479"
6060
+ * });
4343
6061
  */
4344
- UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
6062
+ UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
4345
6063
  /**
4346
6064
  * Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
4347
6065
  * between a title and an Open ID Connect provider.
4348
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect
6066
+ *
6067
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect Microsoft Documentation}
6068
+ * @example
6069
+ * await clientClient.UnlinkOpenIdConnect({
6070
+ * "ConnectionId": "exampleprovider"
6071
+ * });
4349
6072
  */
4350
- UnlinkOpenIdConnect(request: UnlinkOpenIdConnectRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
6073
+ UnlinkOpenIdConnect(request: UnlinkOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4351
6074
  /**
4352
6075
  * 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
6076
+ *
6077
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount Microsoft Documentation}
6078
+ * @example
6079
+ * await clientClient.UnlinkPSNAccount({});
4354
6080
  */
4355
- UnlinkPSNAccount(request: UnlinkPSNAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
6081
+ UnlinkPSNAccount(request: UnlinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
4356
6082
  /**
4357
6083
  * Unlinks the related Steam account from the user's PlayFab account
4358
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount
6084
+ *
6085
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount Microsoft Documentation}
6086
+ * @example
6087
+ * await clientClient.UnlinkSteamAccount({});
4359
6088
  */
4360
- UnlinkSteamAccount(request: UnlinkSteamAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkSteamAccountResult>;
6089
+ UnlinkSteamAccount(request: UnlinkSteamAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkSteamAccountResult>;
4361
6090
  /**
4362
6091
  * Unlinks the related Twitch account from the user's PlayFab account.
4363
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch
6092
+ *
6093
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch Microsoft Documentation}
6094
+ * @example
6095
+ * await clientClient.UnlinkTwitch({});
4364
6096
  */
4365
- UnlinkTwitch(request: UnlinkTwitchAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkTwitchAccountResult>;
6097
+ UnlinkTwitch(request: UnlinkTwitchAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkTwitchAccountResult>;
4366
6098
  /**
4367
6099
  * Unlinks the related Xbox Live account from the user's PlayFab account
4368
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount
6100
+ *
6101
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount Microsoft Documentation}
6102
+ * @example
6103
+ * await clientClient.UnlinkXboxAccount({});
4369
6104
  */
4370
- UnlinkXboxAccount(request: UnlinkXboxAccountRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
6105
+ UnlinkXboxAccount(request: UnlinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
4371
6106
  /**
4372
6107
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4373
6108
  * version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
4374
6109
  * opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will
4375
6110
  * be decremented, consistent with the operation of ConsumeItem.
4376
- * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance
6111
+ *
6112
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance Microsoft Documentation}
6113
+ * @example
6114
+ * await clientClient.UnlockContainerInstance({
6115
+ * "ContainerItemInstanceId": "123456788",
6116
+ * "KeyItemInstanceId": "123456789"
6117
+ * });
4377
6118
  */
4378
- UnlockContainerInstance(request: UnlockContainerInstanceRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
6119
+ UnlockContainerInstance(request: UnlockContainerInstanceRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
4379
6120
  /**
4380
6121
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4381
6122
  * version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
4382
6123
  * using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are
4383
6124
  * 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
6125
+ *
6126
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem Microsoft Documentation}
6127
+ * @example
6128
+ * await clientClient.UnlockContainerItem({
6129
+ * "ContainerItemId": "crate block 1"
6130
+ * });
4385
6131
  */
4386
- UnlockContainerItem(request: UnlockContainerItemRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
6132
+ UnlockContainerItem(request: UnlockContainerItemRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
4387
6133
  /**
4388
6134
  * Update the avatar URL of the player
4389
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl
6135
+ *
6136
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl Microsoft Documentation}
6137
+ * @example
6138
+ * await clientClient.UpdateAvatarUrl({
6139
+ * "ImageUrl": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
6140
+ * });
4390
6141
  */
4391
- UpdateAvatarUrl(request: UpdateAvatarUrlRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
6142
+ UpdateAvatarUrl(request: UpdateAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
4392
6143
  /**
4393
6144
  * 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>;
6145
+ *
6146
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata Microsoft Documentation}
6147
+ * @example
6148
+ * await clientClient.UpdateCharacterData({
6149
+ * "CharacterId": "98765456",
6150
+ * "Data": {
6151
+ * "Class": "Fighter",
6152
+ * "Gender": "Female",
6153
+ * "Icon": "Guard 3",
6154
+ * "Theme": "Colorful"
6155
+ * },
6156
+ * "Permission": "Public"
6157
+ * });
6158
+ */
6159
+ UpdateCharacterData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
4397
6160
  /**
4398
6161
  * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
4399
6162
  * 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>;
6163
+ *
6164
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics Microsoft Documentation}
6165
+ * @example
6166
+ * await clientClient.UpdateCharacterStatistics({
6167
+ * "CharacterId": "98765432",
6168
+ * "CharacterStatistics": {
6169
+ * "Headshots": 18,
6170
+ * "Kills": 47
6171
+ * }
6172
+ * });
6173
+ */
6174
+ UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
4403
6175
  /**
4404
6176
  * 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>;
6177
+ *
6178
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties Microsoft Documentation}
6179
+ * @example
6180
+ * await clientClient.UpdatePlayerCustomProperties({
6181
+ * "Properties": [
6182
+ * {
6183
+ * "Name": "level",
6184
+ * "Value": 5
6185
+ * },
6186
+ * {
6187
+ * "Name": "created",
6188
+ * "Value": false
6189
+ * }
6190
+ * ],
6191
+ * "ExpectedPropertiesVersion": 12
6192
+ * });
6193
+ */
6194
+ UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
4408
6195
  /**
4409
6196
  * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
4410
6197
  * 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>;
6198
+ *
6199
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics Microsoft Documentation}
6200
+ * @example
6201
+ * await clientClient.UpdatePlayerStatistics({
6202
+ * "Statistics": [
6203
+ * {
6204
+ * "StatisticName": "Points",
6205
+ * "Version": 1,
6206
+ * "Value": 600
6207
+ * },
6208
+ * {
6209
+ * "StatisticName": "Wins",
6210
+ * "Version": 0,
6211
+ * "Value": 16
6212
+ * },
6213
+ * {
6214
+ * "StatisticName": "Stars",
6215
+ * "Value": 7
6216
+ * }
6217
+ * ]
6218
+ * });
6219
+ */
6220
+ UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
4414
6221
  /**
4415
6222
  * Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated
4416
6223
  * or added in this call will be readable by users not in the group. By default, data permissions are set to Private.
4417
6224
  * Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for
4418
6225
  * sharing data between a very small number of players, please see our guide:
4419
6226
  * 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>;
6227
+ *
6228
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata Microsoft Documentation}
6229
+ * @example
6230
+ * await clientClient.UpdateSharedGroupData({
6231
+ * "SharedGroupId": "Clan Data",
6232
+ * "Data": {
6233
+ * "ClanKills": "34",
6234
+ * "LastClanUpdate": "2014-10-03T09:21:14Z"
6235
+ * },
6236
+ * "Permission": "Public"
6237
+ * });
6238
+ */
6239
+ UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
4423
6240
  /**
4424
6241
  * 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>;
6242
+ *
6243
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata Microsoft Documentation}
6244
+ * @example
6245
+ * await clientClient.UpdateUserData({
6246
+ * "Data": {
6247
+ * "Class": "Fighter",
6248
+ * "Gender": "Female",
6249
+ * "Icon": "Guard 3",
6250
+ * "Theme": "Colorful"
6251
+ * },
6252
+ * "Permission": "Public"
6253
+ * });
6254
+ */
6255
+ UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
4428
6256
  /**
4429
6257
  * 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
6258
+ *
6259
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata Microsoft Documentation}
6260
+ * @example
6261
+ * await clientClient.UpdateUserPublisherData({
6262
+ * "Data": {
6263
+ * "Class": "Fighter",
6264
+ * "Gender": "Female",
6265
+ * "Icon": "Guard 3",
6266
+ * "Theme": "Colorful"
6267
+ * },
6268
+ * "Permission": "Public"
6269
+ * });
6270
+ */
6271
+ UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
6272
+ /**
6273
+ * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
6274
+ * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
6275
+ *
6276
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserstatistics Microsoft Documentation}
6277
+ * @deprecated Please use UpdatePlayerStatistics instead.
4431
6278
  */
4432
- UpdateUserPublisherData(request: UpdateUserDataRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
6279
+ UpdateUserStatistics(request: UpdateUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserStatisticsResult>;
4433
6280
  /**
4434
6281
  * Updates the title specific display name for the user
4435
- * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname
6282
+ *
6283
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname Microsoft Documentation}
6284
+ * @example
6285
+ * await clientClient.UpdateUserTitleDisplayName({
6286
+ * "DisplayName": "User Title Name"
6287
+ * });
4436
6288
  */
4437
- UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
6289
+ UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
4438
6290
  /**
4439
6291
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4440
6292
  * version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
4441
6293
  * the purchased catalog item
4442
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt
6294
+ *
6295
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt Microsoft Documentation}
6296
+ * @example
6297
+ * await clientClient.ValidateAmazonIAPReceipt({
6298
+ * "ReceiptId": "q1YqVbJSyjH28DGPKChw9c0o8nd3vSstssQtzSkrzM8tCk43K6z0d_HOTcwwN8vxCrVV0lEqBmpJzs_VK8hJrExLTNLLTCzQK8_MSUnJTy8LSpcoWRnoKKUAFRmaGBtZmBqCCFMzpVoA",
6299
+ * "UserId": "l3HL7XppEMhrOGDgur9-ulvqomrSg6qyODKmah72lJU="
6300
+ * });
4443
6301
  */
4444
- ValidateAmazonIAPReceipt(request: ValidateAmazonReceiptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateAmazonReceiptResult>;
6302
+ ValidateAmazonIAPReceipt(request: ValidateAmazonReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateAmazonReceiptResult>;
4445
6303
  /**
4446
6304
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4447
6305
  * 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>;
6306
+ *
6307
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase Microsoft Documentation}
6308
+ * @example
6309
+ * await clientClient.ValidateGooglePlayPurchase({
6310
+ * "ReceiptJson": "{\"orderId\":\"12999763169054705758.1375794066587622\",\"packageName\":\"com.playfab.android.testbed\",\"productId\":\"com.playfab.android.permatest.consumable\",\"purchaseTime\":1410891177231,\"purchaseState\":0,\"purchaseToken\":\"eaflhokdkobkmomjadmoobgb.AO-J1OwoLkW2cqvBcPEgk6SfGceQpOHALMUFmJYeawa-GuDFtl3oKct-5D28t_KvNscFiJOFiWXIS74vJBYg-CGFJgyrdbxalKEMPzXZrg5nLomCME-jIVFAUrzcPah-_66KPImG5ftsMJKI9uzldqEF9OPcakUEmt-kWoXAsl_6-9HH0gBCwh4\"}",
6311
+ * "Signature": "ks12w0hHHpuit4xW3Fyoa5XX6TkxZ2KpEnBsLfpHHpeakYs2JgVtlLdgyLp/05Zp8oHAuKZyIAJTd2RIFXWMAUwDNUsI0JPBDMpr2oaL66Kuneg4VrGWJkJZTrvTyQoGpnTDdXfEME31iFKX6CrKHvWlAG9nwWxYatd58l83eevQ8CIrJhka/bC5ynw3j18OmFG7AcxymO37a4HkM8QjytvAYDJeOnDU9mooY7afcHIajtffdyAU9kzGWOqDByiU9IsRdkliwQoQYbuX/R5wQnMVZ+FGDDwO1mybx9B20rm7/WCBnWGy2NLsSAFI77iX8tUy/QebfBQhrVnRORi7bw==",
6312
+ * "CurrencyCode": "USD",
6313
+ * "PurchasePrice": 199
6314
+ * });
6315
+ */
6316
+ ValidateGooglePlayPurchase(request: ValidateGooglePlayPurchaseRequest, extraHeaders?: Record<string, string>): Promise<ValidateGooglePlayPurchaseResult>;
4451
6317
  /**
4452
6318
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4453
6319
  * version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
4454
6320
  * purchased catalog item
4455
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt
6321
+ *
6322
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt Microsoft Documentation}
6323
+ * @example
6324
+ * await clientClient.ValidateIOSReceipt({
6325
+ * "ReceiptData": "MTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nzc3Nw0KODgNCjk5OTk5OTk5OTk5OQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nw0KODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODgNCjkNCkFwcGxlIEluYy4gV29ybGR3aWRlIERldmVsb3BlciBSZWxhdGlvbnMgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgKG5vdCByZWFsbHkgLSBmYWtlIFBsYXlGYWIgZXhhbXBsZSwgYnV0IGNvbmdyYXRzIG9uIHRoaW5raW5nIHRvIGRlY29kZSB0aGlzISkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3Nzc3DQo4OA0KOTk5OTk5OTk5OTk5DQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3DQo4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4OA0KOQ0KQXBwbGUgSW5jLiBXb3JsZHdpZGUgRGV2ZWxvcGVyIFJlbGF0aW9ucyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAobm90IHJlYWxseSAtIGZha2UgUGxheUZhYiBleGFtcGxlLCBidXQgY29uZ3JhdHMgb24gdGhpbmtpbmcgdG8gZGVjb2RlIHRoaXMhKQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw",
6326
+ * "CurrencyCode": "GBP",
6327
+ * "PurchasePrice": 199
6328
+ * });
4456
6329
  */
4457
- ValidateIOSReceipt(request: ValidateIOSReceiptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateIOSReceiptResult>;
6330
+ ValidateIOSReceipt(request: ValidateIOSReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateIOSReceiptResult>;
4458
6331
  /**
4459
6332
  * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
4460
6333
  * version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
4461
6334
  * matches the purchased catalog item
4462
- * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt
6335
+ *
6336
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt Microsoft Documentation}
6337
+ * @example
6338
+ * await clientClient.ValidateWindowsStoreReceipt({
6339
+ * "Receipt": "<Receipt Version=\"1.0\" ReceiptDate=\"2012-08-30T23:10:05Z\" CertificateId=\"b809e47cd0110a4db043b3f73e83acd917fe1336\" ReceiptDeviceId=\"4e362949-acc3-fe3a-e71b-89893eb4f528\">\r\n <AppReceipt Id=\"8ffa256d-eca8-712a-7cf8-cbf5522df24b\" AppId=\"55428GreenlakeApps.CurrentAppSimulatorEventTest_z7q3q7z11crfr\" PurchaseDate=\"2012-06-04T23:07:24Z\" LicenseType=\"Full\" />\r\n <ProductReceipt Id=\"6bbf4366-6fb2-8be8-7947-92fd5f683530\" ProductId=\"Product1\" PurchaseDate=\"2012-08-30T23:08:52Z\" ExpirationDate=\"2012-09-02T23:08:49Z\" ProductType=\"Durable\" AppId=\"55428GreenlakeApps.CurrentAppSimulatorEventTest_z7q3q7z11crfr\" />\r\n <Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\">\r\n <SignedInfo>\r\n <CanonicalizationMethod Algorithm=\"http://www.w3.org/2001/10/xml-exc-c14n#\" />\r\n <SignatureMethod Algorithm=\"http://www.w3.org/2001/04/xmldsig-more#rsa-sha256\" />\r\n <Reference URI=\"\">\r\n <Transforms>\r\n <Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\" />\r\n </Transforms>\r\n <DigestMethod Algorithm=\"http://www.w3.org/2001/04/xmlenc#sha256\" />\r\n <DigestValue>cdiU06eD8X/w1aGCHeaGCG9w/kWZ8I099rw4mmPpvdU=</DigestValue>\r\n </Reference>\r\n </SignedInfo>\r\n <SignatureValue>SjRIxS/2r2P6ZdgaR9bwUSa6ZItYYFpKLJZrnAa3zkMylbiWjh9oZGGng2p6/gtBHC2dSTZlLbqnysJjl7mQp/A3wKaIkzjyRXv3kxoVaSV0pkqiPt04cIfFTP0JZkE5QD/vYxiWjeyGp1dThEM2RV811sRWvmEs/hHhVxb32e8xCLtpALYx3a9lW51zRJJN0eNdPAvNoiCJlnogAoTToUQLHs72I1dECnSbeNPXiG7klpy5boKKMCZfnVXXkneWvVFtAA1h2sB7ll40LEHO4oYN6VzD+uKd76QOgGmsu9iGVyRvvmMtahvtL1/pxoxsTRedhKq6zrzCfT8qfh3C1w==</SignatureValue>\r\n </Signature>\r\n</Receipt>\r\n"
6340
+ * });
4463
6341
  */
4464
- ValidateWindowsStoreReceipt(request: ValidateWindowsReceiptRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ValidateWindowsReceiptResult>;
6342
+ ValidateWindowsStoreReceipt(request: ValidateWindowsReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateWindowsReceiptResult>;
4465
6343
  /**
4466
6344
  * 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>;
6345
+ *
6346
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent Microsoft Documentation}
6347
+ * @example
6348
+ * await clientClient.WriteCharacterEvent({
6349
+ * "CharacterId": "E161CB4B7F6C34B",
6350
+ * "EventName": "character_defeated_enemy",
6351
+ * "Timestamp": "2016-03-07T00:00:00Z",
6352
+ * "Body": {
6353
+ * "Enemy": "guardian",
6354
+ * "Damage": 5,
6355
+ * "Coordinates": {
6356
+ * "X": 123.4,
6357
+ * "Y": 543.2
6358
+ * }
6359
+ * }
6360
+ * });
6361
+ */
6362
+ WriteCharacterEvent(request: WriteClientCharacterEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
4470
6363
  /**
4471
6364
  * 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>;
6365
+ *
6366
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent Microsoft Documentation}
6367
+ * @example
6368
+ * await clientClient.WritePlayerEvent({
6369
+ * "EventName": "player_defeated_enemy",
6370
+ * "Timestamp": "2014-03-07T00:00:00Z",
6371
+ * "Body": {
6372
+ * "Enemy": "guardian",
6373
+ * "Damage": 5,
6374
+ * "Coordinates": {
6375
+ * "X": 123.4,
6376
+ * "Y": 543.2
6377
+ * }
6378
+ * }
6379
+ * });
6380
+ */
6381
+ WritePlayerEvent(request: WriteClientPlayerEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
4475
6382
  /**
4476
6383
  * 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>;
6384
+ *
6385
+ * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent Microsoft Documentation}
6386
+ * @example
6387
+ * await clientClient.WriteTitleEvent({
6388
+ * "EventName": "client_update_submitted",
6389
+ * "Timestamp": "2016-03-07T00:00:00Z",
6390
+ * "Body": {
6391
+ * "Version": "1.4.50"
6392
+ * }
6393
+ * });
6394
+ */
6395
+ WriteTitleEvent(request: WriteTitleEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
4480
6396
  }
4481
6397
 
4482
6398
  export { PlayFabClientApi as default };