async-playfab-web-sdk 1.192.250526-3 → 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 (103) hide show
  1. package/dist/Addon.d.ts +179 -39
  2. package/dist/Addon.js +2 -2
  3. package/dist/Admin.d.ts +2386 -195
  4. package/dist/Admin.js +2 -2
  5. package/dist/Authentication.d.ts +32 -5
  6. package/dist/Authentication.js +2 -2
  7. package/dist/Client.d.ts +2235 -321
  8. package/dist/Client.js +2 -2
  9. package/dist/CloudScript.d.ts +199 -31
  10. package/dist/CloudScript.js +2 -2
  11. package/dist/Data.d.ts +137 -18
  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 +200 -13
  16. package/dist/Events.js +2 -2
  17. package/dist/Experimentation.d.ts +164 -17
  18. package/dist/Experimentation.js +2 -2
  19. package/dist/Groups.d.ts +267 -28
  20. package/dist/Groups.js +2 -2
  21. package/dist/Insights.d.ts +33 -7
  22. package/dist/Insights.js +2 -2
  23. package/dist/Localization.d.ts +5 -2
  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 +2697 -169
  29. package/dist/Multiplayer.js +2 -2
  30. package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts} +3 -5
  31. package/dist/Profiles.d.ts +163 -19
  32. package/dist/Profiles.js +2 -2
  33. package/dist/Progression.d.ts +287 -35
  34. package/dist/Progression.js +2 -2
  35. package/dist/Server.d.ts +1904 -242
  36. package/dist/Server.js +2 -2
  37. package/dist/chunk-3I6ONUUQ.js +237 -0
  38. package/dist/chunk-3I6ONUUQ.js.map +1 -0
  39. package/dist/chunk-3O5QT4SL.js +2477 -0
  40. package/dist/chunk-3O5QT4SL.js.map +1 -0
  41. package/dist/chunk-3OBHYLBF.js +2673 -0
  42. package/dist/chunk-3OBHYLBF.js.map +1 -0
  43. package/dist/chunk-57KYHGBO.js +421 -0
  44. package/dist/chunk-57KYHGBO.js.map +1 -0
  45. package/dist/{chunk-J4QS5VX5.js → chunk-5CWZN75H.js} +6 -3
  46. package/dist/chunk-5CWZN75H.js.map +1 -0
  47. package/dist/chunk-73SVDH45.js +197 -0
  48. package/dist/chunk-73SVDH45.js.map +1 -0
  49. package/dist/chunk-ADHTNFTN.js +175 -0
  50. package/dist/chunk-ADHTNFTN.js.map +1 -0
  51. package/dist/chunk-C7U2JQNZ.js +76 -0
  52. package/dist/chunk-C7U2JQNZ.js.map +1 -0
  53. package/dist/{chunk-SGSEOIKS.js → chunk-GAZYZIK2.js} +34 -8
  54. package/dist/chunk-GAZYZIK2.js.map +1 -0
  55. package/dist/chunk-J54WY4UN.js +413 -0
  56. package/dist/chunk-J54WY4UN.js.map +1 -0
  57. package/dist/chunk-NFWQ4MMZ.js +1048 -0
  58. package/dist/chunk-NFWQ4MMZ.js.map +1 -0
  59. package/dist/{chunk-A7VD6ALV.js → chunk-P7UVG26J.js} +167 -32
  60. package/dist/chunk-P7UVG26J.js.map +1 -0
  61. package/dist/chunk-PFXZB4UN.js +2387 -0
  62. package/dist/chunk-PFXZB4UN.js.map +1 -0
  63. package/dist/{chunk-X34XZJB6.js → chunk-QNGQW3YB.js} +28 -6
  64. package/dist/chunk-QNGQW3YB.js.map +1 -0
  65. package/dist/chunk-SQWILU5T.js +270 -0
  66. package/dist/chunk-SQWILU5T.js.map +1 -0
  67. package/dist/{chunk-JGDO2ZE3.js → chunk-SR2RIRLX.js} +1482 -175
  68. package/dist/chunk-SR2RIRLX.js.map +1 -0
  69. package/dist/{chunk-62SULWOK.js → chunk-XVDYM74A.js} +17 -14
  70. package/dist/chunk-XVDYM74A.js.map +1 -0
  71. package/dist/chunk-ZW4TJ3MQ.js +225 -0
  72. package/dist/chunk-ZW4TJ3MQ.js.map +1 -0
  73. package/dist/index.d.ts +7 -6
  74. package/dist/index.js +29 -25
  75. package/package.json +2 -2
  76. package/dist/chunk-3FCAP7OZ.js +0 -187
  77. package/dist/chunk-3FCAP7OZ.js.map +0 -1
  78. package/dist/chunk-62SULWOK.js.map +0 -1
  79. package/dist/chunk-A7VD6ALV.js.map +0 -1
  80. package/dist/chunk-BX65UND2.js +0 -632
  81. package/dist/chunk-BX65UND2.js.map +0 -1
  82. package/dist/chunk-J4QS5VX5.js.map +0 -1
  83. package/dist/chunk-JGDO2ZE3.js.map +0 -1
  84. package/dist/chunk-POMI7LEF.js +0 -76
  85. package/dist/chunk-POMI7LEF.js.map +0 -1
  86. package/dist/chunk-Q3OF3AOJ.js +0 -97
  87. package/dist/chunk-Q3OF3AOJ.js.map +0 -1
  88. package/dist/chunk-QUZHVSVZ.js +0 -174
  89. package/dist/chunk-QUZHVSVZ.js.map +0 -1
  90. package/dist/chunk-QVLIVSO4.js +0 -1147
  91. package/dist/chunk-QVLIVSO4.js.map +0 -1
  92. package/dist/chunk-R7V7DFCF.js +0 -103
  93. package/dist/chunk-R7V7DFCF.js.map +0 -1
  94. package/dist/chunk-SGSEOIKS.js.map +0 -1
  95. package/dist/chunk-UOHHNVCJ.js +0 -119
  96. package/dist/chunk-UOHHNVCJ.js.map +0 -1
  97. package/dist/chunk-USKFWNQK.js +0 -384
  98. package/dist/chunk-USKFWNQK.js.map +0 -1
  99. package/dist/chunk-UX7LFJCX.js +0 -61
  100. package/dist/chunk-UX7LFJCX.js.map +0 -1
  101. package/dist/chunk-X34XZJB6.js.map +0 -1
  102. package/dist/chunk-YNZF3WXS.js +0 -882
  103. package/dist/chunk-YNZF3WXS.js.map +0 -1
