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

package/dist/Client.d.ts

@@ -2,7 +2,7 @@ import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabComm
 
 interface AcceptTradeRequest extends IPlayFabRequestCommon {
     /**
-     * Items from the accepting player's inventory in exchange for the offered items in the trade. In the case of a gift, this
+     * Items from the accepting player's inventory in exchange for the offered items in the trade. In the case of a gift, this
      * will be null.
      */
     AcceptedInventoryInstanceIds?: string[];
@@ -24,13 +24,13 @@ interface AdCampaignAttributionModel {
     Platform?: string;
 }
 interface AddFriendRequest extends IPlayFabRequestCommon {
-    /** Email address of the user to attempt to add to the local user's friend list. */
+    /** Email address of the user to attempt to add to the local user's friend list. */
     FriendEmail?: string;
-    /** PlayFab identifier of the user to attempt to add to the local user's friend list. */
+    /** PlayFab identifier of the user to attempt to add to the local user's friend list. */
     FriendPlayFabId?: string;
-    /** Title-specific display name of the user to attempt to add to the local user's friend list. */
+    /** Title-specific display name of the user to attempt to add to the local user's friend list. */
     FriendTitleDisplayName?: string;
-    /** PlayFab username of the user to attempt to add to the local user's friend list. */
+    /** PlayFab username of the user to attempt to add to the local user's friend list. */
     FriendUsername?: string;
 }
 interface AddFriendResult extends IPlayFabResultCommon {
@@ -133,6 +133,11 @@ interface AndroidDevicePushNotificationRegistrationResult extends IPlayFabResult
 interface AttributeInstallRequest extends IPlayFabRequestCommon {
     /** The adid for this device. */
     Adid?: string;
+    /**
+     * The android advertising id. This field is deprecated in favor of Adid for clarity.
+     * @deprecated Please use Adid instead.
+     */
+    Android_Id?: string;
     /** The IdentifierForAdvertisers for iOS Devices. */
     Idfa?: string;
 }
@@ -223,7 +228,7 @@ interface CatalogItem {
     RealCurrencyPrices?: Record<string, number>;
     /** list of item tags */
     Tags?: string[];
-    /** price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
+    /** price of this item in virtual currencies and &quot;RM&quot; (the base Real Money purchase price, in USD pennies) */
     VirtualCurrencyPrices?: Record<string, number>;
 }
 interface CatalogItemBundleInfo {
@@ -243,7 +248,7 @@ interface CatalogItemConsumableInfo {
     /**
      * duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
      * (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
-     * this item's details have completed)
+     * this item&#39;s details have completed)
      */
     UsagePeriod?: number;
     /**
@@ -285,9 +290,9 @@ interface CharacterLeaderboardEntry {
     DisplayName?: string;
     /** PlayFab unique identifier of the user for this leaderboard entry. */
     PlayFabId?: string;
-    /** User's overall position in the leaderboard. */
+    /** User&#39;s overall position in the leaderboard. */
     Position: number;
-    /** Specific value of the user's statistic. */
+    /** Specific value of the user&#39;s statistic. */
     StatValue: number;
 }
 interface CharacterResult {
@@ -298,6 +303,16 @@ interface CharacterResult {
     /** The type-string that was given to this character on creation. */
     CharacterType?: string;
 }
+/** @deprecated Do not use */
+interface CollectionFilter {
+    /** List of Exclude rules, with any of which if a collection matches, it is excluded by the filter. */
+    Excludes?: Container_Dictionary_String_String[];
+    /**
+     * List of Include rules, with any of which if a collection matches, it is included by the filter, unless it is excluded by
+     * one of the Exclude rule
+     */
+    Includes?: Container_Dictionary_String_String[];
+}
 interface ConfirmPurchaseRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -369,7 +384,7 @@ interface ConsumeXboxEntitlementsRequest extends IPlayFabRequestCommon {
     CatalogVersion?: string;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
+    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). */
     XboxToken: string;
 }
 interface ConsumeXboxEntitlementsResult extends IPlayFabResultCommon {
@@ -384,6 +399,11 @@ interface ContactEmailInfoModel {
     /** The verification status of the email */
     VerificationStatus?: string;
 }
+/** @deprecated Do not use */
+interface Container_Dictionary_String_String {
+    /** Content of data */
+    Data?: Record<string, string | null>;
+}
 interface CreateSharedGroupRequest extends IPlayFabRequestCommon {
     /** Unique identifier for the shared group (a random identifier will be assigned, if one is not specified). */
     SharedGroupId?: string;
@@ -392,10 +412,32 @@ interface CreateSharedGroupResult extends IPlayFabResultCommon {
     /** Unique identifier for the shared group. */
     SharedGroupId?: string;
 }
+/** @deprecated Do not use */
+interface CurrentGamesRequest extends IPlayFabRequestCommon {
+    /** Build to match against. */
+    BuildVersion?: string;
+    /** Game mode to look for. */
+    GameMode?: string;
+    /** Region to check for Game Server Instances. */
+    Region?: string;
+    /** Statistic name to find statistic-based matches. */
+    StatisticName?: string;
+    /** Filter to include and/or exclude Game Server Instances associated with certain tags. */
+    TagFilter?: CollectionFilter;
+}
+/** @deprecated Do not use */
+interface CurrentGamesResult extends IPlayFabResultCommon {
+    /** number of games running */
+    GameCount: number;
+    /** array of games found */
+    Games?: GameInfo[];
+    /** total number of players across all servers */
+    PlayerCount: number;
+}
 interface CustomPropertyDetails {
-    /** The custom property's name. */
+    /** The custom property&#39;s name. */
     Name?: string;
-    /** The custom property's value. */
+    /** The custom property&#39;s value. */
     Value?: any;
 }
 interface DeletedPropertyDetails {
@@ -409,7 +451,7 @@ interface DeletePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /**
      * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the
-     * player's properties have not been updated by any other clients since the last version.
+     * player&#39;s properties have not been updated by any other clients since the last version.
      */
     ExpectedPropertiesVersion?: number;
     /** A list of property names denoting which properties should be deleted. */
@@ -419,7 +461,7 @@ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
     /** The list of properties requested to be deleted. */
     DeletedProperties?: DeletedPropertyDetails[];
     /**
-     * Indicates the current version of a player's properties that have been set. This is incremented after updates and
+     * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
      * deletes. This version can be provided in update and delete calls for concurrency control.
      */
     PropertiesVersion: number;
@@ -435,6 +477,11 @@ 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 EntityTokenResponse {
     /** The entity id and type. */
@@ -452,17 +499,17 @@ interface ExecuteCloudScriptRequest extends IPlayFabRequestCommon {
     /** Object that is passed in to the function as the first argument */
     FunctionParameter?: any;
     /**
-     * Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other
+     * Generate a &#39;player_executed_cloudscript&#39; PlayStream event containing the results of the function execution and other
      * contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
      */
     GeneratePlayStreamEvent?: boolean;
     /**
-     * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
-     * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
-     * 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.
+     * Option for which revision of the CloudScript to execute. &#39;Latest&#39; executes the most recently created revision, &#39;Live&#39;
+     * executes the current live, published revision, and &#39;Specific&#39; executes the specified revision. The default value is
+     * &#39;Specific&#39;, if the SpeificRevision parameter is specified, otherwise it is &#39;Live&#39;.
      */
     RevisionSelection?: string;
-    /** The specivic revision to execute, when RevisionSelection is set to 'Specific' */
+    /** The specivic revision to execute, when RevisionSelection is set to &#39;Specific&#39; */
     SpecificRevision?: number;
 }
 interface ExecuteCloudScriptResult extends IPlayFabResultCommon {
@@ -514,6 +561,11 @@ interface FacebookPlayFabIdPair {
     PlayFabId?: string;
 }
 interface FriendInfo {
+    /**
+     * This field is not populated.
+     * @deprecated Do not use
+     */
+    CurrentMatchmakerLobbyId?: string;
     /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */
     FacebookInfo?: UserFacebookInfo;
     /** PlayFab unique identifier for this friend. */
@@ -547,6 +599,66 @@ interface GameCenterPlayFabIdPair {
     /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Game Center identifier. */
     PlayFabId?: string;
 }
+/** @deprecated Do not use */
+interface GameInfo {
+    /** build version this server is running */
+    BuildVersion?: string;
+    /** game mode this server is running */
+    GameMode?: string;
+    /** game session custom data */
+    GameServerData?: string;
+    /**
+     * game specific string denoting server configuration
+     * @deprecated Please use GameServerStateEnum instead.
+     */
+    GameServerState?: number;
+    /** game specific string denoting server configuration */
+    GameServerStateEnum?: string;
+    /** last heartbeat of the game server instance, used in external game server provider mode */
+    LastHeartbeat?: string;
+    /** unique lobby identifier for this game server */
+    LobbyID?: string;
+    /** maximum players this server can support */
+    MaxPlayers?: number;
+    /** array of current player IDs on this server */
+    PlayerUserIds?: string[];
+    /** region to which this server is associated */
+    Region?: string;
+    /** duration in seconds this server has been running */
+    RunTime: number;
+    /**
+     * IPV4 address of the server
+     * @deprecated Please use ServerIPV4Address instead.
+     */
+    ServerHostname?: string;
+    /** IPV4 address of the server */
+    ServerIPV4Address?: string;
+    /** IPV6 address of the server */
+    ServerIPV6Address?: string;
+    /** port number to use for non-http communications with the server */
+    ServerPort?: number;
+    /** Public DNS name (if any) of the server */
+    ServerPublicDNSName?: string;
+    /** stastic used to match this game in player statistic matchmaking */
+    StatisticName?: string;
+    /** game session tags */
+    Tags?: Record<string, string | null>;
+}
+/** @deprecated Do not use */
+interface GameServerRegionsRequest extends IPlayFabRequestCommon {
+    /** version of game server for which stats are being requested */
+    BuildVersion: string;
+    /**
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
+     * title has been selected.
+     */
+    TitleId?: string;
+}
+/** @deprecated Do not use */
+interface GameServerRegionsResult extends IPlayFabResultCommon {
+    /** array of regions found matching the request parameters */
+    Regions?: RegionInfo[];
+}
 interface GenericPlayFabIdPair {
     /** Unique generic service identifier for a user. */
     GenericId?: GenericServiceId;
@@ -640,6 +752,11 @@ interface GetCharacterInventoryResult extends IPlayFabResultCommon {
     VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
 }
 interface GetCharacterLeaderboardRequest extends IPlayFabRequestCommon {
+    /**
+     * Optional character type on which to filter the leaderboard entries.
+     * @deprecated Do not use
+     */
+    CharacterType?: string;
     /** Maximum number of entries to retrieve. Default 10, maximum 100. */
     MaxResultsCount?: number;
     /** First entry in the leaderboard to be retrieved. */
@@ -659,6 +776,21 @@ interface GetCharacterStatisticsResult extends IPlayFabResultCommon {
     /** The requested character statistics. */
     CharacterStatistics?: Record<string, number>;
 }
+/** @deprecated Do not use */
+interface GetCloudScriptUrlRequest extends IPlayFabRequestCommon {
+    /**
+     * Specifies whether the URL returned should be the one for the most recently uploaded Revision of the Cloud Script (true),
+     * or the Revision most recently set to live (false). Defaults to false.
+     */
+    Testing?: boolean;
+    /** Cloud Script Version to use. Defaults to 1. */
+    Version?: number;
+}
+/** @deprecated Do not use */
+interface GetCloudScriptUrlResult extends IPlayFabResultCommon {
+    /** URL of the Cloud Script logic server. */
+    Url?: string;
+}
 interface GetContentDownloadUrlRequest extends IPlayFabRequestCommon {
     /** HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET. */
     HttpMethod?: string;
@@ -674,14 +806,59 @@ interface GetContentDownloadUrlResult extends IPlayFabResultCommon {
     /** URL for downloading content via HTTP GET or HEAD method. The URL will expire in approximately one hour. */
     URL?: string;
 }
+/** @deprecated Do not use */
+interface GetFriendLeaderboardAroundCurrentUserRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Indicates which other platforms&#39; friends should be included in the response. In HTTP, it is represented as a
+     * comma-separated list of platforms.
+     */
+    ExternalPlatformFriends?: string;
+    /**
+     * Indicates whether Facebook friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeFacebookFriends?: boolean;
+    /**
+     * Indicates whether Steam service friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeSteamFriends?: boolean;
+    /** Maximum number of entries to retrieve. Default 10, maximum 100. */
+    MaxResultsCount?: number;
+    /** Statistic used to rank players for this leaderboard. */
+    StatisticName: string;
+    /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
+    XboxToken?: string;
+}
+/** @deprecated Do not use */
+interface GetFriendLeaderboardAroundCurrentUserResult extends IPlayFabResultCommon {
+    /** Ordered listing of users and their positions in the requested leaderboard. */
+    Leaderboard?: PlayerLeaderboardEntry[];
+    /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
+    NextReset?: string;
+    /** The version of the leaderboard returned. */
+    Version: number;
+}
 interface GetFriendLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
-     * 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.
      */
     ExternalPlatformFriends?: string;
+    /**
+     * Indicates whether Facebook friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeFacebookFriends?: boolean;
+    /**
+     * Indicates whether Steam service friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeSteamFriends?: boolean;
     /** Maximum number of entries to retrieve. Default 10, maximum 100. */
     MaxResultsCount?: number;
     /** 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
     /**
      * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
      * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
-     * the Game Manager "Client Profile Options" tab in the "Settings" section.
+     * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
      */
     ProfileConstraints?: PlayerProfileViewConstraints;
     /** Statistic used to rank players for this leaderboard. */
     StatisticName: string;
+    /** If set to false, Version is considered null. If true, uses the specified Version */
+    UseSpecificVersion?: boolean;
     /** The version of the leaderboard to get. */
     Version?: number;
     /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
@@ -711,22 +890,34 @@ interface GetFriendLeaderboardRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
-     * 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.
      */
     ExternalPlatformFriends?: string;
+    /**
+     * Indicates whether Facebook friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeFacebookFriends?: boolean;
+    /**
+     * Indicates whether Steam service friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeSteamFriends?: boolean;
     /** Maximum number of entries to retrieve. Default 10, maximum 100. */
     MaxResultsCount?: number;
     /**
      * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
      * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
-     * the Game Manager "Client Profile Options" tab in the "Settings" section.
+     * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
      */
     ProfileConstraints?: PlayerProfileViewConstraints;
     /** Position in the leaderboard to start this listing (defaults to the first entry). */
     StartPosition: number;
     /** Statistic used to rank friends for this leaderboard. */
     StatisticName: string;
+    /** If set to false, Version is considered null. If true, uses the specified Version */
+    UseSpecificVersion?: boolean;
     /** The version of the leaderboard to get. */
     Version?: number;
     /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
@@ -736,14 +927,24 @@ interface GetFriendsListRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
-     * 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.
      */
     ExternalPlatformFriends?: string;
+    /**
+     * Indicates whether Facebook friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeFacebookFriends?: boolean;
+    /**
+     * Indicates whether Steam service friends should be included in the response. Default is true.
+     * @deprecated Please use ExternalPlatformFriends instead.
+     */
+    IncludeSteamFriends?: boolean;
     /**
      * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
      * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
-     * the Game Manager "Client Profile Options" tab in the "Settings" section.
+     * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
      */
     ProfileConstraints?: PlayerProfileViewConstraints;
     /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */
@@ -756,6 +957,11 @@ interface GetFriendsListResult extends IPlayFabResultCommon {
 interface GetLeaderboardAroundCharacterRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID for a specific character on which to center the leaderboard. */
     CharacterId: string;
+    /**
+     * Optional character type on which to filter the leaderboard entries.
+     * @deprecated Do not use
+     */
+    CharacterType?: string;
     /** Maximum number of entries to retrieve. Default 10, maximum 100. */
     MaxResultsCount?: number;
     /** Unique identifier for the title-specific statistic for the leaderboard. */
@@ -765,6 +971,24 @@ interface GetLeaderboardAroundCharacterResult extends IPlayFabResultCommon {
     /** Ordered list of leaderboard entries. */
     Leaderboard?: CharacterLeaderboardEntry[];
 }
+/** @deprecated Do not use */
+interface GetLeaderboardAroundCurrentUserRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Maximum number of entries to retrieve. Default 10, maximum 100. */
+    MaxResultsCount?: number;
+    /** Statistic used to rank players for this leaderboard. */
+    StatisticName: string;
+}
+/** @deprecated Do not use */
+interface GetLeaderboardAroundCurrentUserResult extends IPlayFabResultCommon {
+    /** Ordered listing of users and their positions in the requested leaderboard. */
+    Leaderboard?: PlayerLeaderboardEntry[];
+    /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */
+    NextReset?: string;
+    /** The version of the leaderboard returned. */
+    Version: number;
+}
 interface GetLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -775,11 +999,13 @@ interface GetLeaderboardAroundPlayerRequest extends IPlayFabRequestCommon {
     /**
      * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
      * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
-     * the Game Manager "Client Profile Options" tab in the "Settings" section.
+     * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
      */
     ProfileConstraints?: PlayerProfileViewConstraints;
     /** Statistic used to rank players for this leaderboard. */
     StatisticName: string;
+    /** If set to false, Version is considered null. If true, uses the specified Version */
+    UseSpecificVersion?: boolean;
     /** The version of the leaderboard to get. */
     Version?: number;
 }
@@ -792,6 +1018,11 @@ interface GetLeaderboardAroundPlayerResult extends IPlayFabResultCommon {
     Version: number;
 }
 interface GetLeaderboardForUsersCharactersRequest extends IPlayFabRequestCommon {
+    /**
+     * Maximum number of entries to retrieve.
+     * @deprecated Please use  instead.
+     */
+    MaxResultsCount?: number;
     /** Unique identifier for the title-specific statistic for the leaderboard. */
     StatisticName: string;
 }
@@ -807,13 +1038,15 @@ interface GetLeaderboardRequest extends IPlayFabRequestCommon {
     /**
      * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
      * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
-     * the Game Manager "Client Profile Options" tab in the "Settings" section.
+     * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
      */
     ProfileConstraints?: PlayerProfileViewConstraints;
     /** Position in the leaderboard to start this listing (defaults to the first entry). */
     StartPosition: number;
     /** Statistic used to rank players for this leaderboard. */
     StatisticName: string;
+    /** If set to false, Version is considered null. If true, uses the specified Version */
+    UseSpecificVersion?: boolean;
     /** The version of the leaderboard to get. */
     Version?: number;
 }
@@ -830,7 +1063,7 @@ interface GetPaymentTokenRequest extends IPlayFabRequestCommon {
     TokenProvider: string;
 }
 interface GetPaymentTokenResult extends IPlayFabResultCommon {
-    /** PlayFab's purchase order identifier. */
+    /** PlayFab&#39;s purchase order identifier. */
     OrderId?: string;
     /** The token from provider. */
     ProviderToken?: string;
@@ -862,19 +1095,19 @@ interface GetPlayerCombinedInfoRequestParams {
     GetPlayerStatistics: boolean;
     /** Whether to get title data. Defaults to false. */
     GetTitleData: boolean;
-    /** Whether to get the player's account Info. Defaults to false */
+    /** Whether to get the player&#39;s account Info. Defaults to false */
     GetUserAccountInfo: boolean;
-    /** Whether to get the player's custom data. Defaults to false */
+    /** Whether to get the player&#39;s custom data. Defaults to false */
     GetUserData: boolean;
-    /** Whether to get the player's inventory. Defaults to false */
+    /** Whether to get the player&#39;s inventory. Defaults to false */
     GetUserInventory: boolean;
-    /** Whether to get the player's read only data. Defaults to false */
+    /** Whether to get the player&#39;s read only data. Defaults to false */
     GetUserReadOnlyData: boolean;
-    /** Whether to get the player's virtual currency balances. Defaults to false */
+    /** Whether to get the player&#39;s virtual currency balances. Defaults to false */
     GetUserVirtualCurrency: boolean;
     /** Specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false */
     PlayerStatisticNames?: string[];
-    /** Specifies the properties to return from the player profile. Defaults to returning the player's display name. */
+    /** Specifies the properties to return from the player profile. Defaults to returning the player&#39;s display name. */
     ProfileConstraints?: PlayerProfileViewConstraints;
     /** Specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false */
     TitleDataKeys?: string[];
@@ -912,7 +1145,7 @@ interface GetPlayerCombinedInfoResultPayload {
     UserData?: Record<string, UserDataRecord>;
     /** The version of the UserData that was returned. */
     UserDataVersion: number;
-    /** Array of inventory items in the user's current inventory. */
+    /** Array of inventory items in the user&#39;s current inventory. */
     UserInventory?: ItemInstance[];
     /** User specific read-only data. */
     UserReadOnlyData?: Record<string, UserDataRecord>;
@@ -924,12 +1157,12 @@ interface GetPlayerCombinedInfoResultPayload {
     UserVirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
 }
 interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
-    /** Specific property name to search for in the player's properties. */
+    /** Specific property name to search for in the player&#39;s properties. */
     PropertyName: string;
 }
 interface GetPlayerCustomPropertyResult extends IPlayFabResultCommon {
     /**
-     * Indicates the current version of a player's properties that have been set. This is incremented after updates and
+     * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
      * deletes. This version can be provided in update and delete calls for concurrency control.
      */
     PropertiesVersion: number;
@@ -944,7 +1177,7 @@ interface GetPlayerProfileRequest extends IPlayFabRequestCommon {
     /**
      * If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
      * only the allowed client profile properties for the title may be requested. These allowed properties are configured in
-     * the Game Manager "Client Profile Options" tab in the "Settings" section.
+     * the Game Manager &quot;Client Profile Options&quot; tab in the &quot;Settings&quot; section.
      */
     ProfileConstraints?: PlayerProfileViewConstraints;
 }
@@ -997,7 +1230,7 @@ interface GetPlayerTagsRequest extends IPlayFabRequestCommon {
 interface GetPlayerTagsResult extends IPlayFabResultCommon {
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
-    /** Canonical tags (including namespace and tag's name) for the requested user */
+    /** Canonical tags (including namespace and tag&#39;s name) for the requested user */
     Tags: string[];
 }
 interface GetPlayerTradesRequest extends IPlayFabRequestCommon {
@@ -1089,7 +1322,7 @@ interface GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult extends IPlayFabResult
 }
 interface GetPlayFabIDsFromKongregateIDsRequest extends IPlayFabRequestCommon {
     /**
-     * Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The
+     * Array of unique Kongregate identifiers (Kongregate&#39;s user_id) for which the title needs to get PlayFab identifiers. The
      * array cannot exceed 2,000 in length.
      */
     KongregateIDs: string[];
@@ -1147,6 +1380,11 @@ interface GetPlayFabIDsFromPSNOnlineIDsResult extends IPlayFabResultCommon {
     Data?: PSNOnlinePlayFabIdPair[];
 }
 interface GetPlayFabIDsFromSteamIDsRequest extends IPlayFabRequestCommon {
+    /**
+     * Deprecated: Please use SteamStringIDs
+     * @deprecated Please use SteamStringIDs instead.
+     */
+    SteamIDs?: number[];
     /**
      * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array
      * cannot exceed 2,000 in length.
@@ -1170,7 +1408,7 @@ interface GetPlayFabIDsFromSteamNamesResult extends IPlayFabResultCommon {
 }
 interface GetPlayFabIDsFromTwitchIDsRequest extends IPlayFabRequestCommon {
     /**
-     * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot
+     * Array of unique Twitch identifiers (Twitch&#39;s _id) for which the title needs to get PlayFab identifiers. The array cannot
      * exceed 2,000 in length.
      */
     TwitchIds: string[];
@@ -1205,6 +1443,11 @@ interface GetPurchaseRequest extends IPlayFabRequestCommon {
     OrderId: string;
 }
 interface GetPurchaseResult extends IPlayFabResultCommon {
+    /**
+     * Array of items purchased.
+     * @deprecated Please use  instead.
+     */
+    Items?: ItemInstance[];
     /** Purchase order identifier. */
     OrderId?: string;
     /** Payment provider used for transaction (If not VC) */
@@ -1288,7 +1531,7 @@ interface GetTitleNewsResult extends IPlayFabResultCommon {
 }
 interface GetTitlePublicKeyRequest extends IPlayFabRequestCommon {
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId: string;
@@ -1296,7 +1539,7 @@ interface GetTitlePublicKeyRequest extends IPlayFabRequestCommon {
     TitleSharedSecret: string;
 }
 interface GetTitlePublicKeyResult extends IPlayFabResultCommon {
-    /** Base64 encoded RSA CSP byte array blob containing the title's public RSA key */
+    /** Base64 encoded RSA CSP byte array blob containing the title&#39;s public RSA key */
     RSAPublicKey?: string;
 }
 interface GetTradeStatusRequest extends IPlayFabRequestCommon {
@@ -1309,6 +1552,69 @@ interface GetTradeStatusResponse extends IPlayFabResultCommon {
     /** Information about the requested trade. */
     Trade?: TradeInfo;
 }
+/** @deprecated Do not use */
+interface GetUserCombinedInfoRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** User email address for the account to find (if no Username is specified). */
+    Email?: string;
+    /** If set to false, account info will not be returned. Defaults to true. */
+    GetAccountInfo?: boolean;
+    /**
+     * If set to false, inventory will not be returned. Defaults to true. Inventory will never be returned for users other than
+     * yourself.
+     */
+    GetInventory?: boolean;
+    /** If set to false, read-only user data will not be returned. Defaults to true. */
+    GetReadOnlyData?: boolean;
+    /** If set to false, custom user data will not be returned. Defaults to true. */
+    GetUserData?: boolean;
+    /**
+     * If set to false, virtual currency balances will not be returned. Defaults to true. Currency balances will never be
+     * returned for users other than yourself.
+     */
+    GetVirtualCurrency?: boolean;
+    /**
+     * Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no
+     * other lookup identifier set.
+     */
+    PlayFabId?: string;
+    /**
+     * User read-only custom data keys to return. If set to null, all keys will be returned. For users other than yourself,
+     * only public data will be returned.
+     */
+    ReadOnlyDataKeys?: string[];
+    /** Title-specific username for the account to find (if no Email is set). */
+    TitleDisplayName?: string;
+    /**
+     * User custom data keys to return. If set to null, all keys will be returned. For users other than yourself, only public
+     * data will be returned.
+     */
+    UserDataKeys?: string[];
+    /** PlayFab Username for the account to find (if no PlayFabId is specified). */
+    Username?: string;
+}
+/** @deprecated Do not use */
+interface GetUserCombinedInfoResult extends IPlayFabResultCommon {
+    /** Account information for the user. */
+    AccountInfo?: UserAccountInfo;
+    /** User specific custom data. */
+    Data?: Record<string, UserDataRecord>;
+    /** The version of the UserData that was returned. */
+    DataVersion: number;
+    /** Array of inventory items in the user&#39;s current inventory. */
+    Inventory?: ItemInstance[];
+    /** Unique PlayFab identifier of the owner of the combined info. */
+    PlayFabId?: string;
+    /** User specific read-only data. */
+    ReadOnlyData?: Record<string, UserDataRecord>;
+    /** The version of the Read-Only UserData that was returned. */
+    ReadOnlyDataVersion: number;
+    /** Array of virtual currency balance(s) belonging to the user. */
+    VirtualCurrency?: Record<string, number>;
+    /** Array of remaining times and timestamps for virtual currencies. */
+    VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
+}
 interface GetUserDataRequest extends IPlayFabRequestCommon {
     /**
      * 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 {
     /** Array of remaining times and timestamps for virtual currencies. */
     VirtualCurrencyRechargeTimes?: Record<string, VirtualCurrencyRechargeTime>;
 }
+/** @deprecated Do not use */
+interface GetUserStatisticsRequest 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 GetUserStatisticsResult extends IPlayFabResultCommon {
+    /** User statistics for the active title. */
+    UserStatistics?: Record<string, number>;
+}
 interface GooglePlayFabIdPair {
     /** Unique Google identifier for a user. */
     GoogleId?: string;
@@ -1364,7 +1680,7 @@ interface GrantCharacterToUserRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
-     * Catalog item identifier of the item in the user's inventory that corresponds to the character in the catalog to be
+     * Catalog item identifier of the item in the user&#39;s inventory that corresponds to the character in the catalog to be
      * created.
      */
     ItemId: string;
@@ -1391,7 +1707,7 @@ interface ItemInstance {
     CatalogVersion?: string;
     /**
      * A set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
-     * item's custom data.
+     * item&#39;s custom data.
      */
     CustomData?: Record<string, string | null>;
     /** CatalogItem.DisplayName at the time this item was purchased. */
@@ -1422,7 +1738,7 @@ interface ItemPurchaseRequest {
     ItemId: string;
     /** How many of this item to purchase. Min 1, maximum 25. */
     Quantity: number;
-    /** Items to be upgraded as a result of this purchase (upgraded items are hidden, as they are "replaced" by the new items). */
+    /** Items to be upgraded as a result of this purchase (upgraded items are hidden, as they are &quot;replaced&quot; by the new items). */
     UpgradeFromItems?: string[];
 }
 interface KongregatePlayFabIdPair {
@@ -1432,15 +1748,15 @@ interface KongregatePlayFabIdPair {
     PlayFabId?: string;
 }
 interface LinkAndroidDeviceIDRequest extends IPlayFabRequestCommon {
-    /** Specific model of the user's device. */
+    /** Specific model of the user&#39;s device. */
     AndroidDevice?: string;
-    /** Android device identifier for the user's device. */
+    /** Android device identifier for the user&#39;s device. */
     AndroidDeviceId: string;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /** If another user is already linked to the device, unlink the other user and re-link. */
     ForceLink?: boolean;
-    /** Specific Operating System version for the user's device. */
+    /** Specific Operating System version for the user&#39;s device. */
     OS?: string;
 }
 interface LinkAndroidDeviceIDResult extends IPlayFabResultCommon {
@@ -1522,13 +1838,18 @@ interface LinkGameCenterAccountRequest extends IPlayFabRequestCommon {
     Signature?: string;
     /**
      * The integer representation of date and time that the signature was created on. PlayFab will reject authentication
-     * signatures not within 10 minutes of the server's current time.
+     * signatures not within 10 minutes of the server&#39;s current time.
      */
     Timestamp?: string;
 }
 interface LinkGameCenterAccountResult extends IPlayFabResultCommon {
 }
 interface LinkGoogleAccountRequest extends IPlayFabRequestCommon {
+    /**
+     * OAuth 2.0 access token obtained on the client by calling the getAccessToken() Google client API.
+     * @deprecated Please use ServerAuthCode instead.
+     */
+    AccessToken?: string;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
@@ -1563,13 +1884,13 @@ interface LinkGooglePlayGamesServicesAccountResult extends IPlayFabResultCommon
 interface LinkIOSDeviceIDRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Vendor-specific iOS identifier for the user's device. */
+    /** Vendor-specific iOS identifier for the user&#39;s device. */
     DeviceId: string;
-    /** Specific model of the user's device. */
+    /** Specific model of the user&#39;s device. */
     DeviceModel?: string;
     /** If another user is already linked to the device, unlink the other user and re-link. */
     ForceLink?: boolean;
-    /** Specific Operating System version for the user's device. */
+    /** Specific Operating System version for the user&#39;s device. */
     OS?: string;
 }
 interface LinkIOSDeviceIDResult extends IPlayFabResultCommon {
@@ -1602,7 +1923,7 @@ interface LinkNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link. */
     ForceLink?: boolean;
-    /** Nintendo Switch unique identifier for the user's device. */
+    /** Nintendo Switch unique identifier for the user&#39;s device. */
     NintendoSwitchDeviceId: string;
 }
 interface LinkNintendoSwitchDeviceIdResult extends IPlayFabResultCommon {
@@ -1616,7 +1937,7 @@ interface LinkOpenIdConnectRequest extends IPlayFabRequestCommon {
     ForceLink?: boolean;
     /**
      * The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the
-     * identity provider's response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.
+     * identity provider&#39;s response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.
      */
     IdToken: string;
 }
@@ -1641,11 +1962,11 @@ interface LinkSteamAccountRequest extends IPlayFabRequestCommon {
     ForceLink?: boolean;
     /**
      * Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte
-     * 0x08 should become "08").
+     * 0x08 should become &quot;08&quot;).
      */
     SteamTicket: string;
     /**
-     * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string.
+     * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using &quot;AzurePlayFab&quot; as the identity string.
      * False if the ticket was generated with ISteamUser::GetAuthSessionTicket().
      */
     TicketIsServiceSpecific?: boolean;
@@ -1667,7 +1988,7 @@ interface LinkXboxAccountRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** If another user is already linked to the account, unlink the other user and re-link. */
     ForceLink?: boolean;
-    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
+    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). */
     XboxToken: string;
 }
 interface LinkXboxAccountResult extends IPlayFabResultCommon {
@@ -1678,7 +1999,7 @@ interface ListPlayerCustomPropertiesResult extends IPlayFabResultCommon {
     /** Player specific properties and their corresponding values for this title. */
     Properties?: CustomPropertyDetails[];
     /**
-     * Indicates the current version of a player's properties that have been set. This is incremented after updates and
+     * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
      * deletes. This version can be provided in update and delete calls for concurrency control.
      */
     PropertiesVersion: number;
@@ -1703,6 +2024,30 @@ interface LocationModel {
     /** Longitude coordinate of the geographic location. */
     Longitude?: number;
 }
+/** @deprecated Do not use */
+interface LogEventRequest extends IPlayFabRequestCommon {
+    /**
+     * Contains all the data for this event. Event Values can be strings, booleans or numerics (float, double, integer, long)
+     * 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
+     * sent, it must be an integer in all subsequent &#39;Foo&#39; events). As with event names, Keys must also not use reserved words
+     * (see above). Finally, the size of the Body for an event must be less than 32KB (UTF-8 format).
+     */
+    Body?: Record<string, any>;
+    /**
+     * A unique event name which will be used as the table name in the Redshift database. The name will be made lower case, and
+     * cannot not contain spaces. The use of underscores is recommended, for readability. Events also cannot match reserved
+     * 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
+     * can be found here: http://docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html.
+     */
+    EventName?: string;
+    /** Flag to set event Body as profile details in the Redshift database as well as a standard event. */
+    ProfileSetEvent: boolean;
+    /** Optional timestamp for this event. If null, the a timestamp is auto-assigned to the event on the server. */
+    Timestamp?: string;
+}
+/** @deprecated Do not use */
+interface LogEventResult extends IPlayFabResultCommon {
+}
 interface LoginResult extends IPlayFabResultCommon {
     /**
      * 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 {
     EntityToken?: EntityTokenResponse;
     /** Results for requested info. */
     InfoResultPayload?: GetPlayerCombinedInfoResultPayload;
-    /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */
+    /** The time of this user&#39;s previous login. If there was no previous login, then it&#39;s DateTime.MinValue */
     LastLoginTime?: string;
     /** True if the master_player_account was newly created on this login. */
     NewlyCreated: boolean;
-    /** Player's unique PlayFabId. */
+    /** Player&#39;s unique PlayFabId. */
     PlayFabId?: string;
     /** Unique token authorizing the user and game at the server level, for the current session. */
     SessionTicket?: string;
@@ -1725,24 +2070,29 @@ interface LoginResult extends IPlayFabResultCommon {
     TreatmentAssignment?: TreatmentAssignment;
 }
 interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
-    /** Specific model of the user's device. */
+    /** Specific model of the user&#39;s device. */
     AndroidDevice?: string;
-    /** Android device identifier for the user's device. */
+    /** Android device identifier for the user&#39;s device. */
     AndroidDeviceId?: string;
     /** Automatically create a PlayFab account if one is not currently linked to this ID. */
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
-    /** Specific Operating System version for the user's device. */
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
+    /** Specific Operating System version for the user&#39;s device. */
     OS?: string;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1752,7 +2102,7 @@ interface LoginWithAppleRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /**
      * 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 {
     IdentityToken: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1775,16 +2130,21 @@ interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** The JSON Web Token (JWT) returned by Battle.net after login */
     IdentityToken: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1796,14 +2156,19 @@ interface LoginWithCustomIDRequest extends IPlayFabRequestCommon {
     CustomId?: string;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1815,10 +2180,15 @@ interface LoginWithEmailAddressRequest extends IPlayFabRequestCommon {
     Email: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Password for the PlayFab account (6-100 characters) */
     Password: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1828,16 +2198,21 @@ interface LoginWithFacebookInstantGamesIdRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Facebook Instant Games signature for the user. */
     FacebookInstantGamesSignature: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1851,14 +2226,19 @@ interface LoginWithFacebookRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1868,10 +2248,15 @@ interface LoginWithGameCenterRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Unique Game Center player id. */
     PlayerId?: string;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
@@ -1884,26 +2269,41 @@ interface LoginWithGameCenterRequest extends IPlayFabRequestCommon {
     Signature?: string;
     /**
      * The integer representation of date and time that the signature was created on. PlayFab will reject authentication
-     * signatures not within 10 minutes of the server's current time.
+     * signatures not within 10 minutes of the server&#39;s current time.
      */
     Timestamp?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
 }
 interface LoginWithGoogleAccountRequest extends IPlayFabRequestCommon {
+    /**
+     * OAuth 2.0 access token obtained on the client by calling the getAccessToken() Google client API.
+     * @deprecated Please use ServerAuthCode instead.
+     */
+    AccessToken?: string;
     /** Automatically create a PlayFab account if one is not currently linked to this ID. */
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
+    /**
+     * Deprecated - Do not use
+     * @deprecated Do not use
+     */
+    PublisherId?: string;
     /**
      * OAuth 2.0 server authentication code obtained on the client by calling the getServerAuthCode()
      * (https://developers.google.com/identity/sign-in/android/offline-access) Google client API.
@@ -1912,7 +2312,7 @@ interface LoginWithGoogleAccountRequest extends IPlayFabRequestCommon {
     /** Optional boolean to opt out of setting the MPA email when creating a Google account, defaults to true. */
     SetEmail?: boolean;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1922,10 +2322,15 @@ interface LoginWithGooglePlayGamesServicesRequest extends IPlayFabRequestCommon
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
@@ -1934,7 +2339,7 @@ interface LoginWithGooglePlayGamesServicesRequest extends IPlayFabRequestCommon
      */
     ServerAuthCode?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1944,41 +2349,51 @@ interface LoginWithIOSDeviceIDRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Vendor-specific iOS identifier for the user's device. */
+    /** Vendor-specific iOS identifier for the user&#39;s device. */
     DeviceId?: string;
-    /** Specific model of the user's device. */
+    /** Specific model of the user&#39;s device. */
     DeviceModel?: string;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
-    /** Specific Operating System version for the user's device. */
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
+    /** Specific Operating System version for the user&#39;s device. */
     OS?: string;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
 }
 interface LoginWithKongregateRequest extends IPlayFabRequestCommon {
-    /** Token issued by Kongregate's client API for the user. */
+    /** Token issued by Kongregate&#39;s client API for the user. */
     AuthTicket?: string;
     /** Automatically create a PlayFab account if one is not currently linked to this ID. */
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
     /** Numeric user ID assigned by Kongregate */
     KongregateId?: string;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -1988,16 +2403,21 @@ interface LoginWithNintendoServiceAccountRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** The JSON Web token (JWT) returned by Nintendo after login. */
     IdentityToken: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2007,16 +2427,21 @@ interface LoginWithNintendoSwitchDeviceIdRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
-    /** Nintendo Switch unique identifier for the user's device. */
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
+    /** Nintendo Switch unique identifier for the user&#39;s device. */
     NintendoSwitchDeviceId?: string;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2028,19 +2453,24 @@ interface LoginWithOpenIdConnectRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /**
      * The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the
-     * identity provider's response.
+     * identity provider&#39;s response.
      */
     IdToken: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2050,10 +2480,15 @@ interface LoginWithPlayFabRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Password for the PlayFab account (6-100 characters) */
     Password: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2067,18 +2502,23 @@ interface LoginWithPSNRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
     /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */
     IssuerId?: number;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
     RedirectUri?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2088,43 +2528,53 @@ interface LoginWithSteamRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
      * Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte
-     * 0x08 should become "08").
+     * 0x08 should become &quot;08&quot;).
      */
     SteamTicket?: string;
     /**
-     * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using "AzurePlayFab" as the identity string.
+     * True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using &quot;AzurePlayFab&quot; as the identity string.
      * False if the ticket was generated with ISteamUser::GetAuthSessionTicket().
      */
     TicketIsServiceSpecific?: boolean;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
 }
 interface LoginWithTwitchRequest extends IPlayFabRequestCommon {
-    /** Token issued by Twitch's API for the user. */
+    /** Token issued by Twitch&#39;s API for the user. */
     AccessToken?: string;
     /** Automatically create a PlayFab account if one is not currently linked to this ID. */
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2134,27 +2584,84 @@ interface LoginWithXboxRequest extends IPlayFabRequestCommon {
     CreateAccount?: boolean;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
-    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
+    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). */
     XboxToken?: string;
 }
 interface LogStatement {
     /** Optional object accompanying the message as contextual information */
     Data?: any;
-    /** 'Debug', 'Info', or 'Error' */
+    /** &#39;Debug&#39;, &#39;Info&#39;, or &#39;Error&#39; */
     Level?: string;
     Message?: string;
 }
+/** @deprecated Do not use */
+interface MatchmakeRequest extends IPlayFabRequestCommon {
+    /** Build version to match against. [Note: Required if LobbyId is not specified] */
+    BuildVersion?: string;
+    /** Character to use for stats based matching. Leave null to use account stats. */
+    CharacterId?: string;
+    /** 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
+     * @deprecated Do not use
+     */
+    EnableQueue?: boolean;
+    /** Game mode to match make against. [Note: Required if LobbyId is not specified] */
+    GameMode?: string;
+    /** Lobby identifier to match make against. This is used to select a specific Game Server Instance. */
+    LobbyId?: string;
+    /** Region to match make against. [Note: Required if LobbyId is not specified] */
+    Region?: string;
+    /** Start a game session if one with an open slot is not found. Defaults to true. */
+    StartNewIfNoneFound?: boolean;
+    /** Player statistic to use in finding a match. May be null for no stat-based matching. */
+    StatisticName?: string;
+    /** Filter to include and/or exclude Game Server Instances associated with certain Tags */
+    TagFilter?: CollectionFilter;
+}
+/** @deprecated Do not use */
+interface MatchmakeResult extends IPlayFabResultCommon {
+    /** timestamp for when the server will expire, if applicable */
+    Expires?: string;
+    /** unique lobby identifier of the server matched */
+    LobbyID?: string;
+    /** time in milliseconds the application is configured to wait on matchmaking results */
+    PollWaitTimeMS?: number;
+    /**
+     * IPV4 address of the server
+     * @deprecated Please use ServerIPV4Address instead.
+     */
+    ServerHostname?: string;
+    /** IPV4 address of the server */
+    ServerIPV4Address?: string;
+    /** IPV6 address of the server */
+    ServerIPV6Address?: string;
+    /** port number to use for non-http communications with the server */
+    ServerPort?: number;
+    /** Public DNS name (if any) of the server */
+    ServerPublicDNSName?: string;
+    /** result of match making process */
+    Status?: string;
+    /** server authorization ticket (used by RedeemMatchmakerTicket to validate user insertion into the game) */
+    Ticket?: string;
+}
 interface MembershipModel {
     /** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
     IsActive: boolean;
@@ -2167,6 +2674,8 @@ interface MembershipModel {
      * overridden, this will be the new expiration time.
      */
     OverrideExpiration?: string;
+    /** Whether the override expiration is set. */
+    OverrideIsSet?: boolean;
     /** The list of subscriptions that this player has for this membership */
     Subscriptions?: SubscriptionModel[];
 }
@@ -2176,7 +2685,7 @@ interface MicrosoftStorePayload {
     /** If collectionsMsIdKey is provided, this will verify the user id in the collectionsMsIdKey is the same. */
     UserId?: string;
     /**
-     * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). This is
+     * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;). This is
      * optional. Alternatively can use CollectionsMsIdKey
      */
     XboxToken?: string;
@@ -2185,7 +2694,7 @@ interface ModifyUserVirtualCurrencyResult extends IPlayFabResultCommon {
     /** Balance of the virtual currency after modification. */
     Balance: number;
     /**
-     * Amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
+     * Amount added or subtracted from the user&#39;s virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
      * over this value will be discarded.
      */
     BalanceChange: number;
@@ -2279,17 +2788,17 @@ interface PlayerLeaderboardEntry {
     DisplayName?: string;
     /** PlayFab unique identifier of the user for this leaderboard entry. */
     PlayFabId?: string;
-    /** User's overall position in the leaderboard. */
+    /** User&#39;s overall position in the leaderboard. */
     Position: number;
     /** The profile of the user, if requested. */
     Profile?: PlayerProfileModel;
-    /** Specific value of the user's statistic. */
+    /** Specific value of the user&#39;s statistic. */
     StatValue: number;
 }
 interface PlayerProfileModel {
     /** List of advertising campaigns the player has been attributed to */
     AdCampaignAttributions?: AdCampaignAttributionModel[];
-    /** URL of the player's avatar image */
+    /** URL of the player&#39;s avatar image */
     AvatarUrl?: string;
     /** If the player is currently banned, the UTC Date when the ban expires */
     BannedUntil?: string;
@@ -2323,20 +2832,20 @@ interface PlayerProfileModel {
     PushNotificationRegistrations?: PushNotificationRegistrationModel[];
     /** List of leaderboard statistic values for the player */
     Statistics?: StatisticModel[];
-    /** List of player's tags for segmentation */
+    /** List of player&#39;s tags for segmentation */
     Tags?: TagModel[];
     /** Title ID this player profile applies to */
     TitleId?: string;
     /**
-     * Sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
+     * Sum of the player&#39;s purchases made with real-money currencies, converted to US dollars equivalent and represented as a
      * whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
      */
     TotalValueToDateInUSD?: number;
-    /** List of the player's lifetime purchase totals, summed by real-money currency */
+    /** List of the player&#39;s lifetime purchase totals, summed by real-money currency */
     ValuesToDate?: ValueToDateModel[];
 }
 interface PlayerProfileViewConstraints {
-    /** Whether to show player's avatar URL. Defaults to false */
+    /** Whether to show player&#39;s avatar URL. Defaults to false */
     ShowAvatarUrl: boolean;
     /** Whether to show the banned until time. Defaults to false */
     ShowBannedUntil: boolean;
@@ -2348,15 +2857,15 @@ interface PlayerProfileViewConstraints {
     ShowCreated: boolean;
     /** Whether to show the display name. Defaults to false */
     ShowDisplayName: boolean;
-    /** Whether to show player's experiment variants. Defaults to false */
+    /** Whether to show player&#39;s experiment variants. Defaults to false */
     ShowExperimentVariants: boolean;
     /** Whether to show the last login time. Defaults to false */
     ShowLastLogin: boolean;
     /** Whether to show the linked accounts. Defaults to false */
     ShowLinkedAccounts: boolean;
-    /** Whether to show player's locations. Defaults to false */
+    /** Whether to show player&#39;s locations. Defaults to false */
     ShowLocations: boolean;
-    /** Whether to show player's membership information. Defaults to false */
+    /** Whether to show player&#39;s membership information. Defaults to false */
     ShowMemberships: boolean;
     /** Whether to show origination. Defaults to false */
     ShowOrigination: boolean;
@@ -2433,8 +2942,8 @@ interface PurchaseReceiptFulfillment {
     /** Items granted to the player in fulfillment of the validated receipt. */
     FulfilledItems?: ItemInstance[];
     /**
-     * Source of the payment price information for the recorded purchase transaction. A value of 'Request' indicates that the
-     * price specified in the request was used, whereas a value of 'Catalog' indicates that the real-money price of the catalog
+     * Source of the payment price information for the recorded purchase transaction. A value of &#39;Request&#39; indicates that the
+     * price specified in the request was used, whereas a value of &#39;Catalog&#39; indicates that the real-money price of the catalog
      * item matching the product ID in the validated receipt transaction and the currency specified in the request (defaulting
      * to USD) was used.
      */
@@ -2472,6 +2981,17 @@ interface RefreshPSNAuthTokenRequest extends IPlayFabRequestCommon {
     /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
     RedirectUri: string;
 }
+/** @deprecated Do not use */
+interface RegionInfo {
+    /** indicates whether the server specified is available in this region */
+    Available: boolean;
+    /** name of the region */
+    Name?: string;
+    /** url to ping to get roundtrip time */
+    PingUrl?: string;
+    /** unique identifier for the region */
+    Region?: string;
+}
 interface RegisterForIOSPushNotificationRequest extends IPlayFabRequestCommon {
     /** Message to display when confirming push notification. */
     ConfirmationMessage?: string;
@@ -2489,10 +3009,21 @@ interface RegisterPlayFabUserRequest extends IPlayFabRequestCommon {
     DisplayName?: string;
     /** User email address attached to their account */
     Email?: string;
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
+    /**
+     * The Origination of a user is determined by the API call used to create the account. In the case of RegisterPlayFabUser,
+     * it will be Organic.
+     * @deprecated Do not use
+     */
+    Origination?: string;
     /** Password for the PlayFab account (6-100 characters) */
     Password?: string;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
@@ -2504,7 +3035,7 @@ interface RegisterPlayFabUserRequest extends IPlayFabRequestCommon {
      */
     RequireBothUsernameAndEmail?: boolean;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId?: string;
@@ -2575,6 +3106,11 @@ interface ReportPlayerClientRequest extends IPlayFabRequestCommon {
 interface ReportPlayerClientResult extends IPlayFabResultCommon {
     /** The number of remaining reports which may be filed today. */
     SubmissionsRemaining: number;
+    /**
+     * Deprecated: Always true
+     * @deprecated Do not use
+     */
+    Updated?: boolean;
 }
 interface RestoreIOSPurchasesRequest extends IPlayFabRequestCommon {
     /** Catalog version of the restored items. If null, defaults to primary catalog. */
@@ -2612,6 +3148,32 @@ interface RewardAdActivityResult extends IPlayFabResultCommon {
     /** Reward results */
     RewardResults?: AdRewardResults;
 }
+/** @deprecated Do not use */
+interface RunCloudScriptRequest extends IPlayFabRequestCommon {
+    /** server action to trigger */
+    ActionId: string;
+    /** parameters to pass into the action (If you use this, don&#39;t use ParamsEncoded) */
+    Params?: any;
+    /** json-encoded parameters to pass into the action (If you use this, don&#39;t use Params) */
+    ParamsEncoded?: string;
+}
+/** @deprecated Do not use */
+interface RunCloudScriptResult extends IPlayFabResultCommon {
+    /** id of Cloud Script run */
+    ActionId?: string;
+    /** any log statements generated during the run of this action */
+    ActionLog?: string;
+    /** time this script took to run, in seconds */
+    ExecutionTime: number;
+    /** return values from the server action as a dynamic object */
+    Results?: any;
+    /** return values from the server action as a JSON encoded string */
+    ResultsEncoded?: string;
+    /** revision of Cloud Script run */
+    Revision: number;
+    /** version of Cloud Script run */
+    Version: number;
+}
 interface ScriptExecutionError {
     /**
      * Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
@@ -2631,7 +3193,12 @@ interface SendAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
     /** The email template id of the account recovery email template to send. */
     EmailTemplateId?: string;
     /**
-     * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
+     * Deprecated - Do not use
+     * @deprecated Do not use
+     */
+    PublisherId?: string;
+    /**
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
      * title has been selected.
      */
     TitleId: string;
@@ -2647,7 +3214,7 @@ interface SetFriendTagsRequest extends IPlayFabRequestCommon {
 interface SetFriendTagsResult extends IPlayFabResultCommon {
 }
 interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
-    /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */
+    /** Base64 encoded body that is encrypted with the Title&#39;s public RSA key (Enterprise Only). */
     EncryptedRequest?: string;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
@@ -2664,6 +3231,47 @@ interface SharedGroupDataRecord {
     /** Data stored for the specified group data key. */
     Value?: string;
 }
+/** @deprecated Do not use */
+interface StartGameRequest extends IPlayFabRequestCommon {
+    /** version information for the build of the game server which is to be started */
+    BuildVersion: string;
+    /** character to use for stats based matching. Leave null to use account stats */
+    CharacterId?: string;
+    /** custom command line argument when starting game server process */
+    CustomCommandLineData?: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** the title-defined game mode this server is to be running (defaults to 0 if there is only one mode) */
+    GameMode: string;
+    /** the region to associate this server with for match filtering */
+    Region: string;
+    /** player statistic for others to use in finding this game. May be null for no stat-based matching */
+    StatisticName?: string;
+}
+/** @deprecated Do not use */
+interface StartGameResult extends IPlayFabResultCommon {
+    /** timestamp for when the server should expire, if applicable */
+    Expires?: string;
+    /** unique identifier for the lobby of the server started */
+    LobbyID?: string;
+    /** password required to log into the server */
+    Password?: string;
+    /**
+     * server IPV4 address
+     * @deprecated Please use ServerIPV4Address instead.
+     */
+    ServerHostname?: string;
+    /** server IPV4 address */
+    ServerIPV4Address?: string;
+    /** server IPV6 address */
+    ServerIPV6Address?: string;
+    /** port on the server to be used for communication */
+    ServerPort?: number;
+    /** server public DNS name */
+    ServerPublicDNSName?: string;
+    /** unique identifier for the server */
+    Ticket?: string;
+}
 interface StartPurchaseRequest extends IPlayFabRequestCommon {
     /** Catalog version for the items to be purchased. Defaults to most recent catalog. */
     CatalogVersion?: string;
@@ -2726,6 +3334,11 @@ interface SteamNamePlayFabIdPair {
 interface SteamPlayFabIdPair {
     /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */
     PlayFabId?: string;
+    /**
+     * Deprecated: Please use SteamStringId
+     * @deprecated Please use SteamStringId instead.
+     */
+    SteamId?: number;
     /** Unique Steam identifier for a user. */
     SteamStringId?: string;
 }
@@ -2741,7 +3354,7 @@ interface StoreItem {
     ItemId: string;
     /** Override prices for this item for specific currencies */
     RealCurrencyPrices?: Record<string, number>;
-    /** Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies) */
+    /** Override prices for this item in virtual currencies and &quot;RM&quot; (the base Real Money purchase price, in USD pennies) */
     VirtualCurrencyPrices?: Record<string, number>;
 }
 interface StoreMarketingModel {
@@ -2757,7 +3370,7 @@ interface SubscriptionModel {
     Expiration: string;
     /** The time the subscription was orignially purchased */
     InitialSubscriptionTime: string;
-    /** Whether this subscription is currently active. That is, if Expiration > now. */
+    /** Whether this subscription is currently active. That is, if Expiration &gt; now. */
     IsActive: boolean;
     /** The status of this subscription, according to the subscription provider. */
     Status?: string;
@@ -2832,7 +3445,7 @@ interface TwitchPlayFabIdPair {
 }
 interface UnlinkAndroidDeviceIDRequest extends IPlayFabRequestCommon {
     /**
-     * Android device identifier for the user's device. If not specified, the most recently signed in Android Device ID will be
+     * Android device identifier for the user&#39;s device. If not specified, the most recently signed in Android Device ID will be
      * used.
      */
     AndroidDeviceId?: string;
@@ -2896,7 +3509,7 @@ interface UnlinkIOSDeviceIDRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
     /**
-     * Vendor-specific iOS identifier for the user's device. If not specified, the most recently signed in iOS Device ID will
+     * Vendor-specific iOS identifier for the user&#39;s device. If not specified, the most recently signed in iOS Device ID will
      * be used.
      */
     DeviceId?: string;
@@ -2953,6 +3566,11 @@ interface UnlinkTwitchAccountResult extends IPlayFabResultCommon {
 interface UnlinkXboxAccountRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
+    /**
+     * Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(&quot;POST&quot;, &quot;https://playfabapi.com/&quot;, &quot;&quot;).
+     * @deprecated Do not use
+     */
+    XboxToken?: string;
 }
 interface UnlinkXboxAccountResult extends IPlayFabResultCommon {
 }
@@ -3008,7 +3626,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /**
      * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
-     * not begin with a '!' character or be null.
+     * not begin with a &#39;!&#39; character or be null.
      */
     Data?: Record<string, string | null>;
     /**
@@ -3016,7 +3634,7 @@ interface UpdateCharacterDataRequest extends IPlayFabRequestCommon {
      * constraints. Use this to delete the keys directly.
      */
     KeysToRemove?: string[];
-    /** Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. */
+    /** Permission to be applied to all user data keys written in this request. Defaults to &quot;private&quot; if not set. */
     Permission?: string;
 }
 interface UpdateCharacterDataResult extends IPlayFabResultCommon {
@@ -3041,7 +3659,7 @@ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /**
      * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the
-     * player's properties have not been updated by any other clients since last the version.
+     * player&#39;s properties have not been updated by any other clients since last the version.
      */
     ExpectedPropertiesVersion?: number;
     /** Collection of properties to be set for a player. */
@@ -3049,7 +3667,7 @@ interface UpdatePlayerCustomPropertiesRequest extends IPlayFabRequestCommon {
 }
 interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
     /**
-     * Indicates the current version of a player's properties that have been set. This is incremented after updates and
+     * Indicates the current version of a player&#39;s properties that have been set. This is incremented after updates and
      * deletes. This version can be provided in update and delete calls for concurrency control.
      */
     PropertiesVersion: number;
@@ -3073,7 +3691,7 @@ interface UpdateSharedGroupDataRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /**
      * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
-     * not begin with a '!' character or be null.
+     * not begin with a &#39;!&#39; character or be null.
      */
     Data?: Record<string, string | null>;
     /**
@@ -3093,7 +3711,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /**
      * Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
-     * not begin with a '!' character or be null.
+     * not begin with a &#39;!&#39; character or be null.
      */
     Data?: Record<string, string | null>;
     /**
@@ -3102,7 +3720,7 @@ interface UpdateUserDataRequest extends IPlayFabRequestCommon {
      */
     KeysToRemove?: string[];
     /**
-     * Permission to be applied to all user data keys written in this request. Defaults to "private" if not set. This is used
+     * Permission to be applied to all user data keys written in this request. Defaults to &quot;private&quot; if not set. This is used
      * for requests by one player for information about another player; those requests will only return Public keys.
      */
     Permission?: string;
@@ -3114,6 +3732,19 @@ interface UpdateUserDataResult extends IPlayFabResultCommon {
      */
     DataVersion: number;
 }
+/** @deprecated Do not use */
+interface UpdateUserStatisticsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Statistics to be updated with the provided values. UserStatistics object must follow the Key(string), Value(int)
+     * pattern.
+     */
+    UserStatistics?: Record<string, number>;
+}
+/** @deprecated Do not use */
+interface UpdateUserStatisticsResult extends IPlayFabResultCommon {
+}
 interface UpdateUserTitleDisplayNameRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -3298,7 +3929,7 @@ interface UserSteamInfo {
     SteamName?: string;
 }
 interface UserTitleInfo {
-    /** URL to the player's avatar. */
+    /** URL to the player&#39;s avatar. */
     AvatarUrl?: string;
     /**
      * 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 {
     Currency?: string;
     /**
      * Total value of the purchases in a whole number of 1/100 monetary units. For example, 999 indicates nine dollars and
-     * ninety-nine cents when Currency is 'USD')
+     * ninety-nine cents when Currency is &#39;USD&#39;)
      */
     TotalValue: number;
     /**
-     * Total value of the purchases in a string representation of decimal monetary units. For example, '9.99' indicates nine
-     * dollars and ninety-nine cents when Currency is 'USD'.
+     * Total value of the purchases in a string representation of decimal monetary units. For example, &#39;9.99&#39; indicates nine
+     * dollars and ninety-nine cents when Currency is &#39;USD&#39;.
      */
     TotalValueAsDecimal?: string;
 }
@@ -3494,97 +4125,204 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the
      * allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted
      * items will be swapped between the two players' inventories.
-     * https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade Microsoft Documentation}
+     * @example
+     * await clientClient.AcceptTrade({
+     *   "OfferingPlayerId": "CD803BF233CE76CC",
+     *   "TradeId": "D819CEC225EA9948C351",
+     *   "AcceptedInventoryInstanceIds": [
+     *     "95C1797ADDAC24DC0383",
+     *     "0F7793DF55CCEAF21B84"
+     *   ]
+     * });
      */
     AcceptTrade(request: AcceptTradeRequest, extraHeaders?: Record<string, string>): Promise<AcceptTradeResponse>;
     /**
      * Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At
      * least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
-     * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend Microsoft Documentation}
+     * @example
+     * await clientClient.AddFriend({
+     *   "FriendPlayFabId": "29837799"
+     * });
      */
     AddFriend(request: AddFriendRequest, extraHeaders?: Record<string, string>): Promise<AddFriendResult>;
     /**
      * Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab
      * ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as
      * authentication credentials, as the intent is that it is easily accessible by other players.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid Microsoft Documentation}
+     * @example
+     * await clientClient.AddGenericID({
+     *   "GenericId": {
+     *     "ServiceName": "BigBizSocial",
+     *     "UserId": "1234567890"
+     *   }
+     * });
      */
     AddGenericID(request: AddGenericIDRequest, extraHeaders?: Record<string, string>): Promise<AddGenericIDResult>;
     /**
      * Adds or updates a contact email to the player's profile.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail Microsoft Documentation}
+     * @example
+     * await clientClient.AddOrUpdateContactEmail({
+     *   "EmailAddress": "theuser@domain.com"
+     * });
      */
     AddOrUpdateContactEmail(request: AddOrUpdateContactEmailRequest, extraHeaders?: Record<string, string>): Promise<AddOrUpdateContactEmailResult>;
     /**
      * 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
      * in the group can add new members. Shared Groups are designed for sharing data between a very small number of players,
      * please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
-     * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers Microsoft Documentation}
+     * @example
+     * await clientClient.AddSharedGroupMembers({
+     *   "SharedGroupId": "Clan Data",
+     *   "PlayFabIds": [
+     *     "D984A64B832",
+     *     "F74A523E1562"
+     *   ]
+     * });
      */
     AddSharedGroupMembers(request: AddSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
     /**
      * Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device
      * ID login.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword Microsoft Documentation}
+     * @example
+     * await clientClient.AddUsernamePassword({
+     *   "Username": "theuser",
+     *   "Email": "me@here.com",
+     *   "Password": "ExampleSecret"
+     * });
      */
     AddUsernamePassword(request: AddUsernamePasswordRequest, extraHeaders?: Record<string, string>): Promise<AddUsernamePasswordResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Increments the user's balance of the specified virtual currency by the stated amount
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency Microsoft Documentation}
+     * @example
+     * await clientClient.AddUserVirtualCurrency({
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
     /**
      * Registers the Android device to receive push notifications
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration Microsoft Documentation}
+     * @example
+     * await clientClient.AndroidDevicePushNotificationRegistration({
+     *   "DeviceToken": "59872d98fa632brn8hg3770",
+     *   "SendPushNotificationConfirmation": true,
+     *   "ConfirmationMessage": "Welcome to PlayFab!"
+     * });
      */
     AndroidDevicePushNotificationRegistration(request: AndroidDevicePushNotificationRegistrationRequest, extraHeaders?: Record<string, string>): Promise<AndroidDevicePushNotificationRegistrationResult>;
     /**
      * Attributes an install for advertisment.
-     * https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall Microsoft Documentation}
+     * @example
+     * await clientClient.AttributeInstall({
+     *   "Idfa": "11098810"
+     * });
      */
     AttributeInstall(request: AttributeInstallRequest, extraHeaders?: Record<string, string>): Promise<AttributeInstallResult>;
     /**
      * Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade
      * can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other
      * players from accepting them, for trades that can be claimed by more than one player).
-     * https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade Microsoft Documentation}
+     * @example
+     * await clientClient.CancelTrade({
+     *   "TradeId": "D819CEC225EA9948C351"
+     * });
      */
     CancelTrade(request: CancelTradeRequest, extraHeaders?: Record<string, string>): Promise<CancelTradeResponse>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and
      * virtual currency balances as appropriate
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase Microsoft Documentation}
+     * @example
+     * await clientClient.ConfirmPurchase({
+     *   "OrderId": "8853591446005860822"
+     * });
      */
     ConfirmPurchase(request: ConfirmPurchaseRequest, extraHeaders?: Record<string, string>): Promise<ConfirmPurchaseResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's
      * inventory.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem Microsoft Documentation}
+     * @example
+     * await clientClient.ConsumeItem({
+     *   "ItemInstanceId": "94585729",
+     *   "ConsumeCount": 1
+     * });
      */
     ConsumeItem(request: ConsumeItemRequest, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
     /**
      * Grants the player's current entitlements from Microsoft Store's Collection API
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements Microsoft Documentation}
+     * @example
+     * await clientClient.ConsumeMicrosoftStoreEntitlements({
+     *   "MarketplaceSpecificData": {
+     *     "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
+     *     "userId": "46239871",
+     *     "collectionsMsIdKey": "MicrosoftStoreIdKey"
+     *   },
+     *   "CatalogVersion": "MainCatalog"
+     * });
      */
     ConsumeMicrosoftStoreEntitlements(request: ConsumeMicrosoftStoreEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumeMicrosoftStoreEntitlementsResponse>;
     /**
      * Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as
      * PlayFab items
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements Microsoft Documentation}
+     * @example
+     * await clientClient.ConsumePS5Entitlements({
+     *   "MarketplaceSpecificData": {
+     *     "ServiceLabel": "1"
+     *   },
+     *   "CatalogVersion": "MainCatalog"
+     * });
      */
     ConsumePS5Entitlements(request: ConsumePS5EntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumePS5EntitlementsResult>;
     /**
      * Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements Microsoft Documentation}
+     * @example
+     * await clientClient.ConsumePSNEntitlements({
+     *   "ServiceLabel": 1
+     * });
      */
     ConsumePSNEntitlements(request: ConsumePSNEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumePSNEntitlementsResult>;
     /**
      * Grants the player's current entitlements from Xbox Live, consuming all availble items in Xbox and granting them to the
      * player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements Microsoft Documentation}
+     * @example
+     * await clientClient.ConsumeXboxEntitlements({
+     *   "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
+     *   "CatalogVersion": "XboxItems"
+     * });
      */
     ConsumeXboxEntitlements(request: ConsumeXboxEntitlementsRequest, extraHeaders?: Record<string, string>): Promise<ConsumeXboxEntitlementsResult>;
     /**
@@ -3592,68 +4330,163 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data
      * between a very small number of players, please see our guide:
      * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
-     * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup Microsoft Documentation}
+     * @example
+     * await clientClient.CreateSharedGroup({
+     *   "SharedGroupId": "Clan Data"
+     * });
      */
     CreateSharedGroup(request: CreateSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
     /**
      * Deletes title-specific custom properties for a player
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties Microsoft Documentation}
+     * @example
+     * await clientClient.DeletePlayerCustomProperties({
+     *   "PropertyNames": [
+     *     "level",
+     *     "created"
+     *   ],
+     *   "ExpectedPropertiesVersion": 12
+     * });
      */
     DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
     /**
      * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The
      * PlayFab ID is the entity ID of the player's master_player_account entity.
-     * https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript Microsoft Documentation}
+     * @example
+     * await clientClient.ExecuteCloudScript({
+     *   "FunctionName": "levelCompleted",
+     *   "FunctionParameter": {
+     *     "level": 3,
+     *     "points": 400
+     *   },
+     *   "RevisionSelection": "Live",
+     *   "GeneratePlayStreamEvent": true
+     * });
      */
     ExecuteCloudScript(request: ExecuteCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
     /**
      * Retrieves the user's PlayFab account details
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo Microsoft Documentation}
+     * @example
+     * await clientClient.GetAccountInfo({
+     *   "PlayFabId": "10931252888739651331"
+     * });
      */
     GetAccountInfo(request: GetAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<GetAccountInfoResult>;
     /**
      * Returns a list of ad placements and a reward for each
-     * https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements Microsoft Documentation}
+     * @example
+     * await clientClient.GetAdPlacements({
+     *   "AppId": "A12784B",
+     *   "Identifier": {
+     *     "Name": "PowerBonusInterstitial"
+     *   }
+     * });
      */
     GetAdPlacements(request: GetAdPlacementsRequest, extraHeaders?: Record<string, string>): Promise<GetAdPlacementsResult>;
     /**
      * Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be
      * evaluated with the parent PlayFabId to guarantee uniqueness.
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters Microsoft Documentation}
+     * @example
+     * await clientClient.GetAllUsersCharacters({
+     *   "PlayFabId": "98333765432"
+     * });
      */
     GetAllUsersCharacters(request: ListUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<ListUsersCharactersResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties
-     * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems Microsoft Documentation}
+     * @example
+     * await clientClient.GetCatalogItems({
+     *   "CatalogVersion": "1"
+     * });
      */
     GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
     /**
      * Retrieves the title-specific custom data for the character which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata Microsoft Documentation}
+     * @example
+     * await clientClient.GetCharacterData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ]
+     * });
      */
     GetCharacterData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retrieves the specified character's current inventory of virtual goods
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory Microsoft Documentation}
+     * @example
+     * await clientClient.GetCharacterInventory({
+     *   "CharacterId": "9890723423",
+     *   "CatalogVersion": "5"
+     * });
      */
     GetCharacterInventory(request: GetCharacterInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterInventoryResult>;
     /**
      * Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard Microsoft Documentation}
+     * @example
+     * await clientClient.GetCharacterLeaderboard({
+     *   "CharacterType": "blue_warrior",
+     *   "StatisticName": "Kills",
+     *   "StartPosition": 0,
+     *   "MaxResultsCount": 20
+     * });
      */
     GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
     /**
      * Retrieves the title-specific custom data for the character which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata Microsoft Documentation}
+     * @example
+     * await clientClient.GetCharacterReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ]
+     * });
      */
     GetCharacterReadOnlyData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
     /**
      * Retrieves the details of all title-specific statistics for the user
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics Microsoft Documentation}
+     * @example
+     * await clientClient.GetCharacterStatistics({
+     *   "CharacterId": "98765432"
+     * });
      */
     GetCharacterStatistics(request: GetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
+    /**
+     * Retrieves the title-specific URL for Cloud Script servers. This must be queried once, prior to making any calls to
+     * RunCloudScript.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/getcloudscripturl Microsoft Documentation}
+     * @deprecated Please use ExecuteCloudScript instead.
+     */
+    GetCloudScriptUrl(request: GetCloudScriptUrlRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptUrlResult>;
     /**
      * This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned
      * 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 {
      * the query to retrieve the data will fail. See this post for more information:
      * https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also,
      * please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.
-     * https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl Microsoft Documentation}
+     * @example
+     * await clientClient.GetContentDownloadUrl({
+     *   "Key": "images/sword_icon.png"
+     * });
      */
     GetContentDownloadUrl(request: GetContentDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
+    /**
+     * Get details about all current running game servers matching the given parameters.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/getcurrentgames Microsoft Documentation}
+     * @deprecated Please use MultiplayerServer/ListMultiplayerServers instead.
+     */
+    GetCurrentGames(request: CurrentGamesRequest, extraHeaders?: Record<string, string>): Promise<CurrentGamesResult>;
     /**
      * Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in
      * the leaderboard
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard Microsoft Documentation}
+     * @example
+     * await clientClient.GetFriendLeaderboard({
+     *   "StatisticName": "Kills",
+     *   "StartPosition": 1258,
+     *   "MaxResultsCount": 20,
+     *   "ExternalPlatformFriends": "Facebook, Xbox, Psn"
+     * });
      */
     GetFriendLeaderboard(request: GetFriendLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
+    /**
+     * Retrieves a list of ranked friends of the current player for the given statistic, centered on the currently signed-in
+     * user
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundcurrentuser Microsoft Documentation}
+     * @deprecated Please use GetFriendLeaderboardAroundPlayer instead.
+     */
+    GetFriendLeaderboardAroundCurrentUser(request: GetFriendLeaderboardAroundCurrentUserRequest, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundCurrentUserResult>;
     /**
      * Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab
      * user. If PlayFabId is empty or null will return currently logged in user.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer Microsoft Documentation}
+     * @example
+     * await clientClient.GetFriendLeaderboardAroundPlayer({
+     *   "StatisticName": "Kills",
+     *   "MaxResultsCount": 20,
+     *   "ExternalPlatformFriends": "None"
+     * });
      */
     GetFriendLeaderboardAroundPlayer(request: GetFriendLeaderboardAroundPlayerRequest, extraHeaders?: Record<string, string>): Promise<GetFriendLeaderboardAroundPlayerResult>;
     /**
      * Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from
      * linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.
-     * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist Microsoft Documentation}
+     * @example
+     * await clientClient.GetFriendsList({
+     *   "ExternalPlatformFriends": "Steam"
+     * });
      */
     GetFriendsList(request: GetFriendsListRequest, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
+    /**
+     * Get details about the regions hosting game servers matching the given parameters.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/getgameserverregions Microsoft Documentation}
+     * @deprecated Please use MultiplayerServer/ListMultiplayerServers instead.
+     */
+    GetGameServerRegions(request: GameServerRegionsRequest, extraHeaders?: Record<string, string>): Promise<GameServerRegionsResult>;
     /**
      * Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard Microsoft Documentation}
+     * @example
+     * await clientClient.GetLeaderboard({
+     *   "StatisticName": "Kills",
+     *   "StartPosition": 0,
+     *   "MaxResultsCount": 20
+     * });
      */
     GetLeaderboard(request: GetLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
     /**
      * Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter Microsoft Documentation}
+     * @example
+     * await clientClient.GetLeaderboardAroundCharacter({
+     *   "StatisticName": "Kills",
+     *   "CharacterId": "987343220",
+     *   "MaxResultsCount": 20
+     * });
      */
     GetLeaderboardAroundCharacter(request: GetLeaderboardAroundCharacterRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCharacterResult>;
+    /**
+     * Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundcurrentuser Microsoft Documentation}
+     * @deprecated Please use GetLeaderboardAroundPlayer instead.
+     */
+    GetLeaderboardAroundCurrentUser(request: GetLeaderboardAroundCurrentUserRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundCurrentUserResult>;
     /**
      * Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or
      * null will return currently logged in user.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer Microsoft Documentation}
+     * @example
+     * await clientClient.GetLeaderboardAroundPlayer({
+     *   "StatisticName": "Kills",
+     *   "MaxResultsCount": 20
+     * });
      */
     GetLeaderboardAroundPlayer(request: GetLeaderboardAroundPlayerRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundPlayerResult>;
     /**
      * Retrieves a list of all of the user's characters for the given statistic.
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters Microsoft Documentation}
+     * @example
+     * await clientClient.GetLeaderboardForUserCharacters({
+     *   "StatisticName": "Kills"
+     * });
      */
     GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
     /**
@@ -3708,158 +4620,375 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the
      * client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the
      * client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken Microsoft Documentation}
+     * @example
+     * await clientClient.GetPaymentToken({
+     *   "TokenProvider": "xsolla"
+     * });
      */
     GetPaymentToken(request: GetPaymentTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPaymentTokenResult>;
     /**
      * Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See
      * https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken Microsoft Documentation}
+     * @example
+     * await clientClient.GetPhotonAuthenticationToken({
+     *   "PhotonApplicationId": "acaa26f3-fcdb-4af4-8c76-3a3d4dd3066f"
+     * });
      */
     GetPhotonAuthenticationToken(request: GetPhotonAuthenticationTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPhotonAuthenticationTokenResult>;
     /**
      * Retrieves all of the user's different kinds of info.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerCombinedInfo({
+     *   "PlayFabId": "4027527BF22653D1",
+     *   "InfoRequestParameters": {
+     *     "GetUserAccountInfo": true,
+     *     "GetUserInventory": false,
+     *     "GetUserVirtualCurrency": true,
+     *     "GetUserData": true,
+     *     "UserDataKeys": [
+     *       "preferences",
+     *       "progress"
+     *     ],
+     *     "GetUserReadOnlyData": false,
+     *     "GetCharacterInventories": false,
+     *     "GetCharacterList": false,
+     *     "GetTitleData": false,
+     *     "GetPlayerStatistics": false,
+     *     "GetPlayerProfile": false,
+     *     "GetEntityLineage": false
+     *   }
+     * });
      */
     GetPlayerCombinedInfo(request: GetPlayerCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCombinedInfoResult>;
     /**
      * Retrieves a title-specific custom property value for a player.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerCustomProperty({
+     *   "PropertyName": "level"
+     * });
      */
     GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
     /**
      * Retrieves the player's profile
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerProfile({
+     *   "PlayFabId": "621EF20237534A44"
+     * });
      */
     GetPlayerProfile(request: GetPlayerProfileRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerProfileResult>;
     /**
      * List all segments that a player currently belongs to at this moment in time.
-     * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerSegments({});
      */
     GetPlayerSegments(request: GetPlayerSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
     /**
      * Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local
      * player.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerStatistics({
+     *   "StatisticNames": [
+     *     "Points",
+     *     "Wins"
+     *   ]
+     * });
      */
     GetPlayerStatistics(request: GetPlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticsResult>;
     /**
      * Retrieves the information on the available versions of the specified statistic.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerStatisticVersions({
+     *   "StatisticName": "headshots"
+     * });
      */
     GetPlayerStatisticVersions(request: GetPlayerStatisticVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticVersionsResult>;
     /**
      * Get all tags with a given Namespace (optional) from a player profile.
-     * https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerTags({
+     *   "PlayFabId": "10931252888739651331",
+     *   "Namespace": "title.AAA"
+     * });
      */
     GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
     /**
      * Gets all trades the player has either opened or accepted, optionally filtered by trade status.
-     * https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayerTrades({
+     *   "StatusFilter": "Filled"
+     * });
      */
     GetPlayerTrades(request: GetPlayerTradesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTradesResponse>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromBattleNetAccountIds({
+     *   "BattleNetAccountIds": [
+     *     "526f79204261747478",
+     *     "526f79204261747479"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromBattleNetAccountIds(request: GetPlayFabIDsFromBattleNetAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromBattleNetAccountIdsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromFacebookIDs({
+     *   "FacebookIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromFacebookIDs(request: GetPlayFabIDsFromFacebookIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromFacebookInstantGamesIds({
+     *   "FacebookInstantGamesIds": [
+     *     "1114685845316172",
+     *     "1114685845316173"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center
      * Programming Guide as the Player Identifier).
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromGameCenterIDs({
+     *   "GameCenterIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromGameCenterIDs(request: GetPlayFabIDsFromGameCenterIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGameCenterIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the
      * service name plus the service-specific ID for the player, as specified by the title when the generic identifier was
      * added to the player account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromGenericIDs({
+     *   "GenericIDs": [
+     *     {
+     *       "ServiceName": "BigBizSocial",
+     *       "UserId": "1234567890"
+     *     },
+     *     {
+     *       "ServiceName": "VeeCeeMe",
+     *       "UserId": "og5igh85gf43gf"
+     *     }
+     *   ]
+     * });
      */
     GetPlayFabIDsFromGenericIDs(request: GetPlayFabIDsFromGenericIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGenericIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for
      * the user accounts, available as "id" in the Google+ People API calls.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromGoogleIDs({
+     *   "GoogleIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromGoogleIDs(request: GetPlayFabIDsFromGoogleIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGoogleIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games
      * identifiers are the IDs for the user accounts, available as "playerId" in the Google Play Games Services - Players API
      * calls.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromGooglePlayGamesPlayerIDs({
+     *   "GooglePlayGamesPlayerIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromGooglePlayGamesPlayerIDs(request: GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the
      * IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex:
      * http://developers.kongregate.com/docs/client/getUserId).
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromKongregateIDs({
+     *   "KongregateIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromKongregateIDs(request: GetPlayFabIDsFromKongregateIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromKongregateIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromNintendoServiceAccountIds({
+     *   "NintendoAccountIds": [
+     *     "526f79204261747478",
+     *     "526f79204261747479"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromNintendoServiceAccountIds(request: GetPlayFabIDsFromNintendoServiceAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoServiceAccountIdsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromNintendoSwitchDeviceIds({
+     *   "NintendoSwitchDeviceIds": [
+     *     "526f79204261747478",
+     *     "526f79204261747479"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromNintendoSwitchDeviceIds(request: GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromNintendoSwitchDeviceIdsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromPSNAccountIDs({
+     *   "PSNAccountIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromPSNAccountIDs(request: GetPlayFabIDsFromPSNAccountIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNAccountIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromPSNOnlineIDs({
+     *   "PSNOnlineIDs": [
+     *     "857555576495",
+     *     "759345551209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromPSNOnlineIDs(request: GetPlayFabIDsFromPSNOnlineIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromPSNOnlineIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile
      * IDs for the user accounts, available as SteamId in the Steamworks Community API calls.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromSteamIDs({
+     *   "SteamStringIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromSteamIDs(request: GetPlayFabIDsFromSteamIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona
      * names.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromSteamNames({
+     *   "SteamNames": [
+     *     "steamPersonaName1",
+     *     "steamPersonaName2"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromSteamNames(request: GetPlayFabIDsFromSteamNamesRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromSteamNamesResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for
      * the user accounts, available as "_id" from the Twitch API methods (ex:
      * https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromTwitchIDs({
+     *   "TwitchIds": [
+     *     "127168541",
+     *     "88315720"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromTwitchIDs(request: GetPlayFabIDsFromTwitchIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromTwitchIDsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids Microsoft Documentation}
+     * @example
+     * await clientClient.GetPlayFabIDsFromXboxLiveIDs({
+     *   "XboxLiveAccountIDs": [
+     *     "857498576495",
+     *     "759374651209"
+     *   ],
+     *   "Sandbox": "RETAIL"
+     * });
      */
     GetPlayFabIDsFromXboxLiveIDs(request: GetPlayFabIDsFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromXboxLiveIDsResult>;
     /**
      * Retrieves the key-value store of custom publisher settings
-     * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata Microsoft Documentation}
+     * @example
+     * await clientClient.GetPublisherData({
+     *   "Keys": [
+     *     "color",
+     *     "propertyA"
+     *   ]
+     * });
      */
     GetPublisherData(request: GetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<GetPublisherDataResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that
      * are still active.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase Microsoft Documentation}
+     * @example
+     * await clientClient.GetPurchase({
+     *   "OrderId": "8853591446005860822"
+     * });
      */
     GetPurchase(request: GetPurchaseRequest, extraHeaders?: Record<string, string>): Promise<GetPurchaseResult>;
     /**
@@ -3867,100 +4996,238 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * may use this to retrieve group data, including membership, but they will not receive data for keys marked as private.
      * Shared Groups are designed for sharing data between a very small number of players, please see our guide:
      * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
-     * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata Microsoft Documentation}
+     * @example
+     * await clientClient.GetSharedGroupData({
+     *   "SharedGroupId": "Clan Data",
+     *   "Keys": [
+     *     "ClanKills",
+     *     "LastClanUpdate"
+     *   ],
+     *   "GetMembers": true
+     * });
      */
     GetSharedGroupData(request: GetSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<GetSharedGroupDataResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
-     * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems Microsoft Documentation}
+     * @example
+     * await clientClient.GetStoreItems({
+     *   "StoreId": "BonusStore"
+     * });
      */
     GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
     /**
      * Retrieves the current server time
-     * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime Microsoft Documentation}
+     * @example
+     * await clientClient.GetTime({});
      */
     GetTime(request: GetTimeRequest, extraHeaders?: Record<string, string>): Promise<GetTimeResult>;
     /**
      * Retrieves the key-value store of custom title settings
-     * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata Microsoft Documentation}
+     * @example
+     * await clientClient.GetTitleData({
+     *   "Keys": [
+     *     "color",
+     *     "propertyA"
+     *   ]
+     * });
      */
     GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
     /**
      * Retrieves the title news feed, as configured in the developer portal
-     * https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews Microsoft Documentation}
+     * @example
+     * await clientClient.GetTitleNews({
+     *   "Count": 25
+     * });
      */
     GetTitleNews(request: GetTitleNewsRequest, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
     /**
      * Returns the title's base 64 encoded RSA CSP blob.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey Microsoft Documentation}
+     * @example
+     * await clientClient.GetTitlePublicKey({
+     *   "TitleId": "ID",
+     *   "TitleSharedSecret": "ExampleSecret"
+     * });
      */
     GetTitlePublicKey(request: GetTitlePublicKeyRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePublicKeyResult>;
     /**
      * Gets the current status of an existing trade.
-     * https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus Microsoft Documentation}
+     * @example
+     * await clientClient.GetTradeStatus({
+     *   "OfferingPlayerId": "CD803BF233CE76CC",
+     *   "TradeId": "D819CEC225EA9948C351"
+     * });
      */
     GetTradeStatus(request: GetTradeStatusRequest, extraHeaders?: Record<string, string>): Promise<GetTradeStatusResponse>;
+    /**
+     * NOTE: This call will be deprecated soon. For fetching the data for a given user use GetPlayerCombinedInfo. For looking
+     * 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
+     * deprecated. Retrieves all requested data for a user in one unified request. By default, this API returns all data for
+     * the locally signed-in user. The input parameters may be used to limit the data retrieved to any subset of the available
+     * data, as well as retrieve the available data for a different user. Note that certain data, including inventory, virtual
+     * currency balances, and personally identifying information, may only be retrieved for the locally signed-in user. In the
+     * example below, a request is made for the account details, virtual currency balances, and specified user data for the
+     * locally signed-in user.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/getusercombinedinfo Microsoft Documentation}
+     * @deprecated Please use GetPlayerCombinedInfo instead.
+     */
+    GetUserCombinedInfo(request: GetUserCombinedInfoRequest, extraHeaders?: Record<string, string>): Promise<GetUserCombinedInfoResult>;
     /**
      * Retrieves the title-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata Microsoft Documentation}
+     * @example
+     * await clientClient.GetUserData({
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ]
+     * });
      */
     GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retrieves the user's current inventory of virtual goods
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory Microsoft Documentation}
+     * @example
+     * await clientClient.GetUserInventory({});
      */
     GetUserInventory(request: GetUserInventoryRequest, extraHeaders?: Record<string, string>): Promise<GetUserInventoryResult>;
     /**
      * Retrieves the publisher-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata Microsoft Documentation}
+     * @example
+     * await clientClient.GetUserPublisherData({
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ]
+     * });
      */
     GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
     /**
      * Retrieves the publisher-specific custom data for the user which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
+     * @example
+     * await clientClient.GetUserPublisherReadOnlyData({
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ]
+     * });
      */
     GetUserPublisherReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
     /**
      * Retrieves the title-specific custom data for the user which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata Microsoft Documentation}
+     * @example
+     * await clientClient.GetUserReadOnlyData({
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ]
+     * });
      */
     GetUserReadOnlyData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
+    /**
+     * Retrieves the details of all title-specific statistics for the user
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserstatistics Microsoft Documentation}
+     * @deprecated Please use GetPlayerStatistics instead.
+     */
+    GetUserStatistics(request: GetUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetUserStatisticsResult>;
     /**
      * Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated
      * with the parent PlayFabId to guarantee uniqueness.
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser Microsoft Documentation}
+     * @example
+     * await clientClient.GrantCharacterToUser({
+     *   "CatalogVersion": "2.2",
+     *   "ItemId": "Blue Warrior",
+     *   "CharacterName": "FighterDude"
+     * });
      */
     GrantCharacterToUser(request: GrantCharacterToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
     /**
      * Links the Android device identifier to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.LinkAndroidDeviceID({
+     *   "AndroidDeviceId": "526f79204261747479",
+     *   "OS": "5.0",
+     *   "AndroidDevice": "Nexus 6"
+     * });
      */
     LinkAndroidDeviceID(request: LinkAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LinkAndroidDeviceIDResult>;
     /**
      * Links the Apple account associated with the token to the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple Microsoft Documentation}
+     * @example
+     * await clientClient.LinkApple({
+     *   "IdentityToken": "eyJraWQi..."
+     * });
      */
     LinkApple(request: LinkAppleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Links the Battle.net account associated with the token to the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkBattleNetAccount({
+     *   "IdentityToken": "eyJraWQi..."
+     * });
      */
     LinkBattleNetAccount(request: LinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Links the custom identifier, generated by the title, to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid Microsoft Documentation}
+     * @example
+     * await clientClient.LinkCustomID({
+     *   "CustomId": "67AB-5397-CC54-EA31"
+     * });
      */
     LinkCustomID(request: LinkCustomIDRequest, extraHeaders?: Record<string, string>): Promise<LinkCustomIDResult>;
     /**
      * Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkFacebookAccount({
+     *   "AccessToken": "FaceAccessTokenID"
+     * });
      */
     LinkFacebookAccount(request: LinkFacebookAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkFacebookAccountResult>;
     /**
      * Links the Facebook Instant Games Id to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid Microsoft Documentation}
+     * @example
+     * await clientClient.LinkFacebookInstantGamesId({
+     *   "FacebookInstantGamesSignature": "abcdef"
+     * });
      */
     LinkFacebookInstantGamesId(request: LinkFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<LinkFacebookInstantGamesIdResult>;
     /**
@@ -3968,91 +5235,195 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters
      * in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons
      * page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkGameCenterAccount({
+     *   "GameCenterId": "2998h2998f0b000d0993"
+     * });
      */
     LinkGameCenterAccount(request: LinkGameCenterAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGameCenterAccountResult>;
     /**
      * Links the currently signed-in user account to their Google account, using their Google account credentials
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkGoogleAccount({
+     *   "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#"
+     * });
      */
     LinkGoogleAccount(request: LinkGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGoogleAccountResult>;
     /**
      * Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account
      * credentials
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkGooglePlayGamesServicesAccount({
+     *   "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#"
+     * });
      */
     LinkGooglePlayGamesServicesAccount(request: LinkGooglePlayGamesServicesAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkGooglePlayGamesServicesAccountResult>;
     /**
      * Links the vendor-specific iOS device identifier to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.LinkIOSDeviceID({
+     *   "DeviceId": "29848d9bh8900a0b003",
+     *   "OS": "7.11",
+     *   "DeviceModel": "Iphone 5s"
+     * });
      */
     LinkIOSDeviceID(request: LinkIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LinkIOSDeviceIDResult>;
     /**
      * Links the Kongregate identifier to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate Microsoft Documentation}
+     * @example
+     * await clientClient.LinkKongregate({
+     *   "KongregateId": "457332",
+     *   "AuthTicket": "{123-456-78931212}"
+     * });
      */
     LinkKongregate(request: LinkKongregateAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkKongregateAccountResult>;
     /**
      * Links the Nintendo account associated with the token to the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkNintendoServiceAccount({
+     *   "IdentityToken": "eyJraWQi..."
+     * });
      */
     LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Links the NintendoSwitchDeviceId to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.LinkNintendoSwitchDeviceId({
+     *   "NintendoSwitchDeviceId": "526f79204261747479"
+     * });
      */
     LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
     /**
      * Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an
      * Open ID Connect provider and the OpenId Connect JWT from that provider.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect Microsoft Documentation}
+     * @example
+     * await clientClient.LinkOpenIdConnect({
+     *   "ConnectionId": "exampleprovider",
+     *   "IdToken": "eyJraWQi..."
+     * });
      */
     LinkOpenIdConnect(request: LinkOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkPSNAccount({
+     *   "AuthCode": "LKJDG7DDE",
+     *   "RedirectUri": "orbis://games"
+     * });
      */
     LinkPSNAccount(request: LinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
     /**
      * Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkSteamAccount({
+     *   "SteamTicket": "steamTicketID",
+     *   "TicketIsServiceSpecific": true
+     * });
      */
     LinkSteamAccount(request: LinkSteamAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkSteamAccountResult>;
     /**
      * Links the Twitch account associated with the token to the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch Microsoft Documentation}
+     * @example
+     * await clientClient.LinkTwitch({
+     *   "AccessToken": "TwitchAccessToken"
+     * });
      */
     LinkTwitch(request: LinkTwitchAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkTwitchAccountResult>;
     /**
      * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LinkXboxAccount({
+     *   "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad"
+     * });
      */
     LinkXboxAccount(request: LinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkXboxAccountResult>;
     /**
      * Retrieves title-specific custom property values for a player.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties Microsoft Documentation}
+     * @example
+     * await clientClient.ListPlayerCustomProperties({});
      */
     ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
+    /**
+     * Logs a custom analytics event
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/logevent Microsoft Documentation}
+     * @deprecated Please use WritePlayerEvent instead.
+     */
+    LogEvent(request: LogEventRequest, extraHeaders?: Record<string, string>): Promise<LogEventResult>;
     /**
      * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for
      * API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithAndroidDeviceID({
+     *   "AndroidDeviceId": "526f79204261747479",
+     *   "OS": "5.0",
+     *   "AndroidDevice": "Nexus 6",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs in the user with a Sign in with Apple identity token.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithApple({
+     *   "IdentityToken": "eyJraWQi...",
+     *   "TitleId": "144"
+     * });
      */
     LoginWithApple(request: LoginWithAppleRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Sign in the user with a Battle.net identity token
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithBattleNet({
+     *   "IdentityToken": "eyJraWQi...",
+     *   "TitleId": "144"
+     * });
      */
     LoginWithBattleNet(request: LoginWithBattleNetRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can
      * subsequently be used for API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithCustomID({
+     *   "CustomId": "67AB-5397-CC54-EA31",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithCustomID(request: LoginWithCustomIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
@@ -4060,19 +5431,40 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the
      * creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via
      * RegisterPlayFabUser.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithEmailAddress({
+     *   "Email": "theuser@domain.com",
+     *   "Password": "thepassword",
+     *   "TitleId": "144"
+     * });
      */
     LoginWithEmailAddress(request: LoginWithEmailAddressRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API
      * calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithFacebook({
+     *   "AccessToken": "FaceAccessTokenID",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithFacebook(request: LoginWithFacebookRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for
      * API calls which require an authenticated user. Requires Facebook Instant Games to be configured.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithFacebookInstantGamesId({
+     *   "FacebookInstantGamesSignature": "abcdef",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithFacebookInstantGamesId(request: LoginWithFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
@@ -4081,45 +5473,104 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you
      * require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and
      * enabling the 'Require secure authentication only for this app' option.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithGameCenter({
+     *   "PlayerId": "pachycephalosaurus01",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithGameCenter(request: LoginWithGameCenterRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using their Google account credentials
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithGoogleAccount({
+     *   "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#",
+     *   "CreateAccount": false,
+     *   "SetEmail": true,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithGoogleAccount(request: LoginWithGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using their Google Play Games account credentials
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithGooglePlayGamesServices({
+     *   "ServerAuthCode": "4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithGooglePlayGamesServices(request: LoginWithGooglePlayGamesServicesRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently
      * be used for API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithIOSDeviceID({
+     *   "DeviceId": "29848d9bh8900a0b003",
+     *   "OS": "7.11",
+     *   "DeviceModel": "Iphone 5s",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Kongregate player account.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithKongregate({
+     *   "KongregateId": "457332",
+     *   "AuthTicket": "SomeKongregateTokenHere",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithKongregate(request: LoginWithKongregateRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs in the user with a Nintendo service account token.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithNintendoServiceAccount({
+     *   "IdentityToken": "eyJraWQi...",
+     *   "TitleId": "144"
+     * });
      */
     LoginWithNintendoServiceAccount(request: LoginWithNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for
      * API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithNintendoSwitchDeviceId({
+     *   "NintendoSwitchDeviceId": "526f79204261747479",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithNintendoSwitchDeviceId(request: LoginWithNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect
      * provider.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithOpenIdConnect({
+     *   "ConnectionId": "exampleprovider",
+     *   "IdToken": "eyJraWQi...",
+     *   "TitleId": "144"
+     * });
      */
     LoginWithOpenIdConnect(request: LoginWithOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
@@ -4127,86 +5578,203 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of
      * new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via
      * RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithPlayFab({
+     *   "Username": "theuser",
+     *   "Password": "ExampleSecret",
+     *   "TitleId": "144"
+     * });
      */
     LoginWithPlayFab(request: LoginWithPlayFabRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can
      * subsequently be used for API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithPSN({
+     *   "AuthCode": "LKJ6D896D",
+     *   "RedirectUri": "orbis://games",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithPSN(request: LoginWithPSNRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for
      * API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithSteam({
+     *   "SteamTicket": "steamTicketID",
+     *   "CreateAccount": false,
+     *   "TicketIsServiceSpecific": true,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithSteam(request: LoginWithSteamRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Twitch access token.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithTwitch({
+     *   "AccessToken": "SomeTwitchTokenHere",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithTwitch(request: LoginWithTwitchRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
     /**
      * Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls
      * which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox Microsoft Documentation}
+     * @example
+     * await clientClient.LoginWithXbox({
+     *   "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
+     *   "CreateAccount": false,
+     *   "TitleId": "144"
+     * });
      */
     LoginWithXbox(request: LoginWithXboxRequest, extraHeaders?: Record<string, string>): Promise<LoginResult>;
+    /**
+     * Attempts to locate a game session matching the given parameters. If the goal is to match the player into a specific
+     * active session, only the LobbyId is required. Otherwise, the BuildVersion, GameMode, and Region are all required
+     * parameters. Note that parameters specified in the search are required (they are not weighting factors). If a slot is
+     * found in a server instance matching the parameters, the slot will be assigned to that player, removing it from the
+     * availabe set. In that case, the information on the game session will be returned, otherwise the Status returned will be
+     * GameNotFound.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/matchmake Microsoft Documentation}
+     * @deprecated Please use Match/CreateMatchmakingTicket instead.
+     */
+    Matchmake(request: MatchmakeRequest, extraHeaders?: Record<string, string>): Promise<MatchmakeResult>;
     /**
      * Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
-     * https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade Microsoft Documentation}
+     * @example
+     * await clientClient.OpenTrade({
+     *   "OfferedInventoryInstanceIds": [
+     *     "1359447",
+     *     "635691"
+     *   ],
+     *   "RequestedCatalogItemIds": [
+     *     "rare_hat_7"
+     *   ]
+     * });
      */
     OpenTrade(request: OpenTradeRequest, extraHeaders?: Record<string, string>): Promise<OpenTradeResponse>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Selects a payment option for purchase order created via StartPurchase
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase Microsoft Documentation}
+     * @example
+     * await clientClient.PayForPurchase({
+     *   "OrderId": "8853591446005860822",
+     *   "ProviderName": "PayPal",
+     *   "Currency": "RM"
+     * });
      */
     PayForPurchase(request: PayForPurchaseRequest, extraHeaders?: Record<string, string>): Promise<PayForPurchaseResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as
      * well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem Microsoft Documentation}
+     * @example
+     * await clientClient.PurchaseItem({
+     *   "ItemId": "shield_level_5",
+     *   "VirtualCurrency": "GV",
+     *   "Price": 25
+     * });
      */
     PurchaseItem(request: PurchaseItemRequest, extraHeaders?: Record<string, string>): Promise<PurchaseItemResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the
      * Economy->Catalogs tab in the PlayFab Game Manager.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon Microsoft Documentation}
+     * @example
+     * await clientClient.RedeemCoupon({
+     *   "CouponCode": "123-1234-123",
+     *   "CatalogVersion": "5"
+     * });
      */
     RedeemCoupon(request: RedeemCouponRequest, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
     /**
      * Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken Microsoft Documentation}
+     * @example
+     * await clientClient.RefreshPSNAuthToken({
+     *   "AuthCode": "LKJDG7DDE",
+     *   "RedirectUri": "orbis://games"
+     * });
      */
     RefreshPSNAuthToken(request: RefreshPSNAuthTokenRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Registers the iOS device to receive push notifications
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification Microsoft Documentation}
+     * @example
+     * await clientClient.RegisterForIOSPushNotification({
+     *   "DeviceToken": "39872f98eb882brn8hg3889",
+     *   "SendPushNotificationConfirmation": true,
+     *   "ConfirmationMessage": "Welcome to PlayFab"
+     * });
      */
     RegisterForIOSPushNotification(request: RegisterForIOSPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<RegisterForIOSPushNotificationResult>;
     /**
      * Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which
      * require an authenticated user. You must supply a username and an email address.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser Microsoft Documentation}
+     * @example
+     * await clientClient.RegisterPlayFabUser({
+     *   "Username": "theuser",
+     *   "Email": "me@here.com",
+     *   "Password": "ExampleSecret",
+     *   "TitleId": "1"
+     * });
      */
     RegisterPlayFabUser(request: RegisterPlayFabUserRequest, extraHeaders?: Record<string, string>): Promise<RegisterPlayFabUserResult>;
     /**
      * Removes a contact email from the player's profile.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail Microsoft Documentation}
+     * @example
+     * await clientClient.RemoveContactEmail({});
      */
     RemoveContactEmail(request: RemoveContactEmailRequest, extraHeaders?: Record<string, string>): Promise<RemoveContactEmailResult>;
     /**
      * Removes a specified user from the friend list of the local user
-     * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend Microsoft Documentation}
+     * @example
+     * await clientClient.RemoveFriend({
+     *   "FriendPlayFabId": "29837799"
+     * });
      */
     RemoveFriend(request: RemoveFriendRequest, extraHeaders?: Record<string, string>): Promise<RemoveFriendResult>;
     /**
      * Removes the specified generic service identifier from the player's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid Microsoft Documentation}
+     * @example
+     * await clientClient.RemoveGenericID({
+     *   "GenericId": {
+     *     "ServiceName": "BigBizSocial",
+     *     "UserId": "1234567890"
+     *   }
+     * });
      */
     RemoveGenericID(request: RemoveGenericIDRequest, extraHeaders?: Record<string, string>): Promise<RemoveGenericIDResult>;
     /**
@@ -4214,158 +5782,323 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * group can remove members. If as a result of the call, zero users remain with access, the group and its associated data
      * will be deleted. Shared Groups are designed for sharing data between a very small number of players, please see our
      * guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
-     * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers Microsoft Documentation}
+     * @example
+     * await clientClient.RemoveSharedGroupMembers({
+     *   "SharedGroupId": "Clan Data",
+     *   "PlayFabIds": [
+     *     "D984A64B832",
+     *     "F74A523E1562"
+     *   ]
+     * });
      */
     RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
     /**
      * Report player's ad activity
-     * https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity Microsoft Documentation}
+     * @example
+     * await clientClient.ReportAdActivity({
+     *   "PlacementId": "A124572382B",
+     *   "RewardId": "B2674981A",
+     *   "Activity": "End"
+     * });
      */
     ReportAdActivity(request: ReportAdActivityRequest, extraHeaders?: Record<string, string>): Promise<ReportAdActivityResult>;
     /**
      * Write a PlayStream event to describe the provided player device information. This API method is not designed to be
      * called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
-     * https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo Microsoft Documentation}
+     * @example
+     * await clientClient.ReportDeviceInfo({
+     *   "Info": {
+     *     "UserAgent": "Some Browser",
+     *     "ScreenResolution": "640x480",
+     *     "processorCount": "2"
+     *   }
+     * });
      */
     ReportDeviceInfo(request: DeviceInfoRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title
      * can take action concerning potentially toxic players.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer Microsoft Documentation}
+     * @example
+     * await clientClient.ReportPlayer({
+     *   "ReporteeId": "1a46086aed40f142",
+     *   "Comment": "cheating"
+     * });
      */
     ReportPlayer(request: ReportPlayerClientRequest, extraHeaders?: Record<string, string>): Promise<ReportPlayerClientResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Restores all in-app purchases based on the given restore receipt
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases Microsoft Documentation}
+     * @example
+     * await clientClient.RestoreIOSPurchases({
+     *   "ReceiptData": "F00000000000000000000"
+     * });
      */
     RestoreIOSPurchases(request: RestoreIOSPurchasesRequest, extraHeaders?: Record<string, string>): Promise<RestoreIOSPurchasesResult>;
     /**
      * Reward player's ad activity
-     * https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity Microsoft Documentation}
+     * @example
+     * await clientClient.RewardAdActivity({
+     *   "PlacementId": "A124572382B",
+     *   "RewardId": "B2674981A"
+     * });
      */
     RewardAdActivity(request: RewardAdActivityRequest, extraHeaders?: Record<string, string>): Promise<RewardAdActivityResult>;
+    /**
+     * Triggers a particular server action, passing the provided inputs to the hosted Cloud Script. An action in this context
+     * is a handler in the JavaScript. NOTE: Before calling this API, you must call GetCloudScriptUrl to be assigned a Cloud
+     * Script server URL. When using an official PlayFab SDK, this URL is stored internally in the SDK, but GetCloudScriptUrl
+     * must still be manually called.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/runcloudscript Microsoft Documentation}
+     * @deprecated Please use ExecuteCloudScript instead.
+     */
+    RunCloudScript(request: RunCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<RunCloudScriptResult>;
     /**
      * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
      * change the password.If an account recovery email template ID is provided, an email using the custom email template will
      * be used.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail Microsoft Documentation}
+     * @example
+     * await clientClient.SendAccountRecoveryEmail({
+     *   "Email": "Me@here.com",
+     *   "TitleId": "1000",
+     *   "EmailTemplateId": "D53AB15D8F12E330"
+     * });
      */
     SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
     /**
      * Updates the tag list for a specified user in the friend list of the local user
-     * https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags Microsoft Documentation}
+     * @example
+     * await clientClient.SetFriendTags({
+     *   "FriendPlayFabId": "29837799",
+     *   "Tags": [
+     *     "great sniper",
+     *     "no good at melee"
+     *   ]
+     * });
      */
     SetFriendTags(request: SetFriendTagsRequest, extraHeaders?: Record<string, string>): Promise<SetFriendTagsResult>;
     /**
      * Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's
      * secret use the Admin or Server API method SetPlayerSecret.
-     * https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret Microsoft Documentation}
+     * @example
+     * await clientClient.SetPlayerSecret({
+     *   "PlayerSecret": "A cryptographically strong string"
+     * });
      */
     SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
+    /**
+     * Start a new game server with a given configuration, add the current player and return the connection information.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/matchmaking/startgame Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    StartGame(request: StartGameRequest, extraHeaders?: Record<string, string>): Promise<StartGameResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Creates an order for a list of items from the title catalog
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase Microsoft Documentation}
+     * @example
+     * await clientClient.StartPurchase({
+     *   "CatalogVersion": "0",
+     *   "StoreId": "BonusStore",
+     *   "Items": [
+     *     {
+     *       "ItemId": "something",
+     *       "Quantity": 1,
+     *       "Annotation": "totally buying something"
+     *     }
+     *   ]
+     * });
      */
     StartPurchase(request: StartPurchaseRequest, extraHeaders?: Record<string, string>): Promise<StartPurchaseResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make
      * a VC balance negative with this API.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
+     * @example
+     * await clientClient.SubtractUserVirtualCurrency({
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
     /**
      * Unlinks the related Android device identifier from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkAndroidDeviceID({
+     *   "AndroidDeviceId": "526f79204261747479"
+     * });
      */
     UnlinkAndroidDeviceID(request: UnlinkAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkAndroidDeviceIDResult>;
     /**
      * Unlinks the related Apple account from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkApple({});
      */
     UnlinkApple(request: UnlinkAppleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Unlinks the related Battle.net account from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkBattleNetAccount({});
      */
     UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Unlinks the related custom identifier from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkCustomID({
+     *   "CustomId": "67AB-5397-CC54-EA31"
+     * });
      */
     UnlinkCustomID(request: UnlinkCustomIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkCustomIDResult>;
     /**
      * Unlinks the related Facebook account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkFacebookAccount({});
      */
     UnlinkFacebookAccount(request: UnlinkFacebookAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookAccountResult>;
     /**
      * Unlinks the related Facebook Instant Game Ids from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkFacebookInstantGamesId({
+     *   "FacebookInstantGamesId": "1114685845316173"
+     * });
      */
     UnlinkFacebookInstantGamesId(request: UnlinkFacebookInstantGamesIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkFacebookInstantGamesIdResult>;
     /**
      * Unlinks the related Game Center account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkGameCenterAccount({});
      */
     UnlinkGameCenterAccount(request: UnlinkGameCenterAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGameCenterAccountResult>;
     /**
      * Unlinks the related Google account from the user's PlayFab account
      * (https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods).
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkGoogleAccount({});
      */
     UnlinkGoogleAccount(request: UnlinkGoogleAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGoogleAccountResult>;
     /**
      * Unlinks the related Google Play Games account from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkGooglePlayGamesServicesAccount({});
      */
     UnlinkGooglePlayGamesServicesAccount(request: UnlinkGooglePlayGamesServicesAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkGooglePlayGamesServicesAccountResult>;
     /**
      * Unlinks the related iOS device identifier from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkIOSDeviceID({
+     *   "DeviceId": "29848d9bh8900a0b003"
+     * });
      */
     UnlinkIOSDeviceID(request: UnlinkIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<UnlinkIOSDeviceIDResult>;
     /**
      * Unlinks the related Kongregate identifier from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkKongregate({});
      */
     UnlinkKongregate(request: UnlinkKongregateAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkKongregateAccountResult>;
     /**
      * Unlinks the related Nintendo account from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkNintendoServiceAccount({});
      */
     UnlinkNintendoServiceAccount(request: UnlinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkNintendoSwitchDeviceId({
+     *   "NintendoSwitchDeviceId": "526f79204261747479"
+     * });
      */
     UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
     /**
      * Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship
      * between a title and an Open ID Connect provider.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkOpenIdConnect({
+     *   "ConnectionId": "exampleprovider"
+     * });
      */
     UnlinkOpenIdConnect(request: UnlinkOpenIdConnectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkPSNAccount({});
      */
     UnlinkPSNAccount(request: UnlinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
     /**
      * Unlinks the related Steam account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkSteamAccount({});
      */
     UnlinkSteamAccount(request: UnlinkSteamAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkSteamAccountResult>;
     /**
      * Unlinks the related Twitch account from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkTwitch({});
      */
     UnlinkTwitch(request: UnlinkTwitchAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkTwitchAccountResult>;
     /**
      * Unlinks the related Xbox Live account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount Microsoft Documentation}
+     * @example
+     * await clientClient.UnlinkXboxAccount({});
      */
     UnlinkXboxAccount(request: UnlinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
     /**
@@ -4373,7 +6106,13 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * version 2._ Opens the specified container, with the specified key (when required), and returns the contents of the
      * opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will
      * be decremented, consistent with the operation of ConsumeItem.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance Microsoft Documentation}
+     * @example
+     * await clientClient.UnlockContainerInstance({
+     *   "ContainerItemInstanceId": "123456788",
+     *   "KeyItemInstanceId": "123456789"
+     * });
      */
     UnlockContainerInstance(request: UnlockContainerInstanceRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
     /**
@@ -4381,34 +6120,100 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * version 2._ Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it
      * using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are
      * consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem Microsoft Documentation}
+     * @example
+     * await clientClient.UnlockContainerItem({
+     *   "ContainerItemId": "crate block 1"
+     * });
      */
     UnlockContainerItem(request: UnlockContainerItemRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
     /**
      * Update the avatar URL of the player
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateAvatarUrl({
+     *   "ImageUrl": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
+     * });
      */
     UpdateAvatarUrl(request: UpdateAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateCharacterData({
+     *   "CharacterId": "98765456",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateCharacterData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
     /**
      * Updates the values of the specified title-specific statistics for the specific character. By default, clients are not
      * permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
-     * https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateCharacterStatistics({
+     *   "CharacterId": "98765432",
+     *   "CharacterStatistics": {
+     *     "Headshots": 18,
+     *     "Kills": 47
+     *   }
+     * });
      */
     UpdateCharacterStatistics(request: UpdateCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterStatisticsResult>;
     /**
      * Updates the title-specific custom property values for a player
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties Microsoft Documentation}
+     * @example
+     * await clientClient.UpdatePlayerCustomProperties({
+     *   "Properties": [
+     *     {
+     *       "Name": "level",
+     *       "Value": 5
+     *     },
+     *     {
+     *       "Name": "created",
+     *       "Value": false
+     *     }
+     *   ],
+     *   "ExpectedPropertiesVersion": 12
+     * });
      */
     UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
     /**
      * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
      * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics Microsoft Documentation}
+     * @example
+     * await clientClient.UpdatePlayerStatistics({
+     *   "Statistics": [
+     *     {
+     *       "StatisticName": "Points",
+     *       "Version": 1,
+     *       "Value": 600
+     *     },
+     *     {
+     *       "StatisticName": "Wins",
+     *       "Version": 0,
+     *       "Value": 16
+     *     },
+     *     {
+     *       "StatisticName": "Stars",
+     *       "Value": 7
+     *     }
+     *   ]
+     * });
      */
     UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
     /**
@@ -4417,64 +6222,173 @@ declare class PlayFabClientApi extends PlayFabCommon {
      * Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for
      * sharing data between a very small number of players, please see our guide:
      * https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data
-     * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateSharedGroupData({
+     *   "SharedGroupId": "Clan Data",
+     *   "Data": {
+     *     "ClanKills": "34",
+     *     "LastClanUpdate": "2014-10-03T09:21:14Z"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
     /**
      * Creates and updates the title-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateUserData({
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * Creates and updates the publisher-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateUserPublisherData({
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
+    /**
+     * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to
+     * update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserstatistics Microsoft Documentation}
+     * @deprecated Please use UpdatePlayerStatistics instead.
+     */
+    UpdateUserStatistics(request: UpdateUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserStatisticsResult>;
     /**
      * Updates the title specific display name for the user
-     * https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname Microsoft Documentation}
+     * @example
+     * await clientClient.UpdateUserTitleDisplayName({
+     *   "DisplayName": "User Title Name"
+     * });
      */
     UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches
      * the purchased catalog item
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt Microsoft Documentation}
+     * @example
+     * await clientClient.ValidateAmazonIAPReceipt({
+     *   "ReceiptId": "q1YqVbJSyjH28DGPKChw9c0o8nd3vSstssQtzSkrzM8tCk43K6z0d_HOTcwwN8vxCrVV0lEqBmpJzs_VK8hJrExLTNLLTCzQK8_MSUnJTy8LSpcoWRnoKKUAFRmaGBtZmBqCCFMzpVoA",
+     *   "UserId": "l3HL7XppEMhrOGDgur9-ulvqomrSg6qyODKmah72lJU="
+     * });
      */
     ValidateAmazonIAPReceipt(request: ValidateAmazonReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateAmazonReceiptResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Validates a Google Play purchase and gives the corresponding item to the player.
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase Microsoft Documentation}
+     * @example
+     * await clientClient.ValidateGooglePlayPurchase({
+     *   "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\"}",
+     *   "Signature": "ks12w0hHHpuit4xW3Fyoa5XX6TkxZ2KpEnBsLfpHHpeakYs2JgVtlLdgyLp/05Zp8oHAuKZyIAJTd2RIFXWMAUwDNUsI0JPBDMpr2oaL66Kuneg4VrGWJkJZTrvTyQoGpnTDdXfEME31iFKX6CrKHvWlAG9nwWxYatd58l83eevQ8CIrJhka/bC5ynw3j18OmFG7AcxymO37a4HkM8QjytvAYDJeOnDU9mooY7afcHIajtffdyAU9kzGWOqDByiU9IsRdkliwQoQYbuX/R5wQnMVZ+FGDDwO1mybx9B20rm7/WCBnWGy2NLsSAFI77iX8tUy/QebfBQhrVnRORi7bw==",
+     *   "CurrencyCode": "USD",
+     *   "PurchasePrice": 199
+     * });
      */
     ValidateGooglePlayPurchase(request: ValidateGooglePlayPurchaseRequest, extraHeaders?: Record<string, string>): Promise<ValidateGooglePlayPurchaseResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the
      * purchased catalog item
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt Microsoft Documentation}
+     * @example
+     * await clientClient.ValidateIOSReceipt({
+     *   "ReceiptData": "MTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nzc3Nw0KODgNCjk5OTk5OTk5OTk5OQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nw0KODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODgNCjkNCkFwcGxlIEluYy4gV29ybGR3aWRlIERldmVsb3BlciBSZWxhdGlvbnMgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgKG5vdCByZWFsbHkgLSBmYWtlIFBsYXlGYWIgZXhhbXBsZSwgYnV0IGNvbmdyYXRzIG9uIHRoaW5raW5nIHRvIGRlY29kZSB0aGlzISkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3Nzc3DQo4OA0KOTk5OTk5OTk5OTk5DQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3DQo4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4OA0KOQ0KQXBwbGUgSW5jLiBXb3JsZHdpZGUgRGV2ZWxvcGVyIFJlbGF0aW9ucyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAobm90IHJlYWxseSAtIGZha2UgUGxheUZhYiBleGFtcGxlLCBidXQgY29uZ3JhdHMgb24gdGhpbmtpbmcgdG8gZGVjb2RlIHRoaXMhKQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw",
+     *   "CurrencyCode": "GBP",
+     *   "PurchasePrice": 199
+     * });
      */
     ValidateIOSReceipt(request: ValidateIOSReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateIOSReceiptResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it
      * matches the purchased catalog item
-     * https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt Microsoft Documentation}
+     * @example
+     * await clientClient.ValidateWindowsStoreReceipt({
+     *   "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"
+     * });
      */
     ValidateWindowsStoreReceipt(request: ValidateWindowsReceiptRequest, extraHeaders?: Record<string, string>): Promise<ValidateWindowsReceiptResult>;
     /**
      * Writes a character-based event into PlayStream.
-     * https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent Microsoft Documentation}
+     * @example
+     * await clientClient.WriteCharacterEvent({
+     *   "CharacterId": "E161CB4B7F6C34B",
+     *   "EventName": "character_defeated_enemy",
+     *   "Timestamp": "2016-03-07T00:00:00Z",
+     *   "Body": {
+     *     "Enemy": "guardian",
+     *     "Damage": 5,
+     *     "Coordinates": {
+     *       "X": 123.4,
+     *       "Y": 543.2
+     *     }
+     *   }
+     * });
      */
     WriteCharacterEvent(request: WriteClientCharacterEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
     /**
      * Writes a player-based event into PlayStream.
-     * https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent Microsoft Documentation}
+     * @example
+     * await clientClient.WritePlayerEvent({
+     *   "EventName": "player_defeated_enemy",
+     *   "Timestamp": "2014-03-07T00:00:00Z",
+     *   "Body": {
+     *     "Enemy": "guardian",
+     *     "Damage": 5,
+     *     "Coordinates": {
+     *       "X": 123.4,
+     *       "Y": 543.2
+     *     }
+     *   }
+     * });
      */
     WritePlayerEvent(request: WriteClientPlayerEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
     /**
      * Writes a title-based event into PlayStream.
-     * https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent Microsoft Documentation}
+     * @example
+     * await clientClient.WriteTitleEvent({
+     *   "EventName": "client_update_submitted",
+     *   "Timestamp": "2016-03-07T00:00:00Z",
+     *   "Body": {
+     *     "Version": "1.4.50"
+     *   }
+     * });
      */
     WriteTitleEvent(request: WriteTitleEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
 }