async-playfab-web-sdk 1.192.250526-4 → 1.192.250526-5

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