async-playfab-web-sdk 1.192.250526-1

package/dist/Progression.d.ts

@@ -0,0 +1,598 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BUv4zqXf.js';
+
+interface CreateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
+    /**
+     * Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are
+     * allowed.
+     */
+    Columns: LeaderboardColumn[];
+    /** 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.
+     */
+    EntityType: string;
+    /** A name for the leaderboard, unique per title. */
+    Name: string;
+    /** Maximum number of entries on this leaderboard */
+    SizeLimit: number;
+    /** The version reset configuration for the leaderboard definition. */
+    VersionConfiguration: VersionConfiguration;
+}
+interface CreateStatisticDefinitionRequest extends IPlayFabRequestCommon {
+    /**
+     * [In Preview]: The list of statistic definition names whose scores must be aggregated towards this stat. If
+     * AggregationSource is specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently,
+     * only one aggregation source can be specified.
+     */
+    AggregationSources?: string[];
+    /** The columns for the statistic defining the aggregation method for each column. A maximum of 5 columns are allowed. */
+    Columns?: StatisticColumn[];
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    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: string;
+    /** The version reset configuration for the statistic definition. */
+    VersionConfiguration?: VersionConfiguration;
+}
+interface DeleteLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the leaderboard definition to delete. */
+    Name: string;
+}
+interface DeleteLeaderboardEntriesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The unique Ids of the entries to delete from the leaderboard. */
+    EntityIds?: string[];
+    /** The name of the leaderboard. */
+    Name: string;
+}
+interface DeleteStatisticDefinitionRequest 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 to delete. */
+    Name: string;
+}
+interface DeleteStatisticsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** Collection of statistics to remove from this entity. */
+    Statistics: StatisticDelete[];
+}
+interface DeleteStatisticsResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+}
+interface EntityKey {
+    /** Unique ID of the entity. */
+    Id: string;
+    /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
+    Type?: string;
+}
+interface EntityLeaderboardEntry {
+    /** Entity's display name. */
+    DisplayName?: string;
+    /** Entity identifier. */
+    Entity?: EntityKey;
+    /** The time at which the last update to the entry was recorded on the server. */
+    LastUpdated: string;
+    /** An opaque blob of data stored on the leaderboard entry. Note that the metadata is not used for ranking purposes. */
+    Metadata?: string;
+    /** Position on the leaderboard. */
+    Rank: number;
+    /** Scores for the entry. */
+    Scores?: string[];
+}
+interface EntityStatistics {
+    /** Entity key */
+    EntityKey?: EntityKey;
+    /** All statistics for the given entitykey */
+    Statistics?: EntityStatisticValue[];
+}
+interface EntityStatisticValue {
+    /** Metadata associated with the Statistic. */
+    Metadata?: string;
+    /** Statistic name */
+    Name?: string;
+    /** Statistic scores */
+    Scores?: string[];
+    /** Statistic version */
+    Version: number;
+}
+interface GetEntityLeaderboardRequest 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 leaderboard. */
+    LeaderboardName: string;
+    /** Maximum number of results to return from the leaderboard. Minimum 1, maximum 100. */
+    PageSize: number;
+    /** Index position to start from. 1 is beginning of leaderboard. */
+    StartingPosition?: number;
+    /** Optional version of the leaderboard, defaults to current version. */
+    Version?: number;
+}
+interface GetEntityLeaderboardResponse extends IPlayFabResultCommon {
+    /** Leaderboard columns describing the sort directions. */
+    Columns?: LeaderboardColumn[];
+    /** The number of entries on the leaderboard. */
+    EntryCount: number;
+    /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
+    NextReset?: string;
+    /** Individual entity rankings in the leaderboard, in sorted order by rank. */
+    Rankings?: EntityLeaderboardEntry[];
+    /** Version of the leaderboard being returned. */
+    Version: number;
+}
+interface GetFriendLeaderboardForEntityRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** 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
+     * comma-separated list of platforms.
+     */
+    ExternalFriendSources?: string;
+    /** Name of the leaderboard. */
+    LeaderboardName: string;
+    /** Optional version of the leaderboard, defaults to current version. */
+    Version?: number;
+    /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
+    XboxToken?: string;
+}
+interface GetLeaderboardAroundEntityRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** Name of the leaderboard. */
+    LeaderboardName: string;
+    /**
+     * Number of surrounding entries to return (in addition to specified entity). In general, the number of ranks above and
+     * below will be split into half. For example, if the specified value is 10, 5 ranks above and 5 ranks below will be
+     * retrieved. However, the numbers will get skewed in either direction when the specified entity is towards the top or
+     * bottom of the leaderboard. Also, the number of entries returned can be lower than the value specified for entries at the
+     * bottom of the leaderboard.
+     */
+    MaxSurroundingEntries: number;
+    /** Optional version of the leaderboard, defaults to current. */
+    Version?: number;
+}
+interface GetLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the leaderboard to retrieve the definition for. */
+    Name: string;
+}
+interface GetLeaderboardDefinitionResponse extends IPlayFabResultCommon {
+    /** Sort direction of the leaderboard columns, cannot be changed after creation. */
+    Columns: LeaderboardColumn[];
+    /** 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.
+     */
+    EntityType: string;
+    /** Last time, in UTC, leaderboard version was incremented. */
+    LastResetTime?: string;
+    /** A name for the leaderboard, unique per title. */
+    Name: string;
+    /** Maximum number of entries on this leaderboard */
+    SizeLimit: number;
+    /** Latest Leaderboard version. */
+    Version: number;
+    /** The version reset configuration for the leaderboard definition. */
+    VersionConfiguration: VersionConfiguration;
+}
+interface GetLeaderboardForEntitiesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Collection of Entity IDs to include in the leaderboard. */
+    EntityIds: string[];
+    /** Name of the leaderboard. */
+    LeaderboardName: string;
+    /** Optional version of the leaderboard, defaults to current. */
+    Version?: number;
+}
+interface GetStatisticDefinitionRequest 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. */
+    Name: string;
+}
+interface GetStatisticDefinitionResponse extends IPlayFabResultCommon {
+    /** The list of statistic definitions names this definition aggregates to. */
+    AggregationDestinations?: string[];
+    /**
+     * The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is
+     * specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation
+     * source can be specified.
+     */
+    AggregationSources?: string[];
+    /** The columns for the statistic defining the aggregation method for each column. */
+    Columns?: StatisticColumn[];
+    /** Created time, in UTC */
+    Created: string;
+    /** The entity type that can have this statistic. */
+    EntityType?: string;
+    /** Last time, in UTC, statistic version was incremented. */
+    LastResetTime?: string;
+    /** The list of leaderboards that are linked to this statistic definition. */
+    LinkedLeaderboardNames?: string[];
+    /** Name of the statistic. */
+    Name?: string;
+    /** Statistic version. */
+    Version: number;
+    /** The version reset configuration for the leaderboard definition. */
+    VersionConfiguration?: VersionConfiguration;
+}
+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>;
+    /** Collection of Entity IDs to retrieve statistics for. */
+    Entities: EntityKey[];
+}
+interface GetStatisticsForEntitiesResponse extends IPlayFabResultCommon {
+    /** A mapping of statistic name to the columns defined in the corresponding definition. */
+    ColumnDetails?: Record<string, StatisticColumnCollection>;
+    /** List of entities mapped to their statistics. Only the latest version of a statistic is returned. */
+    EntitiesStatistics?: EntityStatistics[];
+}
+interface GetStatisticsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface GetStatisticsResponse extends IPlayFabResultCommon {
+    /** A mapping of statistic name to the columns defined in the corresponding definition. */
+    ColumnDetails?: Record<string, StatisticColumnCollection>;
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** List of statistics keyed by Name. Only the latest version of a statistic is returned. */
+    Statistics?: Record<string, EntityStatisticValue>;
+}
+interface IncrementLeaderboardVersionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the leaderboard to increment the version for. */
+    Name: string;
+}
+interface IncrementLeaderboardVersionResponse extends IPlayFabResultCommon {
+    /** New Leaderboard version. */
+    Version: number;
+}
+interface IncrementStatisticVersionRequest 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 to increment the version of. */
+    Name: string;
+}
+interface IncrementStatisticVersionResponse extends IPlayFabResultCommon {
+    /** New statistic version. */
+    Version: number;
+}
+interface LeaderboardColumn {
+    /**
+     * If the value for this column is sourced from a statistic, details of the linked column. Null if the leaderboard is not
+     * linked.
+     */
+    LinkedStatisticColumn?: LinkedStatisticColumn;
+    /** A name for the leaderboard column, unique per leaderboard definition. */
+    Name: string;
+    /** The sort direction for this column. */
+    SortDirection: string;
+}
+interface LeaderboardDefinition {
+    /** Sort direction of the leaderboard columns, cannot be changed after creation. */
+    Columns: LeaderboardColumn[];
+    /** 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.
+     */
+    EntityType: string;
+    /** Last time, in UTC, leaderboard version was incremented. */
+    LastResetTime?: string;
+    /** A name for the leaderboard, unique per title. */
+    Name: string;
+    /** Maximum number of entries on this leaderboard */
+    SizeLimit: number;
+    /** Latest Leaderboard version. */
+    Version: number;
+    /** The version reset configuration for the leaderboard definition. */
+    VersionConfiguration: VersionConfiguration;
+}
+interface LeaderboardEntryUpdate {
+    /** The unique Id for the entry. If using PlayFab Entities, this would be the entityId of the entity. */
+    EntityId: string;
+    /**
+     * Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. Must be less
+     * than 50 UTF8 encoded characters.
+     */
+    Metadata?: string;
+    /**
+     * The scores for the leaderboard. The number of values provided here must match the number of columns in the Leaderboard
+     * definition.
+     */
+    Scores?: string[];
+}
+interface LinkedStatisticColumn {
+    /** The name of the statistic column that this leaderboard column is sourced from. */
+    LinkedStatisticColumnName: string;
+    /** The name of the statistic. */
+    LinkedStatisticName: string;
+}
+interface ListLeaderboardDefinitionsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface ListLeaderboardDefinitionsResponse extends IPlayFabResultCommon {
+    /** List of leaderboard definitions for the title. */
+    LeaderboardDefinitions?: LeaderboardDefinition[];
+}
+interface ListStatisticDefinitionsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface ListStatisticDefinitionsResponse extends IPlayFabResultCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** List of statistic definitions for the title. */
+    StatisticDefinitions?: StatisticDefinition[];
+}
+interface StatisticColumn {
+    /** Aggregation method for calculating new value of a statistic. */
+    AggregationMethod: string;
+    /** Name of the statistic column, as originally configured. */
+    Name: string;
+}
+interface StatisticColumnCollection {
+    /** Columns for the statistic defining the aggregation method for each column. */
+    Columns?: StatisticColumn[];
+}
+interface StatisticDefinition {
+    /** The list of statistic definitions names this definition aggregates to. */
+    AggregationDestinations?: string[];
+    /**
+     * The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is
+     * specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation
+     * source can be specified.
+     */
+    AggregationSources?: string[];
+    /** The columns for the statistic defining the aggregation method for each column. */
+    Columns?: StatisticColumn[];
+    /** Created time, in UTC */
+    Created: string;
+    /** The entity type that can have this statistic. */
+    EntityType?: string;
+    /** Last time, in UTC, statistic version was incremented. */
+    LastResetTime?: string;
+    /** The list of leaderboards that are linked to this statistic definition. */
+    LinkedLeaderboardNames?: string[];
+    /** Name of the statistic. */
+    Name?: string;
+    /** Statistic version. */
+    Version: number;
+    /** The version reset configuration for the leaderboard definition. */
+    VersionConfiguration?: VersionConfiguration;
+}
+interface StatisticDelete {
+    /** Name of the statistic, as originally configured. */
+    Name: string;
+}
+interface StatisticUpdate {
+    /**
+     * Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. Must be less than 50
+     * UTF8 encoded characters.
+     */
+    Metadata?: string;
+    /** Name of the statistic, as originally configured. */
+    Name: string;
+    /**
+     * Statistic scores for the entity. This will be used in accordance with the aggregation method configured for the
+     * statistics.The maximum value allowed for each individual score is 9223372036854775807. The minimum value for each
+     * individual score is -9223372036854775807The values are formatted as strings to avoid interop issues with client
+     * 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. */
+    Version?: number;
+}
+interface UnlinkLeaderboardFromStatisticRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the leaderboard definition to unlink. */
+    Name: string;
+    /** The name of the statistic definition to unlink. */
+    StatisticName: string;
+}
+interface UpdateLeaderboardDefinitionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the leaderboard to update the definition for. */
+    Name: string;
+    /** Maximum number of entries on this leaderboard */
+    SizeLimit?: number;
+    /** The version reset configuration for the leaderboard definition. */
+    VersionConfiguration?: VersionConfiguration;
+}
+interface UpdateLeaderboardEntriesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entries to add or update on the leaderboard. */
+    Entries?: LeaderboardEntryUpdate[];
+    /** The name of the leaderboard. */
+    LeaderboardName: string;
+}
+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: string;
+    /** The version reset configuration for the statistic definition. */
+    VersionConfiguration?: VersionConfiguration;
+}
+interface UpdateStatisticsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** Collection of statistics to update, maximum 50. */
+    Statistics: StatisticUpdate[];
+    /**
+     * Optional transactionId of this update which can be used to ensure idempotence. Using this field is still in testing
+     * stage.
+     */
+    TransactionId?: string;
+}
+interface UpdateStatisticsResponse extends IPlayFabResultCommon {
+    /** A mapping of statistic name to the columns defined in the corresponding definition. */
+    ColumnDetails?: Record<string, StatisticColumnCollection>;
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** Updated entity profile statistics. */
+    Statistics?: Record<string, EntityStatisticValue>;
+}
+interface VersionConfiguration {
+    /** The maximum number of versions of this leaderboard/statistic that can be queried. */
+    MaxQueryableVersions: number;
+    /**
+     * Reset interval that statistics or leaderboards will reset on. When using Manual intervalthe reset can only be increased
+     * by calling the Increase version API. When using Hour interval the resetwill occur at the start of the next hour UTC
+     * time. When using Day interval the reset will occur at thestart of the next day in UTC time. When using the Week interval
+     * the reset will occur at the start ofthe next Monday in UTC time. When using Month interval the reset will occur at the
+     * start of the nextmonth in UTC time.
+     */
+    ResetInterval: string;
+}
+
+declare class PlayFabProgressionApi extends PlayFabCommon {
+    /**
+     * Creates a new leaderboard definition.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/createleaderboarddefinition
+     */
+    CreateLeaderboardDefinition(request: CreateLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Create a new entity statistic definition.
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/createstatisticdefinition
+     */
+    CreateStatisticDefinition(request: CreateStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Deletes a leaderboard definition.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboarddefinition
+     */
+    DeleteLeaderboardDefinition(request: DeleteLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Deletes the specified entries from the given leaderboard.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/deleteleaderboardentries
+     */
+    DeleteLeaderboardEntries(request: DeleteLeaderboardEntriesRequest, customData?: any, 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
+     */
+    DeleteStatisticDefinition(request: DeleteStatisticDefinitionRequest, customData?: any, 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
+     */
+    DeleteStatistics(request: DeleteStatisticsRequest, customData?: any, 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
+     */
+    GetFriendLeaderboardForEntity(request: GetFriendLeaderboardForEntityRequest, customData?: any, 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
+     */
+    GetLeaderboard(request: GetEntityLeaderboardRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
+    /**
+     * Get the leaderboard around a specific entity.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboardaroundentity
+     */
+    GetLeaderboardAroundEntity(request: GetLeaderboardAroundEntityRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
+    /**
+     * Gets the specified leaderboard definition.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getleaderboarddefinition
+     */
+    GetLeaderboardDefinition(request: GetLeaderboardDefinitionRequest, customData?: any, 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
+     */
+    GetLeaderboardForEntities(request: GetLeaderboardForEntitiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetEntityLeaderboardResponse>;
+    /**
+     * Get current statistic definition information
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinition
+     */
+    GetStatisticDefinition(request: GetStatisticDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStatisticDefinitionResponse>;
+    /**
+     * Gets statistics for the specified entity.
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatistics
+     */
+    GetStatistics(request: GetStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStatisticsResponse>;
+    /**
+     * Gets statistics for the specified collection of entities.
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticsforentities
+     */
+    GetStatisticsForEntities(request: GetStatisticsForEntitiesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<GetStatisticsForEntitiesResponse>;
+    /**
+     * Increment a leaderboard version.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/incrementleaderboardversion
+     */
+    IncrementLeaderboardVersion(request: IncrementLeaderboardVersionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IncrementLeaderboardVersionResponse>;
+    /**
+     * Increment an entity statistic definition version.
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/incrementstatisticversion
+     */
+    IncrementStatisticVersion(request: IncrementStatisticVersionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<IncrementStatisticVersionResponse>;
+    /**
+     * Lists the leaderboard definitions defined for the Title.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/listleaderboarddefinitions
+     */
+    ListLeaderboardDefinitions(request: ListLeaderboardDefinitionsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<ListLeaderboardDefinitionsResponse>;
+    /**
+     * Get all current statistic definitions information
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/liststatisticdefinitions
+     */
+    ListStatisticDefinitions(request: ListStatisticDefinitionsRequest, customData?: any, 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
+     */
+    UnlinkLeaderboardFromStatistic(request: UnlinkLeaderboardFromStatisticRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Updates a leaderboard definition.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboarddefinition
+     */
+    UpdateLeaderboardDefinition(request: UpdateLeaderboardDefinitionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Adds or updates entries on the specified leaderboard.
+     * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboardentries
+     */
+    UpdateLeaderboardEntries(request: UpdateLeaderboardEntriesRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Update an existing entity statistic definition.
+     * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatisticdefinition
+     */
+    UpdateStatisticDefinition(request: UpdateStatisticDefinitionRequest, customData?: any, 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
+     */
+    UpdateStatistics(request: UpdateStatisticsRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<UpdateStatisticsResponse>;
+}
+
+export { PlayFabProgressionApi as default };