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

package/dist/Progression.d.ts

@@ -1,4 +1,4 @@
-import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BX3jSqGx.js';
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
 
 interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
     /**
@@ -9,8 +9,8 @@ interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
-     * The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
-     * 'external' as the type.
+     * The entity type being represented on the leaderboard. If it doesn&#39;t correspond to the PlayFab entity types, use
+     * &#39;external&#39; as the type.
      */
     EntityType: string;
     /** A name for the leaderboard, unique per title. */
@@ -33,7 +33,7 @@ interface CreateStatisticDefinitionRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** The entity type allowed to have score(s) for this statistic. */
     EntityType?: string;
-    /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
+    /** 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;. */
     Name: string;
     /** The version reset configuration for the statistic definition. */
     VersionConfiguration?: VersionConfiguration;
@@ -75,9 +75,14 @@ interface EntityKey {
     Id: string;
     /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
     Type?: string;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
 }
 interface EntityLeaderboardEntry {
-    /** Entity's display name. */
+    /** Entity&#39;s display name. */
     DisplayName?: string;
     /** Entity identifier. */
     Entity?: EntityKey;
@@ -136,7 +141,7 @@ interface GetFriendLeaderboardForEntityRequest extends IPlayFabRequestCommon {
     /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
     Entity?: EntityKey;
     /**
-     * Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
+     * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
      * comma-separated list of platforms.
      */
     ExternalFriendSources?: string;
@@ -177,8 +182,8 @@ interface GetLeaderboardDefinitionResponse extends IPlayFabResultCommon {
     /** Created time, in UTC */
     Created: string;
     /**
-     * The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
-     * 'external' as the type.
+     * The entity type being represented on the leaderboard. If it doesn&#39;t correspond to the PlayFab entity types, use
+     * &#39;external&#39; as the type.
      */
     EntityType: string;
     /** Last time, in UTC, leaderboard version was incremented. */
@@ -234,6 +239,16 @@ interface GetStatisticDefinitionResponse extends IPlayFabResultCommon {
     /** The version reset configuration for the leaderboard definition. */
     VersionConfiguration?: VersionConfiguration;
 }
+/** @deprecated Do not use */
+interface GetStatisticDefinitionsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+/** @deprecated Do not use */
+interface GetStatisticDefinitionsResponse extends IPlayFabResultCommon {
+    /** List of statistic definitions for the title. */
+    StatisticDefinitions?: StatisticDefinition[];
+}
 interface GetStatisticsForEntitiesRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -297,8 +312,8 @@ interface LeaderboardDefinition {
     /** Created time, in UTC */
     Created: string;
     /**
-     * The entity type being represented on the leaderboard. If it doesn't correspond to the PlayFab entity types, use
-     * 'external' as the type.
+     * The entity type being represented on the leaderboard. If it doesn&#39;t correspond to the PlayFab entity types, use
+     * &#39;external&#39; as the type.
      */
     EntityType: string;
     /** Last time, in UTC, leaderboard version was incremented. */
@@ -405,7 +420,7 @@ interface StatisticUpdate {
      * libraries unable to handle 64bit integers.
      */
     Scores?: string[];
-    /** Optional field to indicate the version of the statistic to set. When empty defaults to the statistic's current version. */
+    /** Optional field to indicate the version of the statistic to set. When empty defaults to the statistic&#39;s current version. */
     Version?: number;
 }
 interface UnlinkLeaderboardFromStatisticRequest extends IPlayFabRequestCommon {
@@ -437,7 +452,7 @@ interface UpdateLeaderboardEntriesRequest extends IPlayFabRequestCommon {
 interface UpdateStatisticDefinitionRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
+    /** 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;. */
     Name: string;
     /** The version reset configuration for the statistic definition. */
     VersionConfiguration?: VersionConfiguration;
@@ -479,118 +494,355 @@ interface VersionConfiguration {
 declare class PlayFabProgressionApi extends PlayFabCommon {
     /**
      * Creates a new leaderboard definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/createleaderboarddefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/createleaderboarddefinition Microsoft Documentation}
+     * @example
+     * await leaderboardClient.CreateLeaderboardDefinition({
+     *   "Name": "HighestScoresByLevel",
+     *   "EntityType": "title_player_account",
+     *   "VersionConfiguration": {
+     *     "ResetInterval": "Manual",
+     *     "MaxQueryableVersions": 1
+     *   },
+     *   "Columns": [
+     *     {
+     *       "Name": "Hits",
+     *       "SortDirection": "Descending"
+     *     }
+     *   ],
+     *   "SizeLimit": 1000
+     * });
      */
     CreateLeaderboardDefinition(request: CreateLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Create a new entity statistic definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/createstatisticdefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/createstatisticdefinition Microsoft Documentation}
+     * @example
+     * await statisticClient.CreateStatisticDefinition({
+     *   "Name": "HighestScoresByLevel",
+     *   "AggregationMethod": "Last",
+     *   "Columns": [
+     *     {
+     *       "AggregationMethod": "Min"
+     *     }
+     *   ]
+     * });
      */
     CreateStatisticDefinition(request: CreateStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Deletes a leaderboard definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboarddefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/deleteleaderboarddefinition Microsoft Documentation}
+     * @example
+     * await leaderboardClient.DeleteLeaderboardDefinition({
+     *   "Name": "HighestScoresByLevel"
+     * });
      */
     DeleteLeaderboardDefinition(request: DeleteLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Deletes the specified entries from the given leaderboard.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboardentries
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/deleteleaderboardentries Microsoft Documentation}
+     * @example
+     * await leaderboardClient.DeleteLeaderboardEntries({
+     *   "Name": "Points",
+     *   "EntityIds": [
+     *     "12802710371",
+     *     "01849174301"
+     *   ]
+     * });
      */
     DeleteLeaderboardEntries(request: DeleteLeaderboardEntriesRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Delete an entity statistic definition. Will delete all statistics on entity profiles and leaderboards.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/deletestatisticdefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/deletestatisticdefinition Microsoft Documentation}
+     * @example
+     * await statisticClient.DeleteStatisticDefinition({
+     *   "Name": "HighestScoresByLevel"
+     * });
      */
     DeleteStatisticDefinition(request: DeleteStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Delete statistics on an entity profile. This will remove all rankings from associated leaderboards.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/deletestatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/deletestatistics Microsoft Documentation}
+     * @example
+     * await statisticClient.DeleteStatistics({
+     *   "Statistics": [
+     *     {
+     *       "Name": "TotalCarTime"
+     *     },
+     *     {
+     *       "Name": "FastestTimesByMap",
+     *       "Version": 15
+     *     }
+     *   ]
+     * });
      */
     DeleteStatistics(request: DeleteStatisticsRequest, extraHeaders?: Record<string, string>): Promise<DeleteStatisticsResponse>;
     /**
      * Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getfriendleaderboardforentity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getfriendleaderboardforentity Microsoft Documentation}
+     * @example
+     * await leaderboardClient.GetFriendLeaderboardForEntity({
+     *   "LeaderboardName": "Points",
+     *   "ExternalFriendSources": "None"
+     * });
      */
     GetFriendLeaderboardForEntity(request: GetFriendLeaderboardForEntityRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
     /**
      * Get the leaderboard for a specific entity type and statistic.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboard Microsoft Documentation}
+     * @example
+     * await leaderboardClient.GetLeaderboard({
+     *   "LeaderboardName": "Points",
+     *   "Version": 2,
+     *   "StartingPosition": 100,
+     *   "PageSize": 20
+     * });
      */
     GetLeaderboard(request: GetEntityLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
     /**
      * Get the leaderboard around a specific entity.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardaroundentity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboardaroundentity Microsoft Documentation}
+     * @example
+     * await leaderboardClient.GetLeaderboardAroundEntity({
+     *   "LeaderboardName": "Points",
+     *   "Version": 2,
+     *   "MaxSurroundingEntries": 0,
+     *   "Entity": {
+     *     "Id": "819478109412",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     GetLeaderboardAroundEntity(request: GetLeaderboardAroundEntityRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
     /**
      * Gets the specified leaderboard definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboarddefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboarddefinition Microsoft Documentation}
+     * @example
+     * await leaderboardClient.GetLeaderboardDefinition({
+     *   "Name": "HighestScoresByLevel"
+     * });
      */
     GetLeaderboardDefinition(request: GetLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardDefinitionResponse>;
     /**
      * Get the leaderboard limited to a set of entities.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardforentities
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/getleaderboardforentities Microsoft Documentation}
+     * @example
+     * await leaderboardClient.GetLeaderboardForEntities({
+     *   "LeaderboardName": "Points",
+     *   "Version": 2,
+     *   "EntityIds": [
+     *     "12802710371",
+     *     "01849174301"
+     *   ]
+     * });
      */
     GetLeaderboardForEntities(request: GetLeaderboardForEntitiesRequest, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
     /**
      * Get current statistic definition information
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatisticdefinition Microsoft Documentation}
+     * @example
+     * await statisticClient.GetStatisticDefinition({
+     *   "Name": "Points"
+     * });
      */
     GetStatisticDefinition(request: GetStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticDefinitionResponse>;
+    /**
+     * Get all current statistic definitions information
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatisticdefinitions Microsoft Documentation}
+     * @deprecated Please use ListStatisticDefinitions instead.
+     */
+    GetStatisticDefinitions(request: GetStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticDefinitionsResponse>;
     /**
      * Gets statistics for the specified entity.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatistics Microsoft Documentation}
+     * @example
+     * await statisticClient.GetStatistics({
+     *   "Entity": {
+     *     "Id": "A197412JDA",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     GetStatistics(request: GetStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticsResponse>;
     /**
      * Gets statistics for the specified collection of entities.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticsforentities
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/getstatisticsforentities Microsoft Documentation}
+     * @example
+     * await statisticClient.GetStatisticsForEntities({
+     *   "Entities": [
+     *     {
+     *       "Id": "A197412JDA",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     },
+     *     {
+     *       "Id": "B197412JDB",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
      */
     GetStatisticsForEntities(request: GetStatisticsForEntitiesRequest, extraHeaders?: Record<string, string>): Promise<GetStatisticsForEntitiesResponse>;
     /**
      * Increment a leaderboard version.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/incrementleaderboardversion
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/incrementleaderboardversion Microsoft Documentation}
+     * @example
+     * await leaderboardClient.IncrementLeaderboardVersion({
+     *   "Name": "HighestScoresByLevel"
+     * });
      */
     IncrementLeaderboardVersion(request: IncrementLeaderboardVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementLeaderboardVersionResponse>;
     /**
      * Increment an entity statistic definition version.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/incrementstatisticversion
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/incrementstatisticversion Microsoft Documentation}
+     * @example
+     * await statisticClient.IncrementStatisticVersion({
+     *   "Name": "HighestScoresByLevel"
+     * });
      */
     IncrementStatisticVersion(request: IncrementStatisticVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementStatisticVersionResponse>;
     /**
      * Lists the leaderboard definitions defined for the Title.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/listleaderboarddefinitions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/listleaderboarddefinitions Microsoft Documentation}
+     * @example
+     * await leaderboardClient.ListLeaderboardDefinitions({});
      */
     ListLeaderboardDefinitions(request: ListLeaderboardDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<ListLeaderboardDefinitionsResponse>;
     /**
      * Get all current statistic definitions information
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/liststatisticdefinitions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/liststatisticdefinitions Microsoft Documentation}
+     * @example
+     * await statisticClient.ListStatisticDefinitions({});
      */
     ListStatisticDefinitions(request: ListStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<ListStatisticDefinitionsResponse>;
     /**
      * Unlinks a leaderboard definition from it's linked statistic definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/unlinkleaderboardfromstatistic
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/unlinkleaderboardfromstatistic Microsoft Documentation}
+     * @example
+     * await leaderboardClient.UnlinkLeaderboardFromStatistic({
+     *   "Name": "HighestScoresByLevel",
+     *   "StatisticName": "HighestScoresByLevel"
+     * });
      */
     UnlinkLeaderboardFromStatistic(request: UnlinkLeaderboardFromStatisticRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates a leaderboard definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboarddefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/updateleaderboarddefinition Microsoft Documentation}
+     * @example
+     * await leaderboardClient.UpdateLeaderboardDefinition({
+     *   "Name": "HighestScoresByLevel",
+     *   "VersionConfiguration": {
+     *     "ResetInterval": "Manual",
+     *     "MaxQueryableVersions": 1
+     *   },
+     *   "SizeLimit": 1000
+     * });
      */
     UpdateLeaderboardDefinition(request: UpdateLeaderboardDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Adds or updates entries on the specified leaderboard.
-     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboardentries
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/leaderboard/leaderboards/updateleaderboardentries Microsoft Documentation}
+     * @example
+     * await leaderboardClient.UpdateLeaderboardEntries({
+     *   "LeaderboardName": "Points",
+     *   "Entries": [
+     *     {
+     *       "Scores": [
+     *         "100",
+     *         "200"
+     *       ],
+     *       "EntityId": "12802710371"
+     *     },
+     *     {
+     *       "Scores": [
+     *         "120",
+     *         "200"
+     *       ],
+     *       "EntityId": "01849174301"
+     *     }
+     *   ]
+     * });
      */
     UpdateLeaderboardEntries(request: UpdateLeaderboardEntriesRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Update an existing entity statistic definition.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatisticdefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/updatestatisticdefinition Microsoft Documentation}
+     * @example
+     * await statisticClient.UpdateStatisticDefinition({
+     *   "Name": "HighestScoresByLevel",
+     *   "VersionConfiguration": {
+     *     "ResetInterval": "Manual",
+     *     "MaxQueryableVersions": 2
+     *   }
+     * });
      */
     UpdateStatisticDefinition(request: UpdateStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on
      * various leaderboards.
-     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/statistic/statistics/updatestatistics Microsoft Documentation}
+     * @example
+     * await statisticClient.UpdateStatistics({
+     *   "Statistics": [
+     *     {
+     *       "Name": "RoundsWon",
+     *       "Value": 0,
+     *       "Metadata": "BestRun:34.13,Car:13452",
+     *       "Scores": [
+     *         "100",
+     *         "200"
+     *       ]
+     *     },
+     *     {
+     *       "Name": "FastestTimesByMap",
+     *       "Value": 0,
+     *       "Metadata": "Car:13452",
+     *       "Scores": [
+     *         "200",
+     *         "300"
+     *       ]
+     *     },
+     *     {
+     *       "Name": "TotalCarTime",
+     *       "Value": 0,
+     *       "Scores": [
+     *         "300",
+     *         "400"
+     *       ]
+     *     }
+     *   ],
+     *   "Entity": {
+     *     "Id": "A197412JDA",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     UpdateStatistics(request: UpdateStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStatisticsResponse>;
 }

package/dist/Progression.js

@@ -1,7 +1,7 @@
 import {
   PlayFabProgressionApi
-} from "./chunk-QUZHVSVZ.js";
-import "./chunk-62SULWOK.js";
+} from "./chunk-J54WY4UN.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabProgressionApi as default
 };