@@ -1,4 +1,4 @@
1
- import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BX3jSqGx.js';
1
+ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
2
2
 
3
3
  interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
4
4
  /**
@@ -9,8 +9,8 @@ interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
9
9
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
10
10
  CustomTags?: Record<string, string | null>;
11
11
  /**
12
- * The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
13
- * 'external' as the type.
12
+ * The entity type being represented on the leaderboard. If it doesn&#39;t correspond to the PlayFab entity types, use
13
+ * &#39;external&#39; as the type.
14
14
  */
15
15
  EntityType: string;
16
16
  /** A name for the leaderboard, unique per title. */
@@ -33,7 +33,7 @@ interface CreateStatisticDefinitionRequest extends IPlayFabRequestCommon {
33
33
  CustomTags?: Record<string, string | null>;
34
34
  /** The entity type allowed to have score(s) for this statistic. */
35
35
  EntityType?: string;
36
- /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
36
+ /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39;. */
37
37
  Name: string;
38
38
  /** The version reset configuration for the statistic definition. */
39
39
  VersionConfiguration?: VersionConfiguration;
@@ -75,9 +75,14 @@ interface EntityKey {
75
75
  Id: string;
76
76
  /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
77
77
  Type?: string;
78
+ /**
79
+ * Alternate name for Type.
80
+ * @deprecated Please use Type instead.
81
+ */
82
+ TypeString?: string;
78
83
  }
79
84
  interface EntityLeaderboardEntry {
80
- /** Entity's display name. */
85
+ /** Entity&#39;s display name. */
81
86
  DisplayName?: string;
82
87
  /** Entity identifier. */
83
88
  Entity?: EntityKey;
@@ -136,7 +141,7 @@ interface GetFriendLeaderboardForEntityRequest extends IPlayFabRequestCommon {
136
141
  /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
137
142
  Entity?: EntityKey;
138
143
  /**
139
- * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
144
+ * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
140
145
  * comma-separated list of platforms.
141
146
  */
142
147
  ExternalFriendSources?: string;
@@ -177,8 +182,8 @@ interface GetLeaderboardDefinitionResponse extends IPlayFabResultCommon {
177
182
  /** Created time, in UTC */
178
183
  Created: string;
179
184
  /**
180
- * The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
181
- * 'external' as the type.
185
+ * The entity type being represented on the leaderboard. If it doesn&#39;t correspond to the PlayFab entity types, use
186
+ * &#39;external&#39; as the type.
182
187
  */
183
188
  EntityType: string;
184
189
  /** Last time, in UTC, leaderboard version was incremented. */
@@ -234,6 +239,16 @@ interface GetStatisticDefinitionResponse extends IPlayFabResultCommon {
234
239
  /** The version reset configuration for the leaderboard definition. */
235
240
  VersionConfiguration?: VersionConfiguration;
236
241
  }
242
+ /** @deprecated Do not use */
243
+ interface GetStatisticDefinitionsRequest extends IPlayFabRequestCommon {
244
+ /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
245
+ CustomTags?: Record<string, string | null>;
246
+ }
247
+ /** @deprecated Do not use */
248
+ interface GetStatisticDefinitionsResponse extends IPlayFabResultCommon {
249
+ /** List of statistic definitions for the title. */
250
+ StatisticDefinitions?: StatisticDefinition[];
251
+ }
237
252
  interface GetStatisticsForEntitiesRequest extends IPlayFabRequestCommon {
238
253
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
239
254
  CustomTags?: Record<string, string | null>;
@@ -297,8 +312,8 @@ interface LeaderboardDefinition {
297
312
  /** Created time, in UTC */
298
313
  Created: string;
299
314
  /**
300
- * The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
301
- * 'external' as the type.
315
+ * The entity type being represented on the leaderboard. If it doesn&#39;t correspond to the PlayFab entity types, use
316
+ * &#39;external&#39; as the type.
302
317
  */
303
318
  EntityType: string;
304
319
  /** Last time, in UTC, leaderboard version was incremented. */
@@ -405,7 +420,7 @@ interface StatisticUpdate {
405
420
  * libraries unable to handle 64bit integers.
406
421
  */
407
422
  Scores?: string[];
408
- /** Optional field to indicate the version of the statistic to set. When empty defaults to the statistic's current version. */
423
+ /** Optional field to indicate the version of the statistic to set. When empty defaults to the statistic&#39;s current version. */
409
424
  Version?: number;
410
425
  }
411
426
  interface UnlinkLeaderboardFromStatisticRequest extends IPlayFabRequestCommon {
@@ -437,7 +452,7 @@ interface UpdateLeaderboardEntriesRequest extends IPlayFabRequestCommon {
437
452
  interface UpdateStatisticDefinitionRequest extends IPlayFabRequestCommon {
438
453
  /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
439
454
  CustomTags?: Record<string, string | null>;
440
- /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
455
+ /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39;. */
441
456
  Name: string;
442
457
  /** The version reset configuration for the statistic definition. */
443
458
  VersionConfiguration?: VersionConfiguration;
@@ -479,118 +494,355 @@ interface VersionConfiguration {
479
494
  declare class PlayFabProgressionApi extends PlayFabCommon {
480
495
  /**
481
496
  * Creates a new leaderboard definition.
482
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/createleaderboarddefinition
497
+ *
498
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/createleaderboarddefinition Microsoft Documentation}
499
+ * @example
500
+ * await leaderboardClient.CreateLeaderboardDefinition({
501
+ * "Name": "HighestScoresByLevel",
502
+ * "EntityType": "title_player_account",
503
+ * "VersionConfiguration": {
504
+ * "ResetInterval": "Manual",
505
+ * "MaxQueryableVersions": 1
506
+ * },
507
+ * "Columns": [
508
+ * {
509
+ * "Name": "Hits",
510
+ * "SortDirection": "Descending"
511
+ * }
512
+ * ],
513
+ * "SizeLimit": 1000
514
+ * });
483
515
  */
484
516
  CreateLeaderboardDefinition(request: CreateLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
485
517
  /**
486
518
  * Create a new entity statistic definition.
487
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/createstatisticdefinition
519
+ *
520
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/createstatisticdefinition Microsoft Documentation}
521
+ * @example
522
+ * await statisticClient.CreateStatisticDefinition({
523
+ * "Name": "HighestScoresByLevel",
524
+ * "AggregationMethod": "Last",
525
+ * "Columns": [
526
+ * {
527
+ * "AggregationMethod": "Min"
528
+ * }
529
+ * ]
530
+ * });
488
531
  */
489
532
  CreateStatisticDefinition(request: CreateStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
490
533
  /**
491
534
  * Deletes a leaderboard definition.
492
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboarddefinition
535
+ *
536
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/deleteleaderboarddefinition Microsoft Documentation}
537
+ * @example
538
+ * await leaderboardClient.DeleteLeaderboardDefinition({
539
+ * "Name": "HighestScoresByLevel"
540
+ * });
493
541
  */
494
542
  DeleteLeaderboardDefinition(request: DeleteLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
495
543
  /**
496
544
  * Deletes the specified entries from the given leaderboard.
497
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboardentries
545
+ *
546
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/deleteleaderboardentries Microsoft Documentation}
547
+ * @example
548
+ * await leaderboardClient.DeleteLeaderboardEntries({
549
+ * "Name": "Points",
550
+ * "EntityIds": [
551
+ * "12802710371",
552
+ * "01849174301"
553
+ * ]
554
+ * });
498
555
  */
499
556
  DeleteLeaderboardEntries(request: DeleteLeaderboardEntriesRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
500
557
  /**
501
558
  * Delete an entity statistic definition. Will delete all statistics on entity profiles and leaderboards.
502
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/deletestatisticdefinition
559
+ *
560
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/deletestatisticdefinition Microsoft Documentation}
561
+ * @example
562
+ * await statisticClient.DeleteStatisticDefinition({
563
+ * "Name": "HighestScoresByLevel"
564
+ * });
503
565
  */
504
566
  DeleteStatisticDefinition(request: DeleteStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
505
567
  /**
506
568
  * Delete statistics on an entity profile. This will remove all rankings from associated leaderboards.
507
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/deletestatistics
569
+ *
570
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/deletestatistics Microsoft Documentation}
571
+ * @example
572
+ * await statisticClient.DeleteStatistics({
573
+ * "Statistics": [
574
+ * {
575
+ * "Name": "TotalCarTime"
576
+ * },
577
+ * {
578
+ * "Name": "FastestTimesByMap",
579
+ * "Version": 15
580
+ * }
581
+ * ]
582
+ * });
508
583
  */
509
584
  DeleteStatistics(request: DeleteStatisticsRequest, extraHeaders?: Record<string, string>): Promise<DeleteStatisticsResponse>;
510
585
  /**
511
586
  * Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard.
512
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getfriendleaderboardforentity
587
+ *
588
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getfriendleaderboardforentity Microsoft Documentation}
589
+ * @example
590
+ * await leaderboardClient.GetFriendLeaderboardForEntity({
591
+ * "LeaderboardName": "Points",
592
+ * "ExternalFriendSources": "None"
593
+ * });
513
594
  */
514
595
  GetFriendLeaderboardForEntity(request: GetFriendLeaderboardForEntityRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
515
596
  /**
516
597
  * Get the leaderboard for a specific entity type and statistic.
517
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboard
598
+ *
599
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboard Microsoft Documentation}
600
+ * @example
601
+ * await leaderboardClient.GetLeaderboard({
602
+ * "LeaderboardName": "Points",
603
+ * "Version": 2,
604
+ * "StartingPosition": 100,
605
+ * "PageSize": 20
606
+ * });
518
607
  */
519
608
  GetLeaderboard(request: GetEntityLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
520
609
  /**
521
610
  * Get the leaderboard around a specific entity.
522
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardaroundentity
611
+ *
612
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboardaroundentity Microsoft Documentation}
613
+ * @example
614
+ * await leaderboardClient.GetLeaderboardAroundEntity({
615
+ * "LeaderboardName": "Points",
616
+ * "Version": 2,
617
+ * "MaxSurroundingEntries": 0,
618
+ * "Entity": {
619
+ * "Id": "819478109412",
620
+ * "Type": "title_player_account",
621
+ * "TypeString": "title_player_account"
622
+ * }
623
+ * });
523
624
  */
524
625
  GetLeaderboardAroundEntity(request: GetLeaderboardAroundEntityRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
525
626
  /**
526
627
  * Gets the specified leaderboard definition.
527
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboarddefinition
628
+ *
629
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboarddefinition Microsoft Documentation}
630
+ * @example
631
+ * await leaderboardClient.GetLeaderboardDefinition({
632
+ * "Name": "HighestScoresByLevel"
633
+ * });
528
634
  */
529
635
  GetLeaderboardDefinition(request: GetLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardDefinitionResponse>;
530
636
  /**
531
637
  * Get the leaderboard limited to a set of entities.
532
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardforentities
638
+ *
639
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboardforentities Microsoft Documentation}
640
+ * @example
641
+ * await leaderboardClient.GetLeaderboardForEntities({
642
+ * "LeaderboardName": "Points",
643
+ * "Version": 2,
644
+ * "EntityIds": [
645
+ * "12802710371",
646
+ * "01849174301"
647
+ * ]
648
+ * });
533
649
  */
534
650
  GetLeaderboardForEntities(request: GetLeaderboardForEntitiesRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
535
651
  /**
536
652
  * Get current statistic definition information
537
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinition
653
+ *
654
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatisticdefinition Microsoft Documentation}
655
+ * @example
656
+ * await statisticClient.GetStatisticDefinition({
657
+ * "Name": "Points"
658
+ * });
538
659
  */
539
660
  GetStatisticDefinition(request: GetStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticDefinitionResponse>;
661
+ /**
662
+ * Get all current statistic definitions information
663
+ *
664
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatisticdefinitions Microsoft Documentation}
665
+ * @deprecated Please use ListStatisticDefinitions instead.
666
+ */
667
+ GetStatisticDefinitions(request: GetStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticDefinitionsResponse>;
540
668
  /**
541
669
  * Gets statistics for the specified entity.
542
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatistics
670
+ *
671
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatistics Microsoft Documentation}
672
+ * @example
673
+ * await statisticClient.GetStatistics({
674
+ * "Entity": {
675
+ * "Id": "A197412JDA",
676
+ * "Type": "title_player_account",
677
+ * "TypeString": "title_player_account"
678
+ * }
679
+ * });
543
680
  */
544
681
  GetStatistics(request: GetStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticsResponse>;
545
682
  /**
546
683
  * Gets statistics for the specified collection of entities.
547
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticsforentities
684
+ *
685
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatisticsforentities Microsoft Documentation}
686
+ * @example
687
+ * await statisticClient.GetStatisticsForEntities({
688
+ * "Entities": [
689
+ * {
690
+ * "Id": "A197412JDA",
691
+ * "Type": "title_player_account",
692
+ * "TypeString": "title_player_account"
693
+ * },
694
+ * {
695
+ * "Id": "B197412JDB",
696
+ * "Type": "title_player_account",
697
+ * "TypeString": "title_player_account"
698
+ * }
699
+ * ]
700
+ * });
548
701
  */
549
702
  GetStatisticsForEntities(request: GetStatisticsForEntitiesRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticsForEntitiesResponse>;
550
703
  /**
551
704
  * Increment a leaderboard version.
552
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/incrementleaderboardversion
705
+ *
706
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/incrementleaderboardversion Microsoft Documentation}
707
+ * @example
708
+ * await leaderboardClient.IncrementLeaderboardVersion({
709
+ * "Name": "HighestScoresByLevel"
710
+ * });
553
711
  */
554
712
  IncrementLeaderboardVersion(request: IncrementLeaderboardVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementLeaderboardVersionResponse>;
555
713
  /**
556
714
  * Increment an entity statistic definition version.
557
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/incrementstatisticversion
715
+ *
716
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/incrementstatisticversion Microsoft Documentation}
717
+ * @example
718
+ * await statisticClient.IncrementStatisticVersion({
719
+ * "Name": "HighestScoresByLevel"
720
+ * });
558
721
  */
559
722
  IncrementStatisticVersion(request: IncrementStatisticVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementStatisticVersionResponse>;
560
723
  /**
561
724
  * Lists the leaderboard definitions defined for the Title.
562
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/listleaderboarddefinitions
725
+ *
726
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/listleaderboarddefinitions Microsoft Documentation}
727
+ * @example
728
+ * await leaderboardClient.ListLeaderboardDefinitions({});
563
729
  */
564
730
  ListLeaderboardDefinitions(request: ListLeaderboardDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<ListLeaderboardDefinitionsResponse>;
565
731
  /**
566
732
  * Get all current statistic definitions information
567
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/liststatisticdefinitions
733
+ *
734
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/liststatisticdefinitions Microsoft Documentation}
735
+ * @example
736
+ * await statisticClient.ListStatisticDefinitions({});
568
737
  */
569
738
  ListStatisticDefinitions(request: ListStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<ListStatisticDefinitionsResponse>;
570
739
  /**
571
740
  * Unlinks a leaderboard definition from it's linked statistic definition.
572
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/unlinkleaderboardfromstatistic
741
+ *
742
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/unlinkleaderboardfromstatistic Microsoft Documentation}
743
+ * @example
744
+ * await leaderboardClient.UnlinkLeaderboardFromStatistic({
745
+ * "Name": "HighestScoresByLevel",
746
+ * "StatisticName": "HighestScoresByLevel"
747
+ * });
573
748
  */
574
749
  UnlinkLeaderboardFromStatistic(request: UnlinkLeaderboardFromStatisticRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
575
750
  /**
576
751
  * Updates a leaderboard definition.
577
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboarddefinition
752
+ *
753
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/updateleaderboarddefinition Microsoft Documentation}
754
+ * @example
755
+ * await leaderboardClient.UpdateLeaderboardDefinition({
756
+ * "Name": "HighestScoresByLevel",
757
+ * "VersionConfiguration": {
758
+ * "ResetInterval": "Manual",
759
+ * "MaxQueryableVersions": 1
760
+ * },
761
+ * "SizeLimit": 1000
762
+ * });
578
763
  */
579
764
  UpdateLeaderboardDefinition(request: UpdateLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
580
765
  /**
581
766
  * Adds or updates entries on the specified leaderboard.
582
- * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboardentries
767
+ *
768
+ * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/updateleaderboardentries Microsoft Documentation}
769
+ * @example
770
+ * await leaderboardClient.UpdateLeaderboardEntries({
771
+ * "LeaderboardName": "Points",
772
+ * "Entries": [
773
+ * {
774
+ * "Scores": [
775
+ * "100",
776
+ * "200"
777
+ * ],
778
+ * "EntityId": "12802710371"
779
+ * },
780
+ * {
781
+ * "Scores": [
782
+ * "120",
783
+ * "200"
784
+ * ],
785
+ * "EntityId": "01849174301"
786
+ * }
787
+ * ]
788
+ * });
583
789
  */
584
790
  UpdateLeaderboardEntries(request: UpdateLeaderboardEntriesRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
585
791
  /**
586
792
  * Update an existing entity statistic definition.
587
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatisticdefinition
793
+ *
794
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/updatestatisticdefinition Microsoft Documentation}
795
+ * @example
796
+ * await statisticClient.UpdateStatisticDefinition({
797
+ * "Name": "HighestScoresByLevel",
798
+ * "VersionConfiguration": {
799
+ * "ResetInterval": "Manual",
800
+ * "MaxQueryableVersions": 2
801
+ * }
802
+ * });
588
803
  */
589
804
  UpdateStatisticDefinition(request: UpdateStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
590
805
  /**
591
806
  * Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on
592
807
  * various leaderboards.
593
- * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatistics
808
+ *
809
+ * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/updatestatistics Microsoft Documentation}
810
+ * @example
811
+ * await statisticClient.UpdateStatistics({
812
+ * "Statistics": [
813
+ * {
814
+ * "Name": "RoundsWon",
815
+ * "Value": 0,
816
+ * "Metadata": "BestRun:34.13,Car:13452",
817
+ * "Scores": [
818
+ * "100",
819
+ * "200"
820
+ * ]
821
+ * },
822
+ * {
823
+ * "Name": "FastestTimesByMap",
824
+ * "Value": 0,
825
+ * "Metadata": "Car:13452",
826
+ * "Scores": [
827
+ * "200",
828
+ * "300"
829
+ * ]
830
+ * },
831
+ * {
832
+ * "Name": "TotalCarTime",
833
+ * "Value": 0,
834
+ * "Scores": [
835
+ * "300",
836
+ * "400"
837
+ * ]
838
+ * }
839
+ * ],
840
+ * "Entity": {
841
+ * "Id": "A197412JDA",
842
+ * "Type": "title_player_account",
843
+ * "TypeString": "title_player_account"
844
+ * }
845
+ * });
594
846
  */
595
847
  UpdateStatistics(request: UpdateStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStatisticsResponse>;
596
848
  }
@@ -1,7 +1,7 @@
1
1
  import {
2
2
  PlayFabProgressionApi
3
- } from "./chunk-QUZHVSVZ.js";
4
- import "./chunk-62SULWOK.js";
3
+ } from "./chunk-J54WY4UN.js";
4
+ import "./chunk-XVDYM74A.js";
5
5
  export {
6
6
  PlayFabProgressionApi as default
7
7
  };