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

package/dist/Server.d.ts

@@ -1,4 +1,4 @@
-import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-BX3jSqGx.js';
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
 
 interface AdCampaignAttribution {
     /** UTC time stamp of attribution */
@@ -126,8 +126,20 @@ interface BanInfo {
     Created?: string;
     /** The time when this ban expires. Permanent bans do not have expiration date. */
     Expires?: string;
+    /**
+     * Whether or not the Microsoft family members are included in the ban. This property is deprecated and does not work
+     * anymore.
+     * @deprecated Please use UserFamilyType instead.
+     */
+    IncludeMicrosoftFamily?: boolean;
     /** The IP address on which the ban was applied. May affect multiple players. */
     IPAddress?: string;
+    /**
+     * The MAC address on which the ban was applied. May affect multiple players. This property is deprecated and does not work
+     * anymore.
+     * @deprecated Do not use
+     */
+    MACAddress?: string;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId?: string;
     /** The reason why this ban was applied. */
@@ -138,8 +150,19 @@ interface BanInfo {
 interface BanRequest {
     /** The duration in hours for the ban. Leave this blank for a permanent ban. */
     DurationInHours?: number;
+    /**
+     * Whether the Microsoft family members should be included in the ban. May affect multiple players. This property is
+     * deprecated and does not work anymore.
+     * @deprecated Please use UserFamilyType instead.
+     */
+    IncludeMicrosoftFamily?: boolean;
     /** IP address to be banned. May affect multiple players. */
     IPAddress?: string;
+    /**
+     * MAC address to be banned. May affect multiple players. This property is deprecated and does not work anymore.
+     * @deprecated Do not use
+     */
+    MACAddress?: string;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
     /** The reason for this ban. Maximum 140 characters. */
@@ -216,7 +239,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 {
@@ -236,7 +259,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;
     /**
@@ -278,9 +301,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 {
@@ -334,9 +357,9 @@ interface CreateSharedGroupResult extends IPlayFabResultCommon {
     SharedGroupId?: string;
 }
 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 DeleteCharacterFromUserRequest extends IPlayFabRequestCommon {
@@ -347,7 +370,7 @@ interface DeleteCharacterFromUserRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
     /**
-     * If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those
+     * If true, the character&#39;s inventory will be transferred up to the owning user; otherwise, this request will purge those
      * items.
      */
     SaveCharacterInventory: boolean;
@@ -365,7 +388,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;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
@@ -379,7 +402,7 @@ interface DeletePlayerCustomPropertiesResult extends IPlayFabResultCommon {
     /** PlayFab unique identifier of the user whose properties were deleted. */
     PlayFabId?: string;
     /**
-     * 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;
@@ -400,6 +423,26 @@ interface DeleteSharedGroupRequest extends IPlayFabRequestCommon {
     /** Unique identifier for the shared group. */
     SharedGroupId: string;
 }
+/** @deprecated Do not use */
+interface DeleteUsersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** An array of unique PlayFab assigned ID of the user on whom the operation will be performed. */
+    PlayFabIds: string[];
+}
+/** @deprecated Do not use */
+interface DeleteUsersResult extends IPlayFabResultCommon {
+}
+/** @deprecated Do not use */
+interface DeregisterGameRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Unique identifier for the Game Server Instance that is being deregistered. */
+    LobbyId: string;
+}
+/** @deprecated Do not use */
+interface DeregisterGameResponse extends IPlayFabResultCommon {
+}
 interface EmptyResult extends IPlayFabResultCommon {
 }
 interface EntityKey {
@@ -407,6 +450,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. */
@@ -473,19 +521,19 @@ interface ExecuteCloudScriptServerRequest 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;
     /** The unique user identifier for the player on whose behalf the script is being run */
     PlayFabId: string;
     /**
-     * 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 FacebookInstantGamesPlayFabIdPair {
@@ -501,6 +549,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. */
@@ -540,6 +593,21 @@ interface GenericServiceId {
     /** Unique identifier of the player in that service. */
     UserId: string;
 }
+/** @deprecated Do not use */
+interface GetActionGroupResult {
+    /** Action Group ID */
+    Id?: string;
+    /** Action Group name */
+    Name: string;
+}
+/** @deprecated Do not use */
+interface GetAllActionGroupsRequest extends IPlayFabRequestCommon {
+}
+/** @deprecated Do not use */
+interface GetAllActionGroupsResult extends IPlayFabResultCommon {
+    /** List of Action Groups. */
+    ActionGroups: GetActionGroupResult[];
+}
 interface GetAllSegmentsRequest extends IPlayFabRequestCommon {
 }
 interface GetAllSegmentsResult extends IPlayFabResultCommon {
@@ -603,6 +671,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. */
     MaxResultsCount: number;
     /** First entry in the leaderboard to be retrieved. */
@@ -647,10 +720,20 @@ 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. */
     MaxResultsCount: number;
     /** The player whose friend leaderboard to get */
@@ -658,13 +741,15 @@ interface GetFriendLeaderboardRequest 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 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. */
@@ -674,16 +759,26 @@ 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;
     /** PlayFab identifier of the player whose friend list to get. */
     PlayFabId: string;
     /**
      * 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. */
@@ -696,6 +791,11 @@ interface GetFriendsListResult extends IPlayFabResultCommon {
 interface GetLeaderboardAroundCharacterRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID for a specific character owned by a user */
     CharacterId: string;
+    /**
+     * Optional character type on which to filter the leaderboard entries.
+     * @deprecated Do not use
+     */
+    CharacterType?: string;
     /** Maximum number of entries to retrieve. */
     MaxResultsCount: number;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
@@ -717,11 +817,13 @@ interface GetLeaderboardAroundUserRequest 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;
     /** Unique identifier for the title-specific statistic for the 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;
 }
@@ -734,6 +836,11 @@ interface GetLeaderboardAroundUserResult extends IPlayFabResultCommon {
     Version: number;
 }
 interface GetLeaderboardForUsersCharactersRequest extends IPlayFabRequestCommon {
+    /**
+     * Maximum number of entries to retrieve.
+     * @deprecated Please use  instead.
+     */
+    MaxResultsCount?: number;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
     /** Unique identifier for the title-specific statistic for the leaderboard. */
@@ -751,13 +858,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;
     /** First entry in the leaderboard to be retrieved. */
     StartPosition: number;
     /** Unique identifier for the title-specific statistic for the 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;
 }
@@ -788,19 +897,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[];
@@ -838,7 +947,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>;
@@ -852,14 +961,14 @@ interface GetPlayerCombinedInfoResultPayload {
 interface GetPlayerCustomPropertyRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
-    /** 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 {
     /** PlayFab unique identifier of the user whose properties are being returned. */
     PlayFabId?: string;
     /**
-     * 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;
@@ -874,7 +983,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;
 }
@@ -967,7 +1076,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 GetPlayFabIDsFromBattleNetAccountIdsRequest extends IPlayFabRequestCommon {
@@ -1063,6 +1172,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.
@@ -1086,7 +1200,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[];
@@ -1271,6 +1385,20 @@ 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>;
+    /** User for whom statistics are being requested. */
+    PlayFabId: string;
+}
+/** @deprecated Do not use */
+interface GetUserStatisticsResult extends IPlayFabResultCommon {
+    /** PlayFab unique identifier of the user whose statistics are being returned. */
+    PlayFabId?: string;
+    /** User statistics for the requested user. */
+    UserStatistics?: Record<string, number>;
+}
 interface GrantCharacterToUserRequest extends IPlayFabRequestCommon {
     /** Non-unique display name of the character being granted (1-40 characters in length). */
     CharacterName: string;
@@ -1301,7 +1429,7 @@ interface GrantedItemInstance {
     CharacterId?: 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. */
@@ -1382,7 +1510,7 @@ interface ItemGrant {
     CharacterId?: string;
     /**
      * 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>;
     /** Unique identifier of the catalog item to be granted to the user. */
@@ -1409,7 +1537,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. */
@@ -1481,7 +1609,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;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
@@ -1549,7 +1677,7 @@ interface LinkXboxAccountRequest extends IPlayFabRequestCommon {
     ForceLink?: boolean;
     /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
     PlayFabId: 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 LinkXboxAccountResult extends IPlayFabResultCommon {
@@ -1564,7 +1692,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;
@@ -1595,10 +1723,49 @@ 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>;
+    /**
+     * For non player-associated events, a unique ID for the entity associated with this event. For player associated events,
+     * this must be null and PlayFabId must be set.
+     */
+    EntityId?: string;
+    /**
+     * For non player-associated events, the type of entity associated with this event. For player associated events, this must
+     * be null.
+     */
+    EntityType?: string;
+    /**
+     * 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;
+    /**
+     * PlayFab User Id of the player associated with this event. For non-player associated events, this must be null and
+     * EntityId must be set.
+     */
+    PlayFabId?: 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 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;
@@ -1606,7 +1773,7 @@ interface LoginWithAndroidDeviceIDRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
-    /** Specific Operating System version for the user's device. */
+    /** Specific Operating System version for the user&#39;s device. */
     OS?: string;
 }
 interface LoginWithBattleNetRequest extends IPlayFabRequestCommon {
@@ -1618,6 +1785,11 @@ interface LoginWithBattleNetRequest 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;
 }
 interface LoginWithCustomIDRequest extends IPlayFabRequestCommon {
     /** Automatically create a PlayFab account if one is not currently linked to this ID. */
@@ -1634,13 +1806,13 @@ 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;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
-    /** Specific Operating System version for the user's device. */
+    /** Specific Operating System version for the user&#39;s device. */
     OS?: string;
 }
 interface LoginWithPSNRequest extends IPlayFabRequestCommon {
@@ -1654,6 +1826,11 @@ interface LoginWithPSNRequest extends IPlayFabRequestCommon {
     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;
     /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */
     RedirectUri: string;
 }
@@ -1664,6 +1841,11 @@ interface LoginWithServerCustomIdRequest 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;
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
     /** The backend server identifier for this player. */
@@ -1676,6 +1858,11 @@ interface LoginWithSteamIdRequest 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;
     /** Unique Steam identifier for a user. */
     SteamId: string;
 }
@@ -1686,6 +1873,11 @@ interface LoginWithXboxIdRequest 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;
     /** The id of Xbox Live sandbox. */
     Sandbox: string;
     /** Unique Xbox identifier for a user. */
@@ -1698,13 +1890,18 @@ interface LoginWithXboxRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** Flags for which pieces of info to return for the user. */
     InfoRequestParameters?: GetPlayerCombinedInfoRequestParams;
-    /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */
+    /**
+     * Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.
+     * @deprecated Do not use
+     */
+    LoginTitlePlayerAccountEntity?: boolean;
+    /** 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;
 }
@@ -1720,6 +1917,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[];
 }
@@ -1749,7 +1948,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;
@@ -1805,44 +2004,58 @@ interface NintendoSwitchPlayFabIdPair {
     /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier. */
     PlayFabId?: string;
 }
+/** @deprecated Do not use */
+interface NotifyMatchmakerPlayerLeftRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Unique identifier of the Game Instance the user is leaving. */
+    LobbyId: string;
+    /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
+    PlayFabId: string;
+}
+/** @deprecated Do not use */
+interface NotifyMatchmakerPlayerLeftResult extends IPlayFabResultCommon {
+    /** State of user leaving the Game Server Instance. */
+    PlayerState?: string;
+}
 interface PlayerLeaderboardEntry {
     /** Title-specific display name of the user for this leaderboard entry. */
     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 PlayerLinkedAccount {
-    /** Linked account's email */
+    /** Linked account&#39;s email */
     Email?: string;
     /** Authentication platform */
     Platform?: string;
     /** Platform user identifier */
     PlatformUserId?: string;
-    /** Linked account's username */
+    /** Linked account&#39;s username */
     Username?: string;
 }
 interface PlayerLocation {
-    /** City of the player's geographic location. */
+    /** City of the player&#39;s geographic location. */
     City?: string;
     /** The two-character continent code for this location */
     ContinentCode: string;
     /** The two-character ISO 3166-1 country code for the country associated with the location */
     CountryCode: string;
-    /** Latitude coordinate of the player's geographic location. */
+    /** Latitude coordinate of the player&#39;s geographic location. */
     Latitude?: number;
-    /** Longitude coordinate of the player's geographic location. */
+    /** Longitude coordinate of the player&#39;s geographic location. */
     Longitude?: number;
 }
 interface PlayerProfile {
     /** Array of ad campaigns player has been attributed to */
     AdCampaignAttributions?: AdCampaignAttribution[];
-    /** Image URL of the player's avatar. */
+    /** Image URL of the player&#39;s avatar. */
     AvatarUrl?: string;
     /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */
     BannedUntil?: string;
@@ -1852,7 +2065,7 @@ interface PlayerProfile {
     ContactEmailAddresses?: ContactEmailInfo[];
     /** Player record created */
     Created?: string;
-    /** Dictionary of player's custom properties. */
+    /** Dictionary of player&#39;s custom properties. */
     CustomProperties?: Record<string, any>;
     /** Player Display Name */
     DisplayName?: string;
@@ -1860,7 +2073,7 @@ interface PlayerProfile {
     LastLogin?: string;
     /** Array of third party accounts linked to this player */
     LinkedAccounts?: PlayerLinkedAccount[];
-    /** Dictionary of player's locations by type. */
+    /** Dictionary of player&#39;s locations by type. */
     Locations?: Record<string, PlayerLocation>;
     /** Player account origination */
     Origination?: string;
@@ -1874,23 +2087,23 @@ interface PlayerProfile {
     PublisherId?: string;
     /** Array of configured push notification end points */
     PushNotificationRegistrations?: PushNotificationRegistration[];
-    /** Dictionary of player's statistics using only the latest version's value */
+    /** Dictionary of player&#39;s statistics using only the latest version&#39;s value */
     Statistics?: Record<string, number>;
-    /** List of player's tags for segmentation. */
+    /** List of player&#39;s tags for segmentation. */
     Tags?: string[];
     /** Title ID this profile applies to */
     TitleId?: string;
-    /** A sum of player's total purchases in USD across all currencies. */
+    /** A sum of player&#39;s total purchases in USD across all currencies. */
     TotalValueToDateInUSD?: number;
-    /** Dictionary of player's total purchases by currency. */
+    /** Dictionary of player&#39;s total purchases by currency. */
     ValuesToDate?: Record<string, number>;
-    /** Dictionary of player's virtual currency balances */
+    /** Dictionary of player&#39;s virtual currency balances */
     VirtualCurrencyBalances?: Record<string, 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;
@@ -1924,20 +2137,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;
@@ -1949,15 +2162,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;
@@ -2023,6 +2236,12 @@ interface PushNotificationPackage {
     Icon?: string;
     /** Content of the message (all platforms) */
     Message: string;
+    /**
+     * This field was solely for use with the PlayFab custom Push Plugin, which has been deprecated in favor of the supported
+     * platform-specific fields
+     * @deprecated Please use CustomData instead.
+     */
+    ScheduleDate?: string;
     /** Sound file to play with the message (all platforms) */
     Sound?: string;
     /** Title/Subject of the message. Not supported for iOS */
@@ -2064,6 +2283,74 @@ interface RedeemCouponResult extends IPlayFabResultCommon {
     /** Items granted to the player as a result of redeeming the coupon. */
     GrantedItems?: ItemInstance[];
 }
+/** @deprecated Do not use */
+interface RedeemMatchmakerTicketRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Unique identifier of the Game Server Instance that is asking for validation of the authorization ticket. */
+    LobbyId: string;
+    /** Server authorization ticket passed back from a call to Matchmake or StartGame. */
+    Ticket: string;
+}
+/** @deprecated Do not use */
+interface RedeemMatchmakerTicketResult extends IPlayFabResultCommon {
+    /** Error value if the ticket was not validated. */
+    Error?: string;
+    /** Boolean indicating whether the ticket was validated by the PlayFab service. */
+    TicketIsValid: boolean;
+    /** User account information for the user validated. */
+    UserInfo?: UserAccountInfo;
+}
+/** @deprecated Do not use */
+interface RefreshGameServerInstanceHeartbeatRequest extends IPlayFabRequestCommon {
+    /** Unique identifier of the Game Server Instance for which the heartbeat is updated. */
+    LobbyId: string;
+}
+/** @deprecated Do not use */
+interface RefreshGameServerInstanceHeartbeatResult extends IPlayFabResultCommon {
+}
+/** @deprecated Do not use */
+interface RegisterGameRequest extends IPlayFabRequestCommon {
+    /** Unique identifier of the build running on the Game Server Instance. */
+    Build: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Game Mode the Game Server instance is running. Note that this must be defined in the Game Modes tab in the PlayFab Game
+     * Manager, along with the Build ID (the same Game Mode can be defined for multiple Build IDs).
+     */
+    GameMode: string;
+    /** Previous lobby id if re-registering an existing game. */
+    LobbyId?: string;
+    /**
+     * Region in which the Game Server Instance is running. For matchmaking using non-AWS region names, set this to any AWS
+     * region and use Tags (below) to specify your custom region.
+     */
+    Region: string;
+    /**
+     * IPV4 address of the Game Server Instance.
+     * @deprecated Please use ServerIPV4Address instead.
+     */
+    ServerHost?: string;
+    /** IPV4 address of the game server instance. */
+    ServerIPV4Address?: string;
+    /** IPV6 address (if any) of the game server instance. */
+    ServerIPV6Address?: string;
+    /** Port number for communication with the Game Server Instance. */
+    ServerPort: string;
+    /** Public DNS name (if any) of the server */
+    ServerPublicDNSName?: string;
+    /** Tags for the Game Server Instance */
+    Tags?: Record<string, string | null>;
+}
+/** @deprecated Do not use */
+interface RegisterGameResponse extends IPlayFabResultCommon {
+    /**
+     * Unique identifier generated for the Game Server Instance that is registered. If LobbyId is specified in request and the
+     * game still exists in PlayFab, the LobbyId in request is returned. Otherwise a new lobby id will be returned.
+     */
+    LobbyId?: string;
+}
 interface RemoveFriendRequest extends IPlayFabRequestCommon {
     /** PlayFab identifier of the friend account which is to be removed. */
     FriendPlayFabId: string;
@@ -2107,6 +2394,11 @@ interface ReportPlayerServerRequest extends IPlayFabRequestCommon {
 interface ReportPlayerServerResult extends IPlayFabResultCommon {
     /** The number of remaining reports which may be filed today by this reporting player. */
     SubmissionsRemaining: number;
+    /**
+     * Deprecated: Always true
+     * @deprecated Do not use
+     */
+    Updated?: boolean;
 }
 interface ResultTableNode {
     /** Either an ItemId, or the TableId of another random result table */
@@ -2198,7 +2490,7 @@ interface SendCustomAccountRecoveryEmailRequest extends IPlayFabRequestCommon {
     Email?: string;
     /** The email template id of the account recovery email template to send. */
     EmailTemplateId: string;
-    /** The user's username requesting an account recovery. */
+    /** The user&#39;s username requesting an account recovery. */
     Username?: string;
 }
 interface SendCustomAccountRecoveryEmailResult extends IPlayFabResultCommon {
@@ -2259,11 +2551,11 @@ interface ServerLoginResult 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;
@@ -2280,6 +2572,39 @@ interface SetFriendTagsRequest extends IPlayFabRequestCommon {
     /** Array of tags to set on the friend account. */
     Tags: string[];
 }
+/** @deprecated Do not use */
+interface SetGameServerInstanceDataRequest extends IPlayFabRequestCommon {
+    /** Custom data to set for the specified game server instance. */
+    GameServerData: string;
+    /** Unique identifier of the Game Instance to be updated, in decimal format. */
+    LobbyId: string;
+}
+/** @deprecated Do not use */
+interface SetGameServerInstanceDataResult extends IPlayFabResultCommon {
+}
+/** @deprecated Do not use */
+interface SetGameServerInstanceStateRequest extends IPlayFabRequestCommon {
+    /** Unique identifier of the Game Instance to be updated, in decimal format. */
+    LobbyId: string;
+    /** State to set for the specified game server instance. */
+    State: string;
+}
+/** @deprecated Do not use */
+interface SetGameServerInstanceStateResult extends IPlayFabResultCommon {
+}
+/** @deprecated Do not use */
+interface SetGameServerInstanceTagsRequest extends IPlayFabRequestCommon {
+    /** Unique identifier of the Game Server Instance to be updated. */
+    LobbyId: string;
+    /**
+     * Tags to set for the specified Game Server Instance. Note that this is the complete list of tags to be associated with
+     * the Game Server Instance.
+     */
+    Tags: Record<string, string | null>;
+}
+/** @deprecated Do not use */
+interface SetGameServerInstanceTagsResult extends IPlayFabResultCommon {
+}
 interface SetPlayerSecretRequest extends IPlayFabRequestCommon {
     /** Player secret that is used to verify API request signatures (Enterprise Only). */
     PlayerSecret?: string;
@@ -2290,8 +2615,8 @@ interface SetPlayerSecretResult extends IPlayFabResultCommon {
 }
 interface SetPublisherDataRequest extends IPlayFabRequestCommon {
     /**
-     * key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
-     * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
+     * key we want to set a value on (note, this is additive - will only replace an existing key&#39;s value if they are the same
+     * name.) Keys are trimmed of whitespace. Keys may not begin with the &#39;!&#39; character.
      */
     Key: string;
     /** new value to set. Set to null to remove a value */
@@ -2301,8 +2626,8 @@ interface SetPublisherDataResult extends IPlayFabResultCommon {
 }
 interface SetTitleDataRequest extends IPlayFabRequestCommon {
     /**
-     * key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same
-     * name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.
+     * key we want to set a value on (note, this is additive - will only replace an existing key&#39;s value if they are the same
+     * name.) Keys are trimmed of whitespace. Keys may not begin with the &#39;!&#39; character.
      */
     Key: string;
     /** new value to set. Set to null to remove a value */
@@ -2362,6 +2687,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;
 }
@@ -2377,7 +2707,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 {
@@ -2393,7 +2723,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;
@@ -2505,6 +2835,11 @@ interface UnlinkXboxAccountRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */
     PlayFabId: string;
+    /**
+     * 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 {
 }
@@ -2566,8 +2901,19 @@ interface UpdateBanRequest {
     BanId: string;
     /** The updated expiration date for the ban. Null for no change. */
     Expires?: string;
+    /**
+     * The updated decision to ban the Microsoft family members to be updated. Null for no change. This property is deprecated
+     * and does not work anymore.
+     * @deprecated Please use UserFamilyType instead.
+     */
+    IncludeMicrosoftFamily?: boolean;
     /** The updated IP address for the ban. Null for no change. */
     IPAddress?: string;
+    /**
+     * The updated MAC address for the ban. Null for no change. This property is deprecated and does not work anymore.
+     * @deprecated Do not use
+     */
+    MACAddress?: string;
     /** Whether to make this ban permanent. Set to true to make this ban permanent. This will not modify Active state. */
     Permanent?: boolean;
     /** The updated reason for the ban to be updated. Maximum 140 characters. Null for no change. */
@@ -2590,7 +2936,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>;
     /**
@@ -2598,7 +2944,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;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
@@ -2627,7 +2973,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;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
@@ -2639,7 +2985,7 @@ interface UpdatePlayerCustomPropertiesResult extends IPlayFabResultCommon {
     /** PlayFab unique identifier of the user whose properties were updated. */
     PlayFabId?: string;
     /**
-     * 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;
@@ -2670,7 +3016,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>;
     /**
@@ -2690,7 +3036,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>;
     /**
@@ -2698,7 +3044,7 @@ interface UpdateUserDataRequest 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;
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
@@ -2715,7 +3061,7 @@ interface UpdateUserInternalDataRequest 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>;
     /**
@@ -2733,7 +3079,7 @@ interface UpdateUserInventoryItemDataRequest 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>;
     /** Unique PlayFab assigned instance identifier of the item */
@@ -2746,6 +3092,18 @@ interface UpdateUserInventoryItemDataRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
 }
+/** @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>;
+    /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
+    PlayFabId: string;
+    /** Statistics to be updated with the provided values. */
+    UserStatistics?: Record<string, number>;
+}
+/** @deprecated Do not use */
+interface UpdateUserStatisticsResult extends IPlayFabResultCommon {
+}
 interface UserAccountInfo {
     /** User Android device information, if an Android device has been linked */
     AndroidDeviceInfo?: UserAndroidDeviceInfo;
@@ -2920,7 +3278,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
@@ -2960,12 +3318,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;
 }
@@ -3050,25 +3408,53 @@ declare class PlayFabServerApi extends PlayFabCommon {
     /**
      * _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 character's balance of the specified virtual currency by the stated amount
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency Microsoft Documentation}
+     * @example
+     * await serverClient.AddCharacterVirtualCurrency({
+     *   "PlayFabId": "20394883",
+     *   "CharacterId": "23424524523",
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     AddCharacterVirtualCurrency(request: AddCharacterVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
     /**
      * Adds the Friend user to the friendlist of the user with PlayFabId. At least one of
      * FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
-     * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend Microsoft Documentation}
+     * @example
+     * await serverClient.AddFriend({
+     *   "PlayFabId": "10931252888739651331",
+     *   "FriendPlayFabId": "20394883"
+     * });
      */
     AddFriend(request: AddFriendRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * 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/server/account-management/addgenericid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid Microsoft Documentation}
+     * @example
+     * await serverClient.AddGenericID({
+     *   "GenericId": {
+     *     "ServiceName": "BigBizSocial",
+     *     "UserId": "1234567890"
+     *   }
+     * });
      */
     AddGenericID(request: AddGenericIDRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
-     * https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag Microsoft Documentation}
+     * @example
+     * await serverClient.AddPlayerTag({
+     *   "PlayFabId": "10931252888739651331",
+     *   "TagName": "MostKilled"
+     * });
      */
     AddPlayerTag(request: AddPlayerTagRequest, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
     /**
@@ -3076,35 +3462,94 @@ declare class PlayFabServerApi extends PlayFabCommon {
      * in the group (and the server) 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/server/shared-group-data/addsharedgroupmembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers Microsoft Documentation}
+     * @example
+     * await serverClient.AddSharedGroupMembers({
+     *   "SharedGroupId": "Clan Data",
+     *   "PlayFabIds": [
+     *     "D984A64B832",
+     *     "F74A523E1562"
+     *   ]
+     * });
      */
     AddSharedGroupMembers(request: AddSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<AddSharedGroupMembersResult>;
     /**
      * _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/server/player-item-management/adduservirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency Microsoft Documentation}
+     * @example
+     * await serverClient.AddUserVirtualCurrency({
+     *   "PlayFabId": "20394883",
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
     /**
      * Validated a client's session ticket, and if successful, returns details for that user
-     * https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket Microsoft Documentation}
+     * @example
+     * await serverClient.AuthenticateSessionTicket({
+     *   "SessionTicket": "4D2----8D11F4249A80000-7C64AB0A9F1D8D1A.CD803BF233CE76CC"
+     * });
      */
     AuthenticateSessionTicket(request: AuthenticateSessionTicketRequest, extraHeaders?: Record<string, string>): Promise<AuthenticateSessionTicketResult>;
     /**
      * Awards the specified users the specified Steam achievements
-     * https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement Microsoft Documentation}
+     * @example
+     * await serverClient.AwardSteamAchievement({
+     *   "Achievements": [
+     *     {
+     *       "PlayFabId": "234974573892",
+     *       "AchievementName": "FinishLevel1",
+     *       "Result": false
+     *     },
+     *     {
+     *       "PlayFabId": "334353433",
+     *       "AchievementName": "FinishLevel1",
+     *       "Result": false
+     *     }
+     *   ]
+     * });
      */
     AwardSteamAchievement(request: AwardSteamAchievementRequest, extraHeaders?: Record<string, string>): Promise<AwardSteamAchievementResult>;
     /**
      * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers Microsoft Documentation}
+     * @example
+     * await serverClient.BanUsers({
+     *   "Bans": [
+     *     {
+     *       "PlayFabId": "1679AF5CD04BD838",
+     *       "IPAddress": "192.168.1.1",
+     *       "Reason": "You cheated!",
+     *       "DurationInHours": 7
+     *     },
+     *     {
+     *       "PlayFabId": "2329AF5CD04BF513",
+     *       "Reason": "Caught you using speed hack!"
+     *     }
+     *   ]
+     * });
      */
     BanUsers(request: BanUsersRequest, extraHeaders?: Record<string, string>): Promise<BanUsersResult>;
     /**
      * _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/server/player-item-management/consumeitem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem Microsoft Documentation}
+     * @example
+     * await serverClient.ConsumeItem({
+     *   "ItemInstanceId": "94585729",
+     *   "ConsumeCount": 1
+     * });
      */
     ConsumeItem(request: ConsumeItemRequest, extraHeaders?: Record<string, string>): Promise<ConsumeItemResult>;
     /**
@@ -3112,97 +3557,239 @@ declare class PlayFabServerApi extends PlayFabCommon {
      * group. When created by a server, the group will initially have no 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/server/shared-group-data/createsharedgroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup Microsoft Documentation}
+     * @example
+     * await serverClient.CreateSharedGroup({
+     *   "SharedGroupId": "Clan Data"
+     * });
      */
     CreateSharedGroup(request: CreateSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateSharedGroupResult>;
     /**
      * Deletes the specific character ID from the specified user.
-     * https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser Microsoft Documentation}
+     * @example
+     * await serverClient.DeleteCharacterFromUser({
+     *   "PlayFabId": "12345",
+     *   "CharacterId": "98765432",
+     *   "SaveCharacterInventory": false
+     * });
      */
     DeleteCharacterFromUser(request: DeleteCharacterFromUserRequest, extraHeaders?: Record<string, string>): Promise<DeleteCharacterFromUserResult>;
     /**
      * Removes a user's player account from a title and deletes all associated data
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer Microsoft Documentation}
+     * @example
+     * await serverClient.DeletePlayer({
+     *   "PlayFabId": "A68C908B66C23C5"
+     * });
      */
     DeletePlayer(request: DeletePlayerRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerResult>;
     /**
      * Deletes title-specific custom properties for a player
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties Microsoft Documentation}
+     * @example
+     * await serverClient.DeletePlayerCustomProperties({
+     *   "PlayFabId": "2039475",
+     *   "PropertyNames": [
+     *     "level",
+     *     "created"
+     *   ],
+     *   "ExpectedPropertiesVersion": 12
+     * });
      */
     DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
     /**
      * Deletes push notification template for title
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate Microsoft Documentation}
+     * @example
+     * await serverClient.DeletePushNotificationTemplate({
+     *   "PushNotificationTemplateId": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4"
+     * });
      */
     DeletePushNotificationTemplate(request: DeletePushNotificationTemplateRequest, extraHeaders?: Record<string, string>): Promise<DeletePushNotificationTemplateResult>;
     /**
      * Deletes a shared group, freeing up the shared group ID to be reused for a new 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/server/shared-group-data/deletesharedgroup
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup Microsoft Documentation}
+     * @example
+     * await serverClient.DeleteSharedGroup({
+     *   "SharedGroupId": "Clan Data"
+     * });
      */
     DeleteSharedGroup(request: DeleteSharedGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Deletes custom data, all account linkages, and statistics.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteusers Microsoft Documentation}
+     * @deprecated Please use DeletePlayer instead.
+     */
+    DeleteUsers(request: DeleteUsersRequest, extraHeaders?: Record<string, string>): Promise<DeleteUsersResult>;
+    /**
+     * Inform the matchmaker that a Game Server Instance is removed.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/deregistergame Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    DeregisterGame(request: DeregisterGameRequest, extraHeaders?: Record<string, string>): Promise<DeregisterGameResponse>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would
      * have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to
      * UnlockContainer.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable Microsoft Documentation}
+     * @example
+     * await serverClient.EvaluateRandomResultTable({
+     *   "TableId": "RareElementCard",
+     *   "CatalogVersion": "1"
+     * });
      */
     EvaluateRandomResultTable(request: EvaluateRandomResultTableRequest, extraHeaders?: Record<string, string>): Promise<EvaluateRandomResultTableResult>;
     /**
      * 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/server/server-side-cloud-script/executecloudscript
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript Microsoft Documentation}
+     * @example
+     * await serverClient.ExecuteCloudScript({
+     *   "PlayFabId": "1337D00D",
+     *   "FunctionName": "levelCompleted",
+     *   "FunctionParameter": {
+     *     "level": 3,
+     *     "points": 400
+     *   },
+     *   "RevisionSelection": "Live",
+     *   "GeneratePlayStreamEvent": true
+     * });
      */
     ExecuteCloudScript(request: ExecuteCloudScriptServerRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
+    /**
+     * Retrieve a list of all PlayStream actions groups.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getallactiongroups Microsoft Documentation}
+     * @deprecated Please use GetAllSegments instead.
+     */
+    GetAllActionGroups(request: GetAllActionGroupsRequest, extraHeaders?: Record<string, string>): Promise<GetAllActionGroupsResult>;
     /**
      * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as
      * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.
-     * https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments Microsoft Documentation}
+     * @example
+     * await serverClient.GetAllSegments({});
      */
     GetAllSegments(request: GetAllSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
     /**
      * 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/server/characters/getalluserscharacters
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/title-wide-data-management/getcatalogitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems Microsoft Documentation}
+     * @example
+     * await serverClient.GetCatalogItems({
+     *   "CatalogVersion": "1"
+     * });
      */
     GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
     /**
      * Retrieves the title-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata Microsoft Documentation}
+     * @example
+     * await serverClient.GetCharacterData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 1
+     * });
      */
     GetCharacterData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
     /**
      * Retrieves the title-specific custom data for the user's character which cannot be accessed by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.GetCharacterInternalData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 1
+     * });
      */
     GetCharacterInternalData(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/server/player-item-management/getcharacterinventory
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory Microsoft Documentation}
+     * @example
+     * await serverClient.GetCharacterInventory({
+     *   "PlayFabId": "204883457",
+     *   "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/server/characters/getcharacterleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard Microsoft Documentation}
+     * @example
+     * await serverClient.GetCharacterLeaderboard({
+     *   "StatisticName": "Kills",
+     *   "StartPosition": 0,
+     *   "MaxResultsCount": 20
+     * });
      */
     GetCharacterLeaderboard(request: GetCharacterLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterLeaderboardResult>;
     /**
      * Retrieves the title-specific custom data for the user's character which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata Microsoft Documentation}
+     * @example
+     * await serverClient.GetCharacterReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 1
+     * });
      */
     GetCharacterReadOnlyData(request: GetCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterDataResult>;
     /**
      * Retrieves the details of all title-specific statistics for the specific character
-     * https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics Microsoft Documentation}
+     * @example
+     * await serverClient.GetCharacterStatistics({
+     *   "PlayFabId": "10931252888739651331",
+     *   "CharacterId": "98765432"
+     * });
      */
     GetCharacterStatistics(request: GetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<GetCharacterStatisticsResult>;
     /**
@@ -3212,60 +3799,146 @@ declare class PlayFabServerApi 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/server/content/getcontentdownloadurl
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl Microsoft Documentation}
+     * @example
+     * await serverClient.GetContentDownloadUrl({
+     *   "Key": "images/sword_icon.png"
+     * });
      */
     GetContentDownloadUrl(request: GetContentDownloadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentDownloadUrlResult>;
     /**
      * Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the
      * leaderboard
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard Microsoft Documentation}
+     * @example
+     * await serverClient.GetFriendLeaderboard({
+     *   "PlayFabId": "98092347523",
+     *   "StatisticName": "Kills",
+     *   "StartPosition": 1258,
+     *   "MaxResultsCount": 20,
+     *   "ExternalPlatformFriends": "None"
+     * });
      */
     GetFriendLeaderboard(request: GetFriendLeaderboardRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardResult>;
     /**
      * Retrieves the current friends for the user with PlayFabId, 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/server/friend-list-management/getfriendslist
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist Microsoft Documentation}
+     * @example
+     * await serverClient.GetFriendsList({
+     *   "PlayFabId": "93798903892789754",
+     *   "ExternalPlatformFriends": "All"
+     * });
      */
     GetFriendsList(request: GetFriendsListRequest, extraHeaders?: Record<string, string>): Promise<GetFriendsListResult>;
     /**
      * 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/server/player-data-management/getleaderboard
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard Microsoft Documentation}
+     * @example
+     * await serverClient.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 user
-     * https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter Microsoft Documentation}
+     * @example
+     * await serverClient.GetLeaderboardAroundCharacter({
+     *   "StatisticName": "Kills",
+     *   "PlayFabId": "10931252888739651331",
+     *   "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
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser Microsoft Documentation}
+     * @example
+     * await serverClient.GetLeaderboardAroundUser({
+     *   "StatisticName": "Kills",
+     *   "PlayFabId": "10931252888739651331",
+     *   "MaxResultsCount": 20
+     * });
      */
     GetLeaderboardAroundUser(request: GetLeaderboardAroundUserRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardAroundUserResult>;
     /**
      * Retrieves a list of all of the user's characters for the given statistic.
-     * https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters Microsoft Documentation}
+     * @example
+     * await serverClient.GetLeaderboardForUserCharacters({
+     *   "StatisticName": "Kills",
+     *   "PlayFabId": "10931252888739651331"
+     * });
      */
     GetLeaderboardForUserCharacters(request: GetLeaderboardForUsersCharactersRequest, extraHeaders?: Record<string, string>): Promise<GetLeaderboardForUsersCharactersResult>;
     /**
      * Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be
      * returned. All parameters default to false.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/player-data-management/getplayercustomproperty
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty Microsoft Documentation}
+     * @example
+     * await serverClient.GetPlayerCustomProperty({
+     *   "PlayFabId": "2039475",
+     *   "PropertyName": "level"
+     * });
      */
     GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
     /**
      * Retrieves the player's profile
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/playstream/getplayersegments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments Microsoft Documentation}
+     * @example
+     * await serverClient.GetPlayerSegments({
+     *   "PlayFabId": "1337AA00"
+     * });
      */
     GetPlayerSegments(request: GetPlayersSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
     /**
@@ -3274,358 +3947,893 @@ declare class PlayFabServerApi extends PlayFabCommon {
      * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected
      * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being
      * called 30 times in one minute. You will be returned an error if you exceed this threshold.
-     * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment Microsoft Documentation}
+     * @example
+     * await serverClient.GetPlayersInSegment({
+     *   "SegmentId": "1337AA00",
+     *   "SecondsToLive": 5,
+     *   "MaxBatchSize": 500
+     * });
      */
     GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
     /**
      * Retrieves the current version and values for the indicated statistics, for the local player.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics Microsoft Documentation}
+     * @example
+     * await serverClient.GetPlayerStatistics({
+     *   "PlayFabId": "621EF2023753444",
+     *   "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/server/player-data-management/getplayerstatisticversions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/playstream/getplayertags
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags Microsoft Documentation}
+     * @example
+     * await serverClient.GetPlayerTags({
+     *   "PlayFabId": "10931252888739651331",
+     *   "Namespace": "title.AAA"
+     * });
      */
     GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
     /**
      * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfromfacebookids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids Microsoft Documentation}
+     * @example
+     * await serverClient.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 Games identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids Microsoft Documentation}
+     * @example
+     * await serverClient.GetPlayFabIDsFromFacebookInstantGamesIds({
+     *   "FacebookInstantGamesIds": [
+     *     "1114685845316172",
+     *     "1114685845316173"
+     *   ]
+     * });
      */
     GetPlayFabIDsFromFacebookInstantGamesIds(request: GetPlayFabIDsFromFacebookInstantGamesIdsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayFabIDsFromFacebookInstantGamesIdsResult>;
     /**
      * 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/server/account-management/getplayfabidsfromgenericids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids Microsoft Documentation}
+     * @example
+     * await serverClient.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 Nintendo Service Account identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfromnintendoswitchdeviceids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfrompsnaccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfrompsnonlineids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfromsteamids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfromsteamnames
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfromtwitchids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/account-management/getplayfabidsfromxboxliveids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/title-wide-data-management/getpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata Microsoft Documentation}
+     * @example
+     * await serverClient.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 the configuration information for the specified random results tables for the title, including all
      * ItemId values and weights
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables Microsoft Documentation}
+     * @example
+     * await serverClient.GetRandomResultTables({
+     *   "CatalogVersion": "1",
+     *   "TableIDs": [
+     *     "CommonElementCard",
+     *     "UncommonElementCard",
+     *     "RareElementCard"
+     *   ]
+     * });
      */
     GetRandomResultTables(request: GetRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
     /**
      * Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids Microsoft Documentation}
+     * @example
+     * await serverClient.GetServerCustomIDsFromPlayFabIDs({
+     *   "PlayFabIDs": [
+     *     "1232421311"
+     *   ]
+     * });
      */
     GetServerCustomIDsFromPlayFabIDs(request: GetServerCustomIDsFromPlayFabIDsRequest, extraHeaders?: Record<string, string>): Promise<GetServerCustomIDsFromPlayFabIDsResult>;
     /**
      * Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all
      * public and private group 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/server/shared-group-data/getsharedgroupdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata Microsoft Documentation}
+     * @example
+     * await serverClient.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, for the specified
      * player
-     * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems Microsoft Documentation}
+     * @example
+     * await serverClient.GetStoreItems({
+     *   "StoreId": "BonusStore",
+     *   "PlayFabId": "20394883"
+     * });
      */
     GetStoreItems(request: GetStoreItemsServerRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
     /**
      * Retrieves the current server time
-     * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime Microsoft Documentation}
+     * @example
+     * await serverClient.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/server/title-wide-data-management/gettitledata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata Microsoft Documentation}
+     * @example
+     * await serverClient.GetTitleData({
+     *   "Keys": [
+     *     "color",
+     *     "propertyA"
+     *   ]
+     * });
      */
     GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
     /**
      * Retrieves the key-value store of custom internal title settings
-     * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.GetTitleInternalData({
+     *   "Keys": [
+     *     "color",
+     *     "propertyA"
+     *   ]
+     * });
      */
     GetTitleInternalData(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/server/title-wide-data-management/gettitlenews
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews Microsoft Documentation}
+     * @example
+     * await serverClient.GetTitleNews({
+     *   "Count": 25
+     * });
      */
     GetTitleNews(request: GetTitleNewsRequest, extraHeaders?: Record<string, string>): Promise<GetTitleNewsResult>;
     /**
      * Retrieves the relevant details for a specified user
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserAccountInfo({
+     *   "PlayFabId": "10931252888739651331"
+     * });
      */
     GetUserAccountInfo(request: GetUserAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<GetUserAccountInfoResult>;
     /**
      * Gets all bans for a user.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserBans({
+     *   "PlayFabId": "1679AF5CD04BD838"
+     * });
      */
     GetUserBans(request: GetUserBansRequest, extraHeaders?: Record<string, string>): Promise<GetUserBansResult>;
     /**
      * Retrieves the title-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     GetUserData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
     /**
      * Retrieves the title-specific custom data for the user which cannot be accessed by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserInternalData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     GetUserInternalData(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 specified user's current inventory of virtual goods
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserInventory({
+     *   "PlayFabId": "204883457"
+     * });
      */
     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/server/player-data-management/getuserpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserPublisherData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     GetUserPublisherData(request: GetUserDataRequest, extraHeaders?: Record<string, string>): Promise<GetUserDataResult>;
     /**
      * Retrieves the publisher-specific custom data for the user which cannot be accessed by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserPublisherInternalData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     GetUserPublisherInternalData(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/server/player-data-management/getuserpublisherreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserPublisherReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     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/server/player-data-management/getuserreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata Microsoft Documentation}
+     * @example
+     * await serverClient.GetUserReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     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/server/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/server/characters/grantcharactertouser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser Microsoft Documentation}
+     * @example
+     * await serverClient.GrantCharacterToUser({
+     *   "PlayFabId": "20394883567",
+     *   "CharacterName": "FighterDude",
+     *   "CharacterType": "Blue Warrior"
+     * });
      */
     GrantCharacterToUser(request: GrantCharacterToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantCharacterToUserResult>;
     /**
      * _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 specified items to the specified character's inventory
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter Microsoft Documentation}
+     * @example
+     * await serverClient.GrantItemsToCharacter({
+     *   "CharacterId": "9876543268",
+     *   "PlayFabId": "20394883",
+     *   "Annotation": "Entered Level 2",
+     *   "ItemIds": [
+     *     "shield_level_5",
+     *     "shield_level_6"
+     *   ]
+     * });
      */
     GrantItemsToCharacter(request: GrantItemsToCharacterRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToCharacterResult>;
     /**
      * _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 specified items to the specified user's inventory
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser Microsoft Documentation}
+     * @example
+     * await serverClient.GrantItemsToUser({
+     *   "PlayFabId": "20394883",
+     *   "Annotation": "Entered Level 2",
+     *   "ItemIds": [
+     *     "shield_level_3",
+     *     "shield_level_4"
+     *   ]
+     * });
      */
     GrantItemsToUser(request: GrantItemsToUserRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUserResult>;
     /**
      * _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 specified items to the specified user inventories
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers Microsoft Documentation}
+     * @example
+     * await serverClient.GrantItemsToUsers({
+     *   "CatalogVersion": "5",
+     *   "ItemGrants": [
+     *     {
+     *       "PlayFabId": "20394883",
+     *       "ItemId": "shield_level_1",
+     *       "Annotation": "Entered Level 2"
+     *     },
+     *     {
+     *       "PlayFabId": "20394883",
+     *       "ItemId": "shield_level_2",
+     *       "Annotation": "Entered Level 2",
+     *       "Data": {
+     *         "Equipped": "True",
+     *         "Slot": "Head"
+     *       }
+     *     }
+     *   ]
+     * });
      */
     GrantItemsToUsers(request: GrantItemsToUsersRequest, extraHeaders?: Record<string, string>): Promise<GrantItemsToUsersResult>;
     /**
      * Links the Battle.net account associated with the token to the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount Microsoft Documentation}
+     * @example
+     * await serverClient.LinkBattleNetAccount({
+     *   "PlayFabId": "1234FA342",
+     *   "IdentityToken": "eyJraWQi..."
+     * });
      */
     LinkBattleNetAccount(request: LinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Links the Nintendo account associated with the token to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount Microsoft Documentation}
+     * @example
+     * await serverClient.LinkNintendoServiceAccount({
+     *   "PlayFabId": "1234FA342",
+     *   "IdentityToken": "eyJraWQi..."
+     * });
      */
     LinkNintendoServiceAccount(request: LinkNintendoServiceAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject Microsoft Documentation}
+     * @example
+     * await serverClient.LinkNintendoServiceAccountSubject({
+     *   "PlayFabId": "1234FA342",
+     *   "Subject": "8e7Eju4j9"
+     * });
      */
     LinkNintendoServiceAccountSubject(request: LinkNintendoServiceAccountSubjectRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Links the NintendoSwitchDeviceId to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid Microsoft Documentation}
+     * @example
+     * await serverClient.LinkNintendoSwitchDeviceId({
+     *   "PlayFabId": "1234FA342",
+     *   "NintendoSwitchDeviceId": "526f79204261747479"
+     * });
      */
     LinkNintendoSwitchDeviceId(request: LinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<LinkNintendoSwitchDeviceIdResult>;
     /**
      * 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/server/account-management/linkpsnaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount Microsoft Documentation}
+     * @example
+     * await serverClient.LinkPSNAccount({
+     *   "PlayFabId": "1234FA342",
+     *   "AuthCode": "LKJDG7DDE",
+     *   "RedirectUri": "orbis://games"
+     * });
      */
     LinkPSNAccount(request: LinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNAccountResult>;
     /**
      * Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid Microsoft Documentation}
+     * @example
+     * await serverClient.LinkPSNId({
+     *   "PlayFabId": "1234FA342",
+     *   "PSNUserId": "LKJDG7DDE"
+     * });
      */
     LinkPSNId(request: LinkPSNIdRequest, extraHeaders?: Record<string, string>): Promise<LinkPSNIdResponse>;
     /**
      * Links the custom server identifier, generated by the title, to the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid Microsoft Documentation}
+     * @example
+     * await serverClient.LinkServerCustomId({
+     *   "PlayFabId": "123412341234",
+     *   "ServerCustomId": "67AB-5397-CC54-EA31"
+     * });
      */
     LinkServerCustomId(request: LinkServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<LinkServerCustomIdResult>;
     /**
      * Links the Steam account associated with the provided Steam ID to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid Microsoft Documentation}
+     * @example
+     * await serverClient.LinkSteamId({
+     *   "SteamId": "22223333",
+     *   "PlayFabId": "5a446c83645201"
+     * });
      */
     LinkSteamId(request: LinkSteamIdRequest, extraHeaders?: Record<string, string>): Promise<LinkSteamIdResult>;
     /**
      * Links the Xbox Live account associated with the provided access code to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount Microsoft Documentation}
+     * @example
+     * await serverClient.LinkXboxAccount({
+     *   "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
+     *   "PlayFabId": "5a446c83645201"
+     * });
      */
     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/server/player-data-management/listplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties Microsoft Documentation}
+     * @example
+     * await serverClient.ListPlayerCustomProperties({
+     *   "PlayFabId": "2039475"
+     * });
      */
     ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
+    /**
+     * Logs a custom analytics event
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/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/server/authentication/loginwithandroiddeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithAndroidDeviceID({
+     *   "AndroidDeviceId": "526f79204261747479",
+     *   "OS": "5.0",
+     *   "AndroidDevice": "Nexus 6",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithAndroidDeviceID(request: LoginWithAndroidDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * Sign in the user with a Battle.net identity token
-     * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithBattleNet({
+     *   "IdentityToken": "eyJraWQi..."
+     * });
      */
     LoginWithBattleNet(request: LoginWithBattleNetRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * 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/server/authentication/loginwithcustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithCustomID({
+     *   "CustomId": "67AB-5397-CC54-EA31",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithCustomID(request: LoginWithCustomIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * Signs the user in using the 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/server/authentication/loginwithiosdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithIOSDeviceID({
+     *   "DeviceId": "29848d9bh8900a0b003",
+     *   "OS": "7.11",
+     *   "DeviceModel": "Iphone 5s",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithIOSDeviceID(request: LoginWithIOSDeviceIDRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * 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/server/authentication/loginwithpsn
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithpsn Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithPSN({
+     *   "AuthCode": "LKJ6D896D",
+     *   "RedirectUri": "orbis://games",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithPSN(request: LoginWithPSNRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID
      * and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.
-     * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithServerCustomId({
+     *   "ServerCustomId": "asdalsdkjar09u23ijf",
+     *   "CreateAccount": true
+     * });
      */
     LoginWithServerCustomId(request: LoginWithServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * Signs the user in using an Steam 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/server/authentication/loginwithsteamid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithSteamId({
+     *   "SteamId": "12344553",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithSteamId(request: LoginWithSteamIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can
      * subsequently be used for API calls which require an authenticated user
-     * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithXbox({
+     *   "XboxToken": "XBL3.0 x=1981989841;akljdlkafdknad",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithXbox(request: LoginWithXboxRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * Signs the user in using an Xbox ID and Sandbox 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/server/authentication/loginwithxboxid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid Microsoft Documentation}
+     * @example
+     * await serverClient.LoginWithXboxId({
+     *   "XboxId": "12344553",
+     *   "Sandbox": "RETAIL",
+     *   "CreateAccount": false
+     * });
      */
     LoginWithXboxId(request: LoginWithXboxIdRequest, extraHeaders?: Record<string, string>): Promise<ServerLoginResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Modifies the number of remaining uses of a player's inventory item
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses Microsoft Documentation}
+     * @example
+     * await serverClient.ModifyItemUses({
+     *   "PlayFabId": "20394883",
+     *   "ItemInstanceId": "94585729",
+     *   "UsesToAdd": 1
+     * });
      */
     ModifyItemUses(request: ModifyItemUsesRequest, extraHeaders?: Record<string, string>): Promise<ModifyItemUsesResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Moves an item from a character's inventory into another of the users's character's inventory.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter Microsoft Documentation}
+     * @example
+     * await serverClient.MoveItemToCharacterFromCharacter({
+     *   "PlayFabId": "234234897234",
+     *   "GivingCharacterId": "98092347523",
+     *   "ReceivingCharacterId": "6323489712",
+     *   "ItemInstanceId": "701231299999"
+     * });
      */
     MoveItemToCharacterFromCharacter(request: MoveItemToCharacterFromCharacterRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromCharacterResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Moves an item from a user's inventory into their character's inventory.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser Microsoft Documentation}
+     * @example
+     * await serverClient.MoveItemToCharacterFromUser({
+     *   "PlayFabId": "234234897234",
+     *   "CharacterId": "98092347523",
+     *   "ItemInstanceId": "701231299999"
+     * });
      */
     MoveItemToCharacterFromUser(request: MoveItemToCharacterFromUserRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToCharacterFromUserResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Moves an item from a character's inventory into the owning user's inventory.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter Microsoft Documentation}
+     * @example
+     * await serverClient.MoveItemToUserFromCharacter({
+     *   "PlayFabId": "234234897234",
+     *   "CharacterId": "98092347523",
+     *   "ItemInstanceId": "701231299999"
+     * });
      */
     MoveItemToUserFromCharacter(request: MoveItemToUserFromCharacterRequest, extraHeaders?: Record<string, string>): Promise<MoveItemToUserFromCharacterResult>;
+    /**
+     * Informs the PlayFab match-making service that the user specified has left the Game Server Instance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/notifymatchmakerplayerleft Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    NotifyMatchmakerPlayerLeft(request: NotifyMatchmakerPlayerLeftRequest, extraHeaders?: Record<string, string>): Promise<NotifyMatchmakerPlayerLeftResult>;
     /**
      * _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/server/player-item-management/redeemcoupon
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon Microsoft Documentation}
+     * @example
+     * await serverClient.RedeemCoupon({
+     *   "CouponCode": "123-1234-123",
+     *   "CatalogVersion": "5"
+     * });
      */
     RedeemCoupon(request: RedeemCouponRequest, extraHeaders?: Record<string, string>): Promise<RedeemCouponResult>;
+    /**
+     * Validates a Game Server session ticket and returns details about the user
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/redeemmatchmakerticket Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    RedeemMatchmakerTicket(request: RedeemMatchmakerTicketRequest, extraHeaders?: Record<string, string>): Promise<RedeemMatchmakerTicketResult>;
+    /**
+     * Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/refreshgameserverinstanceheartbeat Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    RefreshGameServerInstanceHeartbeat(request: RefreshGameServerInstanceHeartbeatRequest, extraHeaders?: Record<string, string>): Promise<RefreshGameServerInstanceHeartbeatResult>;
+    /**
+     * Inform the matchmaker that a new Game Server Instance is added.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/registergame Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    RegisterGame(request: RegisterGameRequest, extraHeaders?: Record<string, string>): Promise<RegisterGameResponse>;
     /**
      * Removes the specified friend from the the user's friend list
-     * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend Microsoft Documentation}
+     * @example
+     * await serverClient.RemoveFriend({
+     *   "FriendPlayFabId": "29837799",
+     *   "PlayFabId": "1a46086aed40f142"
+     * });
      */
     RemoveFriend(request: RemoveFriendRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Removes the specified generic service identifier from the player's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid Microsoft Documentation}
+     * @example
+     * await serverClient.RemoveGenericID({
+     *   "GenericId": {
+     *     "ServiceName": "BigBizSocial",
+     *     "UserId": "1234567890"
+     *   }
+     * });
      */
     RemoveGenericID(request: RemoveGenericIDRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
-     * https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag Microsoft Documentation}
+     * @example
+     * await serverClient.RemovePlayerTag({
+     *   "PlayFabId": "10931252888739651331",
+     *   "TagName": "MostKilled"
+     * });
      */
     RemovePlayerTag(request: RemovePlayerTagRequest, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
     /**
@@ -3633,138 +4841,332 @@ declare class PlayFabServerApi 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/server/shared-group-data/removesharedgroupmembers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers Microsoft Documentation}
+     * @example
+     * await serverClient.RemoveSharedGroupMembers({
+     *   "SharedGroupId": "Clan Data",
+     *   "PlayFabIds": [
+     *     "D984A64B832",
+     *     "F74A523E1562"
+     *   ]
+     * });
      */
     RemoveSharedGroupMembers(request: RemoveSharedGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<RemoveSharedGroupMembersResult>;
     /**
      * Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service
      * representatives for the title can take action concerning potentially toxic players.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer Microsoft Documentation}
+     * @example
+     * await serverClient.ReportPlayer({
+     *   "ReporterId": "9ddafe27d6d445da",
+     *   "ReporteeId": "1a46086aed40f142",
+     *   "Comment": "cheating"
+     * });
      */
     ReportPlayer(request: ReportPlayerServerRequest, extraHeaders?: Record<string, string>): Promise<ReportPlayerServerResult>;
     /**
      * Revoke all active bans for a user.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser Microsoft Documentation}
+     * @example
+     * await serverClient.RevokeAllBansForUser({
+     *   "PlayFabId": "1679AF5CD04BD838"
+     * });
      */
     RevokeAllBansForUser(request: RevokeAllBansForUserRequest, extraHeaders?: Record<string, string>): Promise<RevokeAllBansForUserResult>;
     /**
      * Revoke all active bans specified with BanId.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans Microsoft Documentation}
+     * @example
+     * await serverClient.RevokeBans({
+     *   "BanIds": [
+     *     "E0B5FF89542D413C",
+     *     "EF43FF89542G1546"
+     *   ]
+     * });
      */
     RevokeBans(request: RevokeBansRequest, extraHeaders?: Record<string, string>): Promise<RevokeBansResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Revokes access to an item in a user's inventory
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem Microsoft Documentation}
+     * @example
+     * await serverClient.RevokeInventoryItem({
+     *   "PlayFabId": "203945882",
+     *   "ItemInstanceId": "2048583045"
+     * });
      */
     RevokeInventoryItem(request: RevokeInventoryItemRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Revokes access for up to 25 items across multiple users and characters.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems Microsoft Documentation}
+     * @example
+     * await serverClient.RevokeInventoryItems({
+     *   "Items": [
+     *     {
+     *       "PlayFabId": "203945882",
+     *       "ItemInstanceId": "2048583045"
+     *     }
+     *   ]
+     * });
      */
     RevokeInventoryItems(request: RevokeInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
     /**
      * Saves push notification template for title
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate Microsoft Documentation}
+     * @example
+     * await serverClient.SavePushNotificationTemplate({
+     *   "Id": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4",
+     *   "Name": "F8763A987E",
+     *   "AndroidPayload": "{       notification:      {          body: \"Some Message\",          title: \"Subject\",          body_loc_key: \"someLocKey\"     } }",
+     *   "IOSPayload": "{       aps:      {          alert:          {          body: \"Some Message\",          title: \"Subject\",          \"loc-key\": \"someLocKey\"         }      } }",
+     *   "LocalizedPushNotificationTemplates": {
+     *     "en": {
+     *       "Subject": "Recent Attack",
+     *       "Message": "You have been attacked! Go defend your base!"
+     *     },
+     *     "fr": {
+     *       "Subject": "Attaque récente",
+     *       "Message": "Vous avez été attaqué! Va défendre ta base!"
+     *     }
+     *   }
+     * });
      */
     SavePushNotificationTemplate(request: SavePushNotificationTemplateRequest, extraHeaders?: Record<string, string>): Promise<SavePushNotificationTemplateResult>;
     /**
      * Forces an email to be sent to the registered contact email address for the user's account based on an account recovery
      * email template
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail Microsoft Documentation}
+     * @example
+     * await serverClient.SendCustomAccountRecoveryEmail({
+     *   "EmailTemplateId": "D53AB15D8F12E330",
+     *   "Email": "Me@here.com"
+     * });
      */
     SendCustomAccountRecoveryEmail(request: SendCustomAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendCustomAccountRecoveryEmailResult>;
     /**
      * Sends an email based on an email template to a player's contact email
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate Microsoft Documentation}
+     * @example
+     * await serverClient.SendEmailFromTemplate({
+     *   "EmailTemplateId": "B53CA15D92D2E331",
+     *   "PlayFabId": "A01DC15D8E12E230"
+     * });
      */
     SendEmailFromTemplate(request: SendEmailFromTemplateRequest, extraHeaders?: Record<string, string>): Promise<SendEmailFromTemplateResult>;
     /**
      * Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push
      * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification Microsoft Documentation}
+     * @example
+     * await serverClient.SendPushNotification({
+     *   "Recipient": "F8763A987E",
+     *   "Message": "You have been attacked! Go defend your base!"
+     * });
      */
     SendPushNotification(request: SendPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
     /**
      * Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push
      * Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate Microsoft Documentation}
+     * @example
+     * await serverClient.SendPushNotificationFromTemplate({
+     *   "Recipient": "F8763A987E",
+     *   "PushNotificationTemplateId": "6bc7dbf0-075a-46e9-8e84-35737a22c6a4"
+     * });
      */
     SendPushNotificationFromTemplate(request: SendPushNotificationFromTemplateRequest, extraHeaders?: Record<string, string>): Promise<SendPushNotificationResult>;
     /**
      * Updates the tag list for a specified user in the friend list of another user
-     * https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags Microsoft Documentation}
+     * @example
+     * await serverClient.SetFriendTags({
+     *   "PlayFabId": "ABCDEF123456",
+     *   "FriendPlayFabId": "298ABC37799",
+     *   "Tags": [
+     *     "sniper",
+     *     "melee"
+     *   ]
+     * });
      */
     SetFriendTags(request: SetFriendTagsRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Sets the custom data of the indicated Game Server Instance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancedata Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    SetGameServerInstanceData(request: SetGameServerInstanceDataRequest, extraHeaders?: Record<string, string>): Promise<SetGameServerInstanceDataResult>;
+    /**
+     * Set the state of the indicated Game Server Instance.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancestate Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    SetGameServerInstanceState(request: SetGameServerInstanceStateRequest, extraHeaders?: Record<string, string>): Promise<SetGameServerInstanceStateResult>;
+    /**
+     * Set custom tags for the specified Game Server Instance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/matchmaking/setgameserverinstancetags Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    SetGameServerInstanceTags(request: SetGameServerInstanceTagsRequest, extraHeaders?: Record<string, string>): Promise<SetGameServerInstanceTagsResult>;
     /**
      * 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/server/authentication/setplayersecret
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret Microsoft Documentation}
+     * @example
+     * await serverClient.SetPlayerSecret({
+     *   "PlayerSecret": "ExampleSecret",
+     *   "PlayFabId": "ABCD1234"
+     * });
      */
     SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
     /**
      * Updates the key-value store of custom publisher settings
-     * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata Microsoft Documentation}
+     * @example
+     * await serverClient.SetPublisherData({
+     *   "Key": "Running Speed",
+     *   "Value": "1.03"
+     * });
      */
     SetPublisherData(request: SetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
     /**
      * Updates the key-value store of custom title settings
-     * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata Microsoft Documentation}
+     * @example
+     * await serverClient.SetTitleData({
+     *   "Key": "Running Speed",
+     *   "Value": "1.03"
+     * });
      */
     SetTitleData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
     /**
      * Updates the key-value store of custom title settings
-     * https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.SetTitleInternalData({
+     *   "Key": "Running Speed",
+     *   "Value": "1.03"
+     * });
      */
     SetTitleInternalData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
     /**
      * _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 character'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/server/player-item-management/subtractcharactervirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency Microsoft Documentation}
+     * @example
+     * await serverClient.SubtractCharacterVirtualCurrency({
+     *   "PlayFabId": "20394883",
+     *   "CharacterId": "23424524523",
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     SubtractCharacterVirtualCurrency(request: SubtractCharacterVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyCharacterVirtualCurrencyResult>;
     /**
      * _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/server/player-item-management/subtractuservirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
+     * @example
+     * await serverClient.SubtractUserVirtualCurrency({
+     *   "PlayFabId": "20394883",
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
     /**
      * Unlinks the related Battle.net account from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkBattleNetAccount({
+     *   "PlayFabId": "1234FA342"
+     * });
      */
     UnlinkBattleNetAccount(request: UnlinkBattleNetAccountRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Unlinks the related Nintendo account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkNintendoServiceAccount({
+     *   "PlayFabId": "1234FA342"
+     * });
      */
     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/server/account-management/unlinknintendoswitchdeviceid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkNintendoSwitchDeviceId({
+     *   "PlayFabId": "1234FA342",
+     *   "NintendoSwitchDeviceId": "526f79204261747479"
+     * });
      */
     UnlinkNintendoSwitchDeviceId(request: UnlinkNintendoSwitchDeviceIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkNintendoSwitchDeviceIdResult>;
     /**
      * Unlinks the related PlayStation :tm: Network account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkPSNAccount({
+     *   "PlayFabId": "1234FA342"
+     * });
      */
     UnlinkPSNAccount(request: UnlinkPSNAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkPSNAccountResult>;
     /**
      * Unlinks the custom server identifier from the user's PlayFab account.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkServerCustomId({
+     *   "PlayFabId": "123412341234",
+     *   "ServerCustomId": "67AB-5397-CC54-EA31"
+     * });
      */
     UnlinkServerCustomId(request: UnlinkServerCustomIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkServerCustomIdResult>;
     /**
      * Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkSteamId({
+     *   "PlayFabId": "5a446c83645201"
+     * });
      */
     UnlinkSteamId(request: UnlinkSteamIdRequest, extraHeaders?: Record<string, string>): Promise<UnlinkSteamIdResult>;
     /**
      * Unlinks the related Xbox Live account from the user's PlayFab account
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount Microsoft Documentation}
+     * @example
+     * await serverClient.UnlinkXboxAccount({
+     *   "PlayFabId": "5a446c83645201"
+     * });
      */
     UnlinkXboxAccount(request: UnlinkXboxAccountRequest, extraHeaders?: Record<string, string>): Promise<UnlinkXboxAccountResult>;
     /**
@@ -3772,7 +5174,14 @@ declare class PlayFabServerApi extends PlayFabCommon {
      * version 2._ Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, 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/server/player-item-management/unlockcontainerinstance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance Microsoft Documentation}
+     * @example
+     * await serverClient.UnlockContainerInstance({
+     *   "PlayFabId": "20394883",
+     *   "ContainerItemInstanceId": "123456788",
+     *   "KeyItemInstanceId": "123456789"
+     * });
      */
     UnlockContainerInstance(request: UnlockContainerInstanceRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
     /**
@@ -3781,47 +5190,161 @@ declare class PlayFabServerApi extends PlayFabCommon {
      * unlocks it using any 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/server/player-item-management/unlockcontaineritem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem Microsoft Documentation}
+     * @example
+     * await serverClient.UnlockContainerItem({
+     *   "PlayFabId": "20394883",
+     *   "ContainerItemId": "crate block 1"
+     * });
      */
     UnlockContainerItem(request: UnlockContainerItemRequest, extraHeaders?: Record<string, string>): Promise<UnlockContainerItemResult>;
     /**
      * Update the avatar URL of the specified player
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateAvatarUrl({
+     *   "PlayFabId": "22ca65837b158fab",
+     *   "ImageUrl": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50"
+     * });
      */
     UpdateAvatarUrl(request: UpdateAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates information of a list of existing bans specified with Ban Ids.
-     * https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateBans({
+     *   "Bans": [
+     *     {
+     *       "BanId": "E0B5FF89542D413C",
+     *       "Permanent": true,
+     *       "Active": true
+     *     },
+     *     {
+     *       "BanId": "EF43FF89542G1546",
+     *       "Reason": "Royal pardon",
+     *       "Expires": "2016-07-04T00:00:00Z"
+     *     }
+     *   ]
+     * });
      */
     UpdateBans(request: UpdateBansRequest, extraHeaders?: Record<string, string>): Promise<UpdateBansResult>;
     /**
      * 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/server/character-data/updatecharacterdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateCharacterData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateCharacterData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
     /**
      * Updates the title-specific custom data for the user's character which cannot be accessed by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateCharacterInternalData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateCharacterInternalData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
     /**
      * Updates the title-specific custom data for the user's character which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateCharacterReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "CharacterId": "98342357",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateCharacterReadOnlyData(request: UpdateCharacterDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateCharacterDataResult>;
     /**
      * Updates the values of the specified title-specific statistics for the specific character
-     * https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateCharacterStatistics({
+     *   "PlayFabId": "10931252888739651331",
+     *   "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/server/player-data-management/updateplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties Microsoft Documentation}
+     * @example
+     * await serverClient.UpdatePlayerCustomProperties({
+     *   "PlayFabId": "2039475",
+     *   "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
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics Microsoft Documentation}
+     * @example
+     * await serverClient.UpdatePlayerStatistics({
+     *   "PlayFabId": "10931252888739651331",
+     *   "Statistics": [
+     *     {
+     *       "StatisticName": "Points",
+     *       "Version": 1,
+     *       "Value": 600
+     *     },
+     *     {
+     *       "StatisticName": "Wins",
+     *       "Version": 2,
+     *       "Value": 16
+     *     },
+     *     {
+     *       "StatisticName": "Stars",
+     *       "Value": 7
+     *     }
+     *   ]
+     * });
      */
     UpdatePlayerStatistics(request: UpdatePlayerStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticsResult>;
     /**
@@ -3830,58 +5353,197 @@ declare class PlayFabServerApi extends PlayFabCommon {
      * Regardless of the permission setting, only members of the group (and the server) 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/server/shared-group-data/updatesharedgroupdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateSharedGroupData({
+     *   "SharedGroupId": "Clan Data",
+     *   "Data": {
+     *     "ClanKills": "34",
+     *     "LastClanUpdate": "2014-10-03T09:21:14Z"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateSharedGroupData(request: UpdateSharedGroupDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateSharedGroupDataResult>;
     /**
      * Updates the title-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateUserData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * Updates the title-specific custom data for the user which cannot be accessed by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserInternalData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   }
+     * });
      */
     UpdateUserInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.
-     * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserInventoryItemCustomData({
+     *   "PlayFabId": "204883457",
+     *   "CharacterId": "9890723423",
+     *   "ItemInstanceId": "88331144",
+     *   "Data": {
+     *     "Equipped": "True",
+     *     "Slot": "Head"
+     *   }
+     * });
      */
     UpdateUserInventoryItemCustomData(request: UpdateUserInventoryItemDataRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates the publisher-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserPublisherData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateUserPublisherData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * Updates the publisher-specific custom data for the user which cannot be accessed by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserPublisherInternalData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   }
+     * });
      */
     UpdateUserPublisherInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * Updates the publisher-specific custom data for the user which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserPublisherReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateUserPublisherReadOnlyData(request: UpdateUserDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * Updates the title-specific custom data for the user which can only be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata Microsoft Documentation}
+     * @example
+     * await serverClient.UpdateUserReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   },
+     *   "Permission": "Public"
+     * });
      */
     UpdateUserReadOnlyData(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/server/player-data-management/updateuserstatistics Microsoft Documentation}
+     * @deprecated Please use UpdatePlayerStatistics instead.
+     */
+    UpdateUserStatistics(request: UpdateUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserStatisticsResult>;
     /**
      * Writes a character-based event into PlayStream.
-     * https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent Microsoft Documentation}
+     * @example
+     * await serverClient.WriteCharacterEvent({
+     *   "PlayFabId": "3947655299CB786",
+     *   "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: WriteServerCharacterEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
     /**
      * Writes a player-based event into PlayStream.
-     * https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent Microsoft Documentation}
+     * @example
+     * await serverClient.WritePlayerEvent({
+     *   "PlayFabId": "3947655299CB786",
+     *   "EventName": "player_defeated_enemy",
+     *   "Timestamp": "2016-03-07T00:00:00Z",
+     *   "Body": {
+     *     "Enemy": "guardian",
+     *     "Damage": 5,
+     *     "Coordinates": {
+     *       "X": 123.4,
+     *       "Y": 543.2
+     *     }
+     *   }
+     * });
      */
     WritePlayerEvent(request: WriteServerPlayerEventRequest, extraHeaders?: Record<string, string>): Promise<WriteEventResponse>;
     /**
      * Writes a title-based event into PlayStream.
-     * https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent Microsoft Documentation}
+     * @example
+     * await serverClient.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>;
 }