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

package/dist/Admin.d.ts

@@ -150,6 +150,69 @@ interface AddPlayerTagRequest extends IPlayFabRequestCommon {
 }
 interface AddPlayerTagResult extends IPlayFabResultCommon {
 }
+/** @deprecated Do not use */
+interface AddServerBuildRequest extends IPlayFabRequestCommon {
+    /** server host regions in which this build should be running and available */
+    ActiveRegions?: string[];
+    /** unique identifier for the build executable */
+    BuildId: string;
+    /**
+     * appended to the end of the command line when starting game servers
+     * @deprecated Do not use
+     */
+    CommandLineTemplate?: string;
+    /** developer comment(s) for this build */
+    Comment?: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * path to the game server executable. Defaults to gameserver.exe
+     * @deprecated Do not use
+     */
+    ExecutablePath?: string;
+    /** maximum number of game server instances that can run on a single host machine */
+    MaxGamesPerHost: number;
+    /**
+     * minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
+     * machines (given the number of current running host machines and game server instances)
+     */
+    MinFreeGameSlots: number;
+}
+/** @deprecated Do not use */
+interface AddServerBuildResult extends IPlayFabResultCommon {
+    /** array of regions where this build can used, when it is active */
+    ActiveRegions?: string[];
+    /** unique identifier for this build executable */
+    BuildId?: string;
+    /**
+     * appended to the end of the command line when starting game servers
+     * @deprecated Do not use
+     */
+    CommandLineTemplate?: string;
+    /** developer comment(s) for this build */
+    Comment?: string;
+    /**
+     * path to the game server executable. Defaults to gameserver.exe
+     * @deprecated Do not use
+     */
+    ExecutablePath?: string;
+    /** maximum number of game server instances that can run on a single host machine */
+    MaxGamesPerHost: number;
+    /**
+     * minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
+     * machines (given the number of current running host machines and game server instances)
+     */
+    MinFreeGameSlots: number;
+    /** the current status of the build validation and processing steps */
+    Status?: string;
+    /** time this build was last modified (or uploaded, if this build has never been modified) */
+    Timestamp: string;
+    /**
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
+     * title has been selected.
+     */
+    TitleId?: string;
+}
 interface AddUserVirtualCurrencyRequest extends IPlayFabRequestCommon {
     /**
      * Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647).
@@ -185,8 +248,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. */
@@ -209,8 +284,19 @@ interface BanPlayerSegmentAction {
 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. */
@@ -283,7 +369,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 {
@@ -303,7 +389,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;
     /**
@@ -344,6 +430,34 @@ interface ChurnPredictionSegmentFilter {
     /** RiskLevel */
     RiskLevel?: string;
 }
+interface CloudScriptAzureFunctionsTaskParameter {
+    /** Argument to pass to the CloudScript function. */
+    Argument?: any;
+    /** Name of the CloudScript function to execute. */
+    FunctionName?: string;
+}
+interface CloudScriptAzureFunctionsTaskSummary {
+    /** UTC timestamp when the task completed. */
+    CompletedAt?: string;
+    /** Error indicating failure to execute the CloudScript Azure Function */
+    Error?: string;
+    /** Estimated time remaining in seconds. */
+    EstimatedSecondsRemaining?: number;
+    /** Progress represented as percentage. */
+    PercentComplete?: number;
+    /** Result of CloudScript Azure Function execution */
+    Result?: ExecuteFunctionResult;
+    /** If manually scheduled, ID of user who scheduled the task. */
+    ScheduledByUserId?: string;
+    /** UTC timestamp when the task started. */
+    StartedAt: string;
+    /** Current status of the task instance. */
+    Status?: string;
+    /** Identifier of the task this instance belongs to. */
+    TaskIdentifier?: NameIdentifier;
+    /** ID of the task instance. */
+    TaskInstanceId?: string;
+}
 interface CloudScriptFile {
     /** Contents of the Cloud Script javascript. Must be string-escaped javascript. */
     FileContents: string;
@@ -425,6 +539,20 @@ interface CreateActionsOnPlayerSegmentTaskRequest extends IPlayFabRequestCommon
     /** Cron expression for the run schedule of the task. The expression should be in UTC. */
     Schedule?: string;
 }
+interface CreateCloudScriptAzureFunctionsTaskRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Description the task */
+    Description?: string;
+    /** Whether the schedule is active. Inactive schedule will not trigger task execution. */
+    IsActive: boolean;
+    /** Name of the task. This is a unique identifier for tasks in the title. */
+    Name: string;
+    /** Task details related to CloudScript */
+    Parameter: CloudScriptAzureFunctionsTaskParameter;
+    /** Cron expression for the run schedule of the task. The expression should be in UTC. */
+    Schedule?: string;
+}
 interface CreateCloudScriptTaskRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -460,12 +588,12 @@ interface CreateOpenIdConnectionRequest extends IPlayFabRequestCommon {
     ClientSecret: string;
     /** A name for the connection that identifies it within the title. */
     ConnectionId: string;
-    /** Ignore 'nonce' claim in identity tokens. */
+    /** Ignore &#39;nonce&#39; claim in identity tokens. */
     IgnoreNonce?: boolean;
     /**
      * The discovery document URL to read issuer information from. This must be the absolute URL to the JSON OpenId
-     * Configuration document and must be accessible from the internet. If you don't know it, try your issuer URL followed by
-     * "/.well-known/openid-configuration". For example, if the issuer is https://example.com, try
+     * Configuration document and must be accessible from the internet. If you don&#39;t know it, try your issuer URL followed by
+     * &quot;/.well-known/openid-configuration&quot;. For example, if the issuer is https://example.com, try
      * https://example.com/.well-known/openid-configuration
      */
     IssuerDiscoveryUrl?: string;
@@ -527,9 +655,9 @@ interface CustomPropertyDateTimeSegmentFilter {
     PropertyValue: 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 CustomPropertyNumericSegmentFilter {
@@ -558,6 +686,12 @@ interface DeletedPropertyDetails {
     /** Indicates whether or not the property was deleted. If false, no property with that name existed. */
     WasDeleted: boolean;
 }
+interface DeleteEventSinkRequest extends IPlayFabRequestCommon {
+    /** The sink name to be deleted. */
+    Name: string;
+}
+interface DeleteEventSinkResult extends IPlayFabResultCommon {
+}
 interface DeleteInventoryItemsV2SegmentAction {
     /** The collection id for where the item will be removed from the player inventory */
     CollectionId?: string;
@@ -586,7 +720,7 @@ interface DeleteMasterPlayerAccountResult extends IPlayFabResultCommon {
      * complete.
      */
     JobReceiptId?: string;
-    /** List of titles from which the player's data will be deleted. */
+    /** List of titles from which the player&#39;s data will be deleted. */
     TitleIds?: string[];
 }
 interface DeleteMasterPlayerEventDataRequest extends IPlayFabRequestCommon {
@@ -618,7 +752,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. */
@@ -632,7 +766,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;
@@ -687,6 +821,16 @@ interface DeleteTitleRequest extends IPlayFabRequestCommon {
 }
 interface DeleteTitleResult extends IPlayFabResultCommon {
 }
+/** @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 {
+}
 interface EmailNotificationSegmentAction {
     /** Email template id. */
     EmailTemplateId?: string;
@@ -698,6 +842,29 @@ 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 ErrorDetails {
+    /** The error code of the user configuration error if this data connection is in an error state. */
+    Code?: string;
+    /** Date (in UTC) when the data connection most recently entered an error state. */
+    StartTime: string;
+}
+interface EventSink {
+    /** The type of event sink. Currently only supports AzureBlobStorage. */
+    DestinationType: string;
+    /** Error status for the sink. */
+    Error?: ErrorDetails;
+    /** The usage status of the sink. */
+    IsEnabled: boolean;
+    /** Friendly name for the event sink. */
+    Name: string;
+    /** Settings for the sink. */
+    SinkSettings: any;
 }
 interface ExecuteAzureFunctionSegmentAction {
     /** Azure function. */
@@ -769,6 +936,18 @@ interface ExecuteFunctionContent {
     /** Publish results from executing the azure function as playstream event */
     PublishResultsToPlayStream: boolean;
 }
+interface ExecuteFunctionResult {
+    /** Error from the CloudScript Azure Function. */
+    Error?: FunctionExecutionError;
+    /** The amount of time the function took to execute */
+    ExecutionTimeMilliseconds: number;
+    /** The name of the function that executed */
+    FunctionName?: string;
+    /** The object returned from the function, if any */
+    FunctionResult?: any;
+    /** Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. */
+    FunctionResultTooLarge?: boolean;
+}
 interface ExportMasterPlayerDataRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
@@ -802,12 +981,49 @@ interface FirstLoginTimespanSegmentFilter {
     /** First player login duration. */
     DurationInMinutes: number;
 }
+interface FunctionExecutionError {
+    /**
+     * Error code, such as CloudScriptAzureFunctionsExecutionTimeLimitExceeded, CloudScriptAzureFunctionsArgumentSizeExceeded,
+     * CloudScriptAzureFunctionsReturnSizeExceeded or CloudScriptAzureFunctionsHTTPRequestError
+     */
+    Error?: string;
+    /** Details about the error */
+    Message?: string;
+    /** Point during the execution of the function at which the error occurred, if any */
+    StackTrace?: string;
+}
+/** @deprecated Do not use */
+interface GameModeInfo {
+    /** specific game mode type */
+    Gamemode: string;
+    /** maximum user count a specific Game Server Instance can support */
+    MaxPlayerCount: number;
+    /** minimum user count required for this Game Server Instance to continue (usually 1) */
+    MinPlayerCount: number;
+    /** whether to start as an open session, meaning that players can matchmake into it (defaults to true) */
+    StartOpen?: boolean;
+}
+/** @deprecated Do not use */
+interface GetActionGroupResult {
+    /** Action Group ID */
+    Id?: string;
+    /** Action Group name */
+    Name: string;
+}
 interface GetActionsOnPlayersInSegmentTaskInstanceResult extends IPlayFabResultCommon {
     /** Parameter of this task instance */
     Parameter?: ActionsOnPlayersInSegmentTaskParameter;
     /** Status summary of the actions-on-players-in-segment task instance */
     Summary?: ActionsOnPlayersInSegmentTaskSummary;
 }
+/** @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 {
@@ -822,6 +1038,12 @@ interface GetCatalogItemsResult extends IPlayFabResultCommon {
     /** Array of items which can be purchased. */
     Catalog?: CatalogItem[];
 }
+interface GetCloudScriptAzureFunctionsTaskInstanceResult extends IPlayFabResultCommon {
+    /** Parameter of this task instance */
+    Parameter?: CloudScriptAzureFunctionsTaskParameter;
+    /** Status summary of the CloudScript Azure Functions task instance */
+    Summary?: CloudScriptAzureFunctionsTaskSummary;
+}
 interface GetCloudScriptRevisionRequest extends IPlayFabRequestCommon {
     /** Revision number. If left null, defaults to the latest revision */
     Revision?: number;
@@ -870,7 +1092,7 @@ interface GetContentListResult extends IPlayFabResultCommon {
 interface GetContentUploadUrlRequest extends IPlayFabRequestCommon {
     /**
      * A standard MIME type describing the format of the contents. The same MIME type has to be set in the header when
-     * uploading the content. If not specified, the MIME type is 'binary/octet-stream' by default.
+     * uploading the content. If not specified, the MIME type is &#39;binary/octet-stream&#39; by default.
      */
     ContentType?: string;
     /** Key of the content item to upload, usually formatted as a path, e.g. images/a.png */
@@ -878,8 +1100,8 @@ interface GetContentUploadUrlRequest extends IPlayFabRequestCommon {
 }
 interface GetContentUploadUrlResult extends IPlayFabResultCommon {
     /**
-     * URL for uploading content via HTTP PUT method. The URL requires the 'x-ms-blob-type' header to have the value
-     * 'BlockBlob'. The URL will expire in approximately one hour.
+     * URL for uploading content via HTTP PUT method. The URL requires the &#39;x-ms-blob-type&#39; header to have the value
+     * &#39;BlockBlob&#39;. The URL will expire in approximately one hour.
      */
     URL?: string;
 }
@@ -900,6 +1122,59 @@ interface GetDataReportResult extends IPlayFabResultCommon {
      */
     DownloadUrl?: string;
 }
+interface GetEventSinksRequest extends IPlayFabRequestCommon {
+}
+interface GetEventSinksResult extends IPlayFabResultCommon {
+    /** The set of sinks to which to route PlayStream and Telemetry event data. */
+    Sinks: EventSink[];
+}
+/** @deprecated Do not use */
+interface GetMatchmakerGameInfoRequest extends IPlayFabRequestCommon {
+    /** unique identifier of the lobby for which info is being requested */
+    LobbyId: string;
+}
+/** @deprecated Do not use */
+interface GetMatchmakerGameInfoResult extends IPlayFabResultCommon {
+    /** version identifier of the game server executable binary being run */
+    BuildVersion?: string;
+    /** time when Game Server Instance is currently scheduled to end */
+    EndTime?: string;
+    /** unique identifier of the lobby */
+    LobbyId?: string;
+    /** game mode for this Game Server Instance */
+    Mode?: string;
+    /** array of unique PlayFab identifiers for users currently connected to this Game Server Instance */
+    Players?: string[];
+    /** region in which the Game Server Instance is running */
+    Region?: string;
+    /**
+     * IPV4 address of the game server instance
+     * @deprecated Please use ServerIPV4Address instead.
+     */
+    ServerAddress?: string;
+    /** IPV4 address of the server */
+    ServerIPV4Address?: string;
+    /** IPV6 address of the server */
+    ServerIPV6Address?: string;
+    /** communication port for this Game Server Instance */
+    ServerPort: number;
+    /** Public DNS name (if any) of the server */
+    ServerPublicDNSName?: string;
+    /** time when the Game Server Instance was created */
+    StartTime: string;
+    /** unique identifier of the Game Server Instance for this lobby */
+    TitleId?: string;
+}
+/** @deprecated Do not use */
+interface GetMatchmakerGameModesRequest extends IPlayFabRequestCommon {
+    /** previously uploaded build version for which game modes are being requested */
+    BuildVersion: string;
+}
+/** @deprecated Do not use */
+interface GetMatchmakerGameModesResult extends IPlayFabResultCommon {
+    /** array of game modes available for the specified build */
+    GameModes?: GameModeInfo[];
+}
 interface GetPlayedTitleListRequest extends IPlayFabRequestCommon {
     /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */
     PlayFabId: string;
@@ -911,14 +1186,14 @@ interface GetPlayedTitleListResult extends IPlayFabResultCommon {
 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;
@@ -943,7 +1218,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;
 }
@@ -1039,11 +1314,11 @@ 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 GetPolicyRequest extends IPlayFabRequestCommon {
-    /** The name of the policy to read. Only supported name is 'ApiPolicy'. */
+    /** The name of the policy to read. Only supported name is &#39;ApiPolicy&#39;. */
     PolicyName?: string;
 }
 interface GetPolicyResponse extends IPlayFabResultCommon {
@@ -1088,6 +1363,38 @@ interface GetSegmentsResponse extends IPlayFabResultCommon {
     /** List of title segments. */
     Segments?: SegmentModel[];
 }
+/** @deprecated Do not use */
+interface GetServerBuildInfoRequest extends IPlayFabRequestCommon {
+    /** unique identifier of the previously uploaded build executable for which information is being requested */
+    BuildId: string;
+}
+/** @deprecated Do not use */
+interface GetServerBuildInfoResult extends IPlayFabResultCommon {
+    /** array of regions where this build can used, when it is active */
+    ActiveRegions?: string[];
+    /** unique identifier for this build executable */
+    BuildId?: string;
+    /** developer comment(s) for this build */
+    Comment?: string;
+    /** error message, if any, about this build */
+    ErrorMessage?: string;
+    /** maximum number of game server instances that can run on a single host machine */
+    MaxGamesPerHost: number;
+    /**
+     * minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
+     * machines (given the number of current running host machines and game server instances)
+     */
+    MinFreeGameSlots: number;
+    /** the current status of the build validation and processing steps */
+    Status?: string;
+    /** time this build was last modified (or uploaded, if this build has never been modified) */
+    Timestamp: string;
+    /**
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
+     * title has been selected.
+     */
+    TitleId?: string;
+}
 interface GetStoreItemsRequest extends IPlayFabRequestCommon {
     /** Catalog version to store items from. Use default catalog version if null */
     CatalogVersion?: string;
@@ -1111,9 +1418,9 @@ interface GetTaskInstanceRequest extends IPlayFabRequestCommon {
     TaskInstanceId: string;
 }
 interface GetTaskInstancesRequest extends IPlayFabRequestCommon {
-    /** Optional range-from filter for task instances' StartedAt timestamp. */
+    /** Optional range-from filter for task instances&#39; StartedAt timestamp. */
     StartedAtRangeFrom?: string;
-    /** Optional range-to filter for task instances' StartedAt timestamp. */
+    /** Optional range-to filter for task instances&#39; StartedAt timestamp. */
     StartedAtRangeTo?: string;
     /** Optional filter for task instances that are of a specific status. */
     StatusFilter?: string;
@@ -1214,7 +1521,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. */
@@ -1327,7 +1634,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. */
@@ -1354,7 +1661,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. */
@@ -1410,6 +1717,14 @@ interface LinkedUserAccountSegmentFilter {
     /** Login provider. */
     LoginProvider?: string;
 }
+/** @deprecated Do not use */
+interface ListBuildsRequest extends IPlayFabRequestCommon {
+}
+/** @deprecated Do not use */
+interface ListBuildsResult extends IPlayFabResultCommon {
+    /** array of uploaded game server builds */
+    Builds?: GetServerBuildInfoResult[];
+}
 interface ListOpenIdConnectionRequest extends IPlayFabRequestCommon {
 }
 interface ListOpenIdConnectionResponse extends IPlayFabResultCommon {
@@ -1426,7 +1741,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;
@@ -1456,7 +1771,7 @@ interface LocationSegmentFilter {
 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;
 }
@@ -1486,14 +1801,79 @@ 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[];
 }
+/** @deprecated Do not use */
+interface ModifyMatchmakerGameModesRequest extends IPlayFabRequestCommon {
+    /** previously uploaded build version for which game modes are being specified */
+    BuildVersion: string;
+    /** array of game modes (Note: this will replace all game modes for the indicated build version) */
+    GameModes: GameModeInfo[];
+}
+/** @deprecated Do not use */
+interface ModifyMatchmakerGameModesResult extends IPlayFabResultCommon {
+}
+/** @deprecated Do not use */
+interface ModifyServerBuildRequest extends IPlayFabRequestCommon {
+    /** array of regions where this build can used, when it is active */
+    ActiveRegions?: string[];
+    /** unique identifier of the previously uploaded build executable to be updated */
+    BuildId: string;
+    /** appended to the end of the command line when starting game servers */
+    CommandLineTemplate?: string;
+    /** developer comment(s) for this build */
+    Comment?: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** path to the game server executable. Defaults to gameserver.exe */
+    ExecutablePath?: string;
+    /** maximum number of game server instances that can run on a single host machine */
+    MaxGamesPerHost: number;
+    /**
+     * minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
+     * machines (given the number of current running host machines and game server instances)
+     */
+    MinFreeGameSlots: number;
+    /** new timestamp */
+    Timestamp?: string;
+}
+/** @deprecated Do not use */
+interface ModifyServerBuildResult extends IPlayFabResultCommon {
+    /** array of regions where this build can used, when it is active */
+    ActiveRegions?: string[];
+    /** unique identifier for this build executable */
+    BuildId?: string;
+    /** appended to the end of the command line when starting game servers */
+    CommandLineTemplate?: string;
+    /** developer comment(s) for this build */
+    Comment?: string;
+    /** path to the game server executable. Defaults to gameserver.exe */
+    ExecutablePath?: string;
+    /** maximum number of game server instances that can run on a single host machine */
+    MaxGamesPerHost: number;
+    /**
+     * minimum capacity of additional game server instances that can be started before the autoscaling service starts new host
+     * machines (given the number of current running host machines and game server instances)
+     */
+    MinFreeGameSlots: number;
+    /** the current status of the build validation and processing steps */
+    Status?: string;
+    /** time this build was last modified (or uploaded, if this build has never been modified) */
+    Timestamp: string;
+    /**
+     * Unique identifier for the title, found in the Settings &gt; Game Properties section of the PlayFab developer site when a
+     * title has been selected.
+     */
+    TitleId?: string;
+}
 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;
@@ -1515,9 +1895,9 @@ interface OpenIdConnection {
     ClientSecret?: string;
     /** A name for the connection to identify it within the title. */
     ConnectionId?: string;
-    /** Shows if data about the connection will be loaded from the issuer's discovery document */
+    /** Shows if data about the connection will be loaded from the issuer&#39;s discovery document */
     DiscoverConfiguration: boolean;
-    /** Ignore 'nonce' claim in identity tokens. */
+    /** Ignore &#39;nonce&#39; claim in identity tokens. */
     IgnoreNonce?: boolean;
     /** Information for an OpenID Connect provider. */
     IssuerInformation?: OpenIdIssuerInformation;
@@ -1535,7 +1915,7 @@ interface OpenIdIssuerInformation {
     TokenUrl: string;
 }
 interface PermissionStatement {
-    /** The action this statement effects. The only supported action is 'Execute'. */
+    /** The action this statement effects. The only supported action is &#39;Execute&#39;. */
     Action: string;
     /** Additional conditions to be applied for API Resources. */
     ApiConditions?: ApiCondition;
@@ -1543,11 +1923,11 @@ interface PermissionStatement {
     Comment?: string;
     /** The effect this statement will have. It could be either Allow or Deny */
     Effect: string;
-    /** The principal this statement will effect. The only supported principal is '*'. */
+    /** The principal this statement will effect. The only supported principal is &#39;*&#39;. */
     Principal: string;
     /**
-     * The resource this statements effects. The only supported resources look like 'pfrn:api--*' for all apis, or
-     * 'pfrn:api--/Client/ConfirmPurchase' for specific apis.
+     * The resource this statements effects. The only supported resources look like &#39;pfrn:api--*&#39; for all apis, or
+     * &#39;pfrn:api--/Client/ConfirmPurchase&#39; for specific apis.
      */
     Resource: string;
 }
@@ -1570,31 +1950,31 @@ interface PlayerChurnPreviousPredictionSegmentFilter {
     RiskLevel?: string;
 }
 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;
@@ -1604,7 +1984,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;
@@ -1612,7 +1992,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;
@@ -1626,23 +2006,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;
@@ -1676,20 +2056,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;
@@ -1701,15 +2081,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;
@@ -1747,6 +2127,11 @@ interface PlayerStatisticDefinition {
 interface PlayerStatisticVersion {
     /** time when the statistic version became active */
     ActivationTime: string;
+    /**
+     * status of the process of saving player statistic values of the previous version to a downloadable archive
+     * @deprecated Please use Status instead.
+     */
+    ArchivalStatus?: string;
     /** URL for the downloadable archive of player statistic values, if available */
     ArchiveDownloadUrl?: string;
     /** time when the statistic version became inactive due to statistic version incrementing */
@@ -1817,7 +2202,7 @@ interface RefundPurchaseRequest extends IPlayFabRequestCommon {
     Reason?: string;
 }
 interface RefundPurchaseResponse extends IPlayFabResultCommon {
-    /** The order's updated purchase status. */
+    /** The order&#39;s updated purchase status. */
     PurchaseStatus?: string;
 }
 interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
@@ -1830,6 +2215,14 @@ interface RemovePlayerTagRequest extends IPlayFabRequestCommon {
 }
 interface RemovePlayerTagResult extends IPlayFabResultCommon {
 }
+/** @deprecated Do not use */
+interface RemoveServerBuildRequest extends IPlayFabRequestCommon {
+    /** unique identifier of the previously uploaded build executable to be removed */
+    BuildId: string;
+}
+/** @deprecated Do not use */
+interface RemoveServerBuildResult extends IPlayFabResultCommon {
+}
 interface RemoveVirtualCurrencyTypesRequest extends IPlayFabRequestCommon {
     /** List of virtual currencies to delete */
     VirtualCurrencies: VirtualCurrencyData[];
@@ -1854,6 +2247,13 @@ interface ResetPasswordRequest extends IPlayFabRequestCommon {
 }
 interface ResetPasswordResult extends IPlayFabResultCommon {
 }
+/** @deprecated Do not use */
+interface ResetUsersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Array of users to reset */
+    Users: UserCredentials[];
+}
 interface ResetUserStatisticsRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -1880,7 +2280,7 @@ interface ResolvePurchaseDisputeRequest extends IPlayFabRequestCommon {
     Reason?: string;
 }
 interface ResolvePurchaseDisputeResponse extends IPlayFabResultCommon {
-    /** The order's updated purchase status. */
+    /** The order&#39;s updated purchase status. */
     PurchaseStatus?: string;
 }
 interface ResultTableNode {
@@ -1964,7 +2364,7 @@ interface ScheduledTask {
     /** UTC time of next run */
     NextRunTime?: string;
     /**
-     * Task parameter. Different types of task have different parameter structure. See each task type's create API
+     * Task parameter. Different types of task have different parameter structure. See each task type&#39;s create API
      * documentation for the details.
      */
     Parameter?: any;
@@ -2098,6 +2498,12 @@ interface SendEmailContent {
     /** The email template id of the email template to send. */
     EmailTemplateId: string;
 }
+interface SetEventSinkRequest extends IPlayFabRequestCommon {
+    /** The sink to which to route PlayStream and Telemetry event data. */
+    Sink: EventSink;
+}
+interface SetEventSinkResult extends IPlayFabResultCommon {
+}
 interface SetMembershipOverrideRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -2130,8 +2536,8 @@ interface SetPublishedRevisionResult 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 */
@@ -2152,8 +2558,8 @@ interface SetTitleDataAndOverridesResult 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 */
@@ -2223,7 +2629,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 {
@@ -2239,7 +2645,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;
@@ -2318,8 +2724,8 @@ interface TaskInstanceBasicSummary {
 }
 interface TitleDataKeyValue {
     /**
-     * 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 */
@@ -2338,8 +2744,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. */
@@ -2382,6 +2799,11 @@ interface UpdateCloudScriptRequest extends IPlayFabRequestCommon {
     Files: CloudScriptFile[];
     /** Immediately publish the new revision */
     Publish: boolean;
+    /**
+     * Deprecated - Do not use
+     * @deprecated Do not use
+     */
+    Version?: number;
 }
 interface UpdateCloudScriptResult extends IPlayFabResultCommon {
     /** New revision number created */
@@ -2396,7 +2818,7 @@ interface UpdateOpenIdConnectionRequest extends IPlayFabRequestCommon {
     ClientSecret?: string;
     /** A name for the connection that identifies it within the title. */
     ConnectionId: string;
-    /** Ignore 'nonce' claim in identity tokens. */
+    /** Ignore &#39;nonce&#39; claim in identity tokens. */
     IgnoreNonce?: boolean;
     /** The issuer URL or discovery document URL to read issuer information from */
     IssuerDiscoveryUrl?: string;
@@ -2410,7 +2832,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. */
@@ -2422,7 +2844,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;
@@ -2455,7 +2877,7 @@ interface UpdatePlayerStatisticDefinitionResult extends IPlayFabResultCommon {
 interface UpdatePolicyRequest extends IPlayFabRequestCommon {
     /** Whether to overwrite or append to the existing policy. */
     OverwritePolicy: boolean;
-    /** The name of the policy being updated. Only supported name is 'ApiPolicy' */
+    /** The name of the policy being updated. Only supported name is &#39;ApiPolicy&#39; */
     PolicyName: string;
     /** Version of the policy to update. Must be the latest (as returned by GetPolicy). */
     PolicyVersion: number;
@@ -2522,7 +2944,7 @@ interface UpdateTaskRequest extends IPlayFabRequestCommon {
     IsActive: boolean;
     /** Name of the task. This is a unique identifier for tasks in the title. */
     Name: string;
-    /** Parameter object specific to the task type. See each task type's create API documentation for details. */
+    /** Parameter object specific to the task type. See each task type&#39;s create API documentation for details. */
     Parameter?: any;
     /** Cron expression for the run schedule of the task. The expression should be in UTC. */
     Schedule?: string;
@@ -2534,7 +2956,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>;
     /**
@@ -2542,7 +2964,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;
@@ -2559,7 +2981,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>;
     /**
@@ -2646,6 +3068,16 @@ interface UserBattleNetInfo {
     /** Battle.net display name */
     BattleNetBattleTag?: string;
 }
+/** @deprecated Do not use */
+interface UserCredentials {
+    /**
+     * Password for the PlayFab account
+     * @deprecated Do not use
+     */
+    Password?: string;
+    /** Username of user to reset */
+    Username: string;
+}
 interface UserCustomIdInfo {
     /** Custom ID */
     CustomId?: string;
@@ -2752,7 +3184,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
@@ -2792,12 +3224,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;
 }
@@ -2818,7 +3250,7 @@ interface VirtualCurrencyBalanceSegmentFilter {
     CurrencyCode?: string;
 }
 interface VirtualCurrencyData {
-    /** unique two-character identifier for this currency type (e.g.: "CC") */
+    /** unique two-character identifier for this currency type (e.g.: &quot;CC&quot;) */
     CurrencyCode: string;
     /** friendly name to show in the developer portal, reports, etc. */
     DisplayName?: string;
@@ -2845,243 +3277,666 @@ interface VirtualCurrencyRechargeTime {
 declare class PlayFabAdminApi extends PlayFabCommon {
     /**
      * Abort an ongoing task instance.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance Microsoft Documentation}
+     * @example
+     * await adminClient.AbortTaskInstance({
+     *   "TaskInstanceId": "E52531B47B1761C7-4"
+     * });
      */
     AbortTaskInstance(request: AbortTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Update news item to include localized version
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews Microsoft Documentation}
+     * @example
+     * await adminClient.AddLocalizedNews({
+     *   "NewsId": "74623b12-6c80-ee4b-7c3b-58e638aa62bd",
+     *   "Language": "en",
+     *   "Title": "News of the Day",
+     *   "Body": "<b>We have a new object to buy!</b>"
+     * });
      */
     AddLocalizedNews(request: AddLocalizedNewsRequest, extraHeaders?: Record<string, string>): Promise<AddLocalizedNewsResult>;
     /**
      * Adds a new news item to the title's news feed
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews Microsoft Documentation}
+     * @example
+     * await adminClient.AddNews({
+     *   "Timestamp": "2014-04-06T00:00:00Z",
+     *   "Title": "News of the Day",
+     *   "Body": "<b>We have a new object to buy!</b>"
+     * });
      */
     AddNews(request: AddNewsRequest, extraHeaders?: Record<string, string>): Promise<AddNewsResult>;
     /**
      * 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/admin/playstream/addplayertag
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/addplayertag Microsoft Documentation}
+     * @example
+     * await adminClient.AddPlayerTag({
+     *   "PlayFabId": "10931252888739651331",
+     *   "TagName": "MostKilled"
+     * });
      */
     AddPlayerTag(request: AddPlayerTagRequest, extraHeaders?: Record<string, string>): Promise<AddPlayerTagResult>;
+    /**
+     * Adds the game server executable specified (previously uploaded - see GetServerBuildUploadUrl) to the set of those a
+     * client is permitted to request in a call to StartGame
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/addserverbuild Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    AddServerBuild(request: AddServerBuildRequest, extraHeaders?: Record<string, string>): Promise<AddServerBuildResult>;
     /**
      * _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 specified virtual currency by the stated amount
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency Microsoft Documentation}
+     * @example
+     * await adminClient.AddUserVirtualCurrency({
+     *   "PlayFabId": "20394883",
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     AddUserVirtualCurrency(request: AddUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
     /**
      * _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 one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum
      * value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes Microsoft Documentation}
+     * @example
+     * await adminClient.AddVirtualCurrencyTypes({
+     *   "VirtualCurrencies": [
+     *     {
+     *       "CurrencyCode": "CC",
+     *       "DisplayName": "Chump Coins",
+     *       "InitialDeposit": 100,
+     *       "RechargeRate": 1000,
+     *       "RechargeMax": 1000
+     *     },
+     *     {
+     *       "CurrencyCode": "GC"
+     *     }
+     *   ]
+     * });
      */
     AddVirtualCurrencyTypes(request: AddVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
     /**
      * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers Microsoft Documentation}
+     * @example
+     * await adminClient.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._ Checks the global count for the limited edition item.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability Microsoft Documentation}
+     * @example
+     * await adminClient.CheckLimitedEditionItemAvailability({
+     *   "CatalogVersion": "Rares",
+     *   "ItemId": "FreeHoodie"
+     * });
      */
     CheckLimitedEditionItemAvailability(request: CheckLimitedEditionItemAvailabilityRequest, extraHeaders?: Record<string, string>): Promise<CheckLimitedEditionItemAvailabilityResult>;
     /**
      * Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask Microsoft Documentation}
+     * @example
+     * await adminClient.CreateActionsOnPlayersInSegmentTask({
+     *   "Name": "PushNotificationVIP_Halloween",
+     *   "Description": "Send push notification to VIP players about Halloween event",
+     *   "IsActive": false,
+     *   "Parameter": {
+     *     "SegmentId": "274828AF93F13472",
+     *     "Actions": [
+     *       {
+     *         "GrantItemContent": {
+     *           "CatalogVersion": "foo",
+     *           "ItemId": "bar",
+     *           "ItemQuantity": 1
+     *         }
+     *       }
+     *     ]
+     *   }
+     * });
      */
     CreateActionsOnPlayersInSegmentTask(request: CreateActionsOnPlayerSegmentTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
     /**
      * Create a CloudScript task, which can run a CloudScript on a schedule.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscriptazurefunctionstask Microsoft Documentation}
+     * @example
+     * await adminClient.CreateCloudScriptAzureFunctionsTask({
+     *   "Name": "EnableWeekdayHappyHour",
+     *   "Description": "Turn on special pricing for weekday happy hour.",
+     *   "Schedule": "0 17 * * 1-5",
+     *   "IsActive": false,
+     *   "Parameter": {
+     *     "FunctionName": "applyStorePreset",
+     *     "Argument": {
+     *       "preset": "WeekdayHappyHour"
+     *     }
+     *   }
+     * });
+     */
+    CreateCloudScriptAzureFunctionsTask(request: CreateCloudScriptAzureFunctionsTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
+    /**
+     * Create a CloudScript task, which can run a CloudScript on a schedule.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask Microsoft Documentation}
+     * @example
+     * await adminClient.CreateCloudScriptTask({
+     *   "Name": "EnableWeekdayHappyHour",
+     *   "Description": "Turn on special pricing for weekday happy hour.",
+     *   "Schedule": "0 17 * * 1-5",
+     *   "IsActive": false,
+     *   "Parameter": {
+     *     "FunctionName": "applyStorePreset",
+     *     "Argument": {
+     *       "preset": "WeekdayHappyHour"
+     *     }
+     *   }
+     * });
      */
     CreateCloudScriptTask(request: CreateCloudScriptTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
     /**
      * Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask Microsoft Documentation}
+     * @example
+     * await adminClient.CreateInsightsScheduledScalingTask({
+     *   "Name": "EnableWeekdayPerformance",
+     *   "Description": "Scale up Insights Performance Units during weekdays.",
+     *   "Schedule": "0 0 * * 1-5",
+     *   "IsActive": false,
+     *   "Parameter": {
+     *     "Level": 3
+     *   }
+     * });
      */
     CreateInsightsScheduledScalingTask(request: CreateInsightsScheduledScalingTaskRequest, extraHeaders?: Record<string, string>): Promise<CreateTaskResult>;
     /**
      * Registers a relationship between a title and an Open ID Connect provider.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection Microsoft Documentation}
+     * @example
+     * await adminClient.CreateOpenIdConnection({
+     *   "ConnectionId": "oidconnection1",
+     *   "ClientId": "example_id_1",
+     *   "ClientSecret": "example_secret_1",
+     *   "IssuerInformation": {
+     *     "Issuer": "https://issuer.example.com/",
+     *     "AuthorizationUrl": "https://issuer.example.com/authorize",
+     *     "TokenUrl": "https://issuer.example.com/oauth2/token",
+     *     "JsonWebKeySet": {
+     *       "keys": [
+     *         "..."
+     *       ]
+     *     }
+     *   },
+     *   "IssuerOverride": "https://issueroverride.example.com/",
+     *   "IgnoreNonce": true
+     * });
      */
     CreateOpenIdConnection(request: CreateOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after
      * this API returns.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret Microsoft Documentation}
+     * @example
+     * await adminClient.CreatePlayerSharedSecret({
+     *   "FriendlyName": "iOS Users"
+     * });
      */
     CreatePlayerSharedSecret(request: CreatePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<CreatePlayerSharedSecretResult>;
     /**
      * Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval
      * and an aggregation method.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition Microsoft Documentation}
+     * @example
+     * await adminClient.CreatePlayerStatisticDefinition({
+     *   "StatisticName": "headshots",
+     *   "VersionChangeInterval": "Never",
+     *   "ShouldProvisionLeaderboard": false
+     * });
      */
     CreatePlayerStatisticDefinition(request: CreatePlayerStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<CreatePlayerStatisticDefinitionResult>;
     /**
      * Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player
      * segments for a title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment Microsoft Documentation}
+     * @example
+     * await adminClient.CreateSegment({
+     *   "SegmentModel": {
+     *     "Name": "My user segment",
+     *     "LastUpdateTime": "0001-01-01T00:00:00Z",
+     *     "SegmentOrDefinitions": [
+     *       {
+     *         "SegmentAndDefinitions": [
+     *           {
+     *             "AllPlayersFilter": {}
+     *           }
+     *         ]
+     *       }
+     *     ],
+     *     "EnteredSegmentActions": [
+     *       {
+     *         "BanPlayerAction": {
+     *           "BanHours": 2,
+     *           "ReasonForBan": "Not played for a year"
+     *         }
+     *       }
+     *     ],
+     *     "LeftSegmentActions": [
+     *       {
+     *         "ExecuteAzureFunctionAction": {
+     *           "AzureFunction": "AzureFunction1",
+     *           "FunctionParameter": "{\"InputParam\": \"1\"}",
+     *           "GenerateFunctionExecutedEvents": false
+     *         }
+     *       }
+     *     ]
+     *   }
+     * });
      */
     CreateSegment(request: CreateSegmentRequest, extraHeaders?: Record<string, string>): Promise<CreateSegmentResponse>;
     /**
      * Delete a content file from the title. When deleting a file that does not exist, it returns success.
-     * https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteContent({
+     *   "Key": "images/sword_icon.png"
+     * });
      */
     DeleteContent(request: DeleteContentRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
+    /**
+     * Deletes a sink to stop sending PlayStream and Telemetry event data
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/deleteeventsink Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteEventSink({
+     *   "Name": "MyStorage"
+     * });
+     */
+    DeleteEventSink(request: DeleteEventSinkRequest, extraHeaders?: Record<string, string>): Promise<DeleteEventSinkResult>;
     /**
      * Removes a master player account entirely from all titles and deletes all associated data
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteMasterPlayerAccount({
+     *   "PlayFabId": "A68C908B66C23C5",
+     *   "MetaData": "Identifying info"
+     * });
      */
     DeleteMasterPlayerAccount(request: DeleteMasterPlayerAccountRequest, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerAccountResult>;
     /**
      * Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteMasterPlayerEventData({
+     *   "PlayFabId": "A68C908B66C23C5"
+     * });
      */
     DeleteMasterPlayerEventData(request: DeleteMasterPlayerEventDataRequest, extraHeaders?: Record<string, string>): Promise<DeleteMasterPlayerEventDataResult>;
     /**
      * Deletes a player's subscription
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteMembershipSubscription({
+     *   "MembershipId": "ShieldBonusMembership",
+     *   "SubscriptionId": "39F6B89A-0F0C-4D96-B12C-BA89543A11A1",
+     *   "PlayFabId": "204883457"
+     * });
      */
     DeleteMembershipSubscription(request: DeleteMembershipSubscriptionRequest, extraHeaders?: Record<string, string>): Promise<DeleteMembershipSubscriptionResult>;
     /**
      * Removes a relationship between a title and an OpenID Connect provider.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteOpenIdConnection({
+     *   "ConnectionId": "oidconnection1"
+     * });
      */
     DeleteOpenIdConnection(request: DeleteOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Removes a user's player account from a title and deletes all associated data
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/deleteplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties Microsoft Documentation}
+     * @example
+     * await adminClient.DeletePlayerCustomProperties({
+     *   "PlayFabId": "2039475",
+     *   "PropertyNames": [
+     *     "level",
+     *     "created"
+     *   ],
+     *   "ExpectedPropertiesVersion": 12
+     * });
      */
     DeletePlayerCustomProperties(request: DeletePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerCustomPropertiesResult>;
     /**
      * Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API
      * returns.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret Microsoft Documentation}
+     * @example
+     * await adminClient.DeletePlayerSharedSecret({
+     *   "SecretKey": "keysaresecret"
+     * });
      */
     DeletePlayerSharedSecret(request: DeletePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<DeletePlayerSharedSecretResult>;
     /**
      * Deletes an existing player segment and its associated action(s) for a title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteSegment({
+     *   "SegmentId": "97EF0E9302CBE996"
+     * });
      */
     DeleteSegment(request: DeleteSegmentRequest, extraHeaders?: Record<string, string>): Promise<DeleteSegmentsResponse>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Deletes an existing virtual item store
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteStore({
+     *   "StoreId": "BonusStore"
+     * });
      */
     DeleteStore(request: DeleteStoreRequest, extraHeaders?: Record<string, string>): Promise<DeleteStoreResult>;
     /**
      * Delete a task.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteTask({
+     *   "Identifier": {
+     *     "Id": "E1772FD927D8539D"
+     *   }
+     * });
      */
     DeleteTask(request: DeleteTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Permanently deletes a title and all associated configuration
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteTitle({});
      */
     DeleteTitle(request: DeleteTitleRequest, extraHeaders?: Record<string, string>): Promise<DeleteTitleResult>;
     /**
      * Deletes a specified set of title data overrides.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride Microsoft Documentation}
+     * @example
+     * await adminClient.DeleteTitleDataOverride({
+     *   "OverrideLabel": "LaunchData"
+     * });
      */
     DeleteTitleDataOverride(request: DeleteTitleDataOverrideRequest, extraHeaders?: Record<string, string>): Promise<DeleteTitleDataOverrideResult>;
+    /**
+     * Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics. This method does not
+     * remove the player's event history, login history, inventory items, nor virtual currencies.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteusers Microsoft Documentation}
+     * @deprecated Please use DeletePlayer instead.
+     */
+    DeleteUsers(request: DeleteUsersRequest, extraHeaders?: Record<string, string>): Promise<DeleteUsersResult>;
     /**
      * Exports all associated data of a master player account
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata Microsoft Documentation}
+     * @example
+     * await adminClient.ExportMasterPlayerData({
+     *   "PlayFabId": "A68C908B66C23C5"
+     * });
      */
     ExportMasterPlayerData(request: ExportMasterPlayerDataRequest, extraHeaders?: Record<string, string>): Promise<ExportMasterPlayerDataResult>;
     /**
      * Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which
      * match the segment definition at the time of the API call. Profiles which change while an export is in progress will not
      * be reflected in the results.
-     * https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment Microsoft Documentation}
+     * @example
+     * await adminClient.ExportPlayersInSegment({
+     *   "SegmentId": "ABCDEF1234567890"
+     * });
      */
     ExportPlayersInSegment(request: ExportPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<ExportPlayersInSegmentResult>;
     /**
      * Get information about a ActionsOnPlayersInSegment task instance.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance Microsoft Documentation}
+     * @example
+     * await adminClient.GetActionsOnPlayersInSegmentTaskInstance({
+     *   "TaskInstanceId": "E52531B47B1761C7-4"
+     * });
      */
     GetActionsOnPlayersInSegmentTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetActionsOnPlayersInSegmentTaskInstanceResult>;
+    /**
+     * Retrieve a list of all PlayStream actions groups.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallactiongroups Microsoft Documentation}
+     * @deprecated Please use GetTasks 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/admin/playstream/getallsegments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments Microsoft Documentation}
+     * @example
+     * await adminClient.GetAllSegments({});
      */
     GetAllSegments(request: GetAllSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetAllSegmentsResult>;
     /**
      * _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/admin/title-wide-data-management/getcatalogitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getcatalogitems Microsoft Documentation}
+     * @example
+     * await adminClient.GetCatalogItems({
+     *   "CatalogVersion": "1"
+     * });
      */
     GetCatalogItems(request: GetCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<GetCatalogItemsResult>;
+    /**
+     * Get detail information about a CloudScript Azure Functions task instance.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscriptazurefunctionstaskinstance Microsoft Documentation}
+     * @example
+     * await adminClient.GetCloudScriptAzureFunctionsTaskInstance({
+     *   "TaskInstanceId": "E52531B47B1761C7-4"
+     * });
+     */
+    GetCloudScriptAzureFunctionsTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptAzureFunctionsTaskInstanceResult>;
     /**
      * Gets the contents and information of a specific Cloud Script revision.
-     * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision Microsoft Documentation}
+     * @example
+     * await adminClient.GetCloudScriptRevision({
+     *   "Version": 1,
+     *   "Revision": 3
+     * });
      */
     GetCloudScriptRevision(request: GetCloudScriptRevisionRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptRevisionResult>;
     /**
      * Get detail information about a CloudScript task instance.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance Microsoft Documentation}
+     * @example
+     * await adminClient.GetCloudScriptTaskInstance({
+     *   "TaskInstanceId": "E52531B47B1761C7-4"
+     * });
      */
     GetCloudScriptTaskInstance(request: GetTaskInstanceRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptTaskInstanceResult>;
     /**
      * Lists all the current cloud script versions. For each version, information about the current published and latest
      * revisions is also listed.
-     * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions Microsoft Documentation}
+     * @example
+     * await adminClient.GetCloudScriptVersions({});
      */
     GetCloudScriptVersions(request: GetCloudScriptVersionsRequest, extraHeaders?: Record<string, string>): Promise<GetCloudScriptVersionsResult>;
     /**
      * List all contents of the title and get statistics such as size
-     * https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist Microsoft Documentation}
+     * @example
+     * await adminClient.GetContentList({
+     *   "Prefix": "2016/1"
+     * });
      */
     GetContentList(request: GetContentListRequest, extraHeaders?: Record<string, string>): Promise<GetContentListResult>;
     /**
      * Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the
      * content. 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/admin/content/getcontentuploadurl
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentuploadurl Microsoft Documentation}
+     * @example
+     * await adminClient.GetContentUploadUrl({
+     *   "Key": "images/sword_icon.png",
+     *   "ContentType": "image/png"
+     * });
      */
     GetContentUploadUrl(request: GetContentUploadUrlRequest, extraHeaders?: Record<string, string>): Promise<GetContentUploadUrlResult>;
     /**
      * Retrieves a download URL for the requested report
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport Microsoft Documentation}
+     * @example
+     * await adminClient.GetDataReport({
+     *   "ReportName": "PurchaseDataReport",
+     *   "Year": 2014,
+     *   "Month": 12,
+     *   "Day": 5
+     * });
      */
     GetDataReport(request: GetDataReportRequest, extraHeaders?: Record<string, string>): Promise<GetDataReportResult>;
+    /**
+     * Retrieves the set of sinks to which to route PlayStream and Telemetry event data.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/geteventsinks Microsoft Documentation}
+     * @example
+     * await adminClient.GetEventSinks({});
+     */
+    GetEventSinks(request: GetEventSinksRequest, extraHeaders?: Record<string, string>): Promise<GetEventSinksResult>;
+    /**
+     * Retrieves the details for a specific completed session, including links to standard out and standard error logs
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/getmatchmakergameinfo Microsoft Documentation}
+     * @deprecated Please use MultiplayerServer/GetMultiplayerSessionLogsBySessionId instead.
+     */
+    GetMatchmakerGameInfo(request: GetMatchmakerGameInfoRequest, extraHeaders?: Record<string, string>): Promise<GetMatchmakerGameInfoResult>;
+    /**
+     * Retrieves the details of defined game modes for the specified game server executable
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/getmatchmakergamemodes Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    GetMatchmakerGameModes(request: GetMatchmakerGameModesRequest, extraHeaders?: Record<string, string>): Promise<GetMatchmakerGameModesResult>;
     /**
      * Get the list of titles that the player has played
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayedTitleList({
+     *   "PlayFabId": "A68C908B66C23C5"
+     * });
      */
     GetPlayedTitleList(request: GetPlayedTitleListRequest, extraHeaders?: Record<string, string>): Promise<GetPlayedTitleListResult>;
     /**
      * Retrieves a title-specific custom property value for a player.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayerCustomProperty({
+     *   "PlayFabId": "2039475",
+     *   "PropertyName": "level"
+     * });
      */
     GetPlayerCustomProperty(request: GetPlayerCustomPropertyRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerCustomPropertyResult>;
     /**
      * Gets a player's ID from an auth token.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayerIdFromAuthToken({
+     *   "Token": "3F584AD0EF943E2",
+     *   "TokenType": "Email"
+     * });
      */
     GetPlayerIdFromAuthToken(request: GetPlayerIdFromAuthTokenRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerIdFromAuthTokenResult>;
     /**
      * Retrieves the player's profile
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/playstream/getplayersegments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayerSegments({
+     *   "PlayFabId": "1337AA00"
+     * });
      */
     GetPlayerSegments(request: GetPlayersSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSegmentsResult>;
     /**
      * Returns all Player Shared Secret Keys including disabled and expired.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayerSharedSecrets({});
      */
     GetPlayerSharedSecrets(request: GetPlayerSharedSecretsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerSharedSecretsResult>;
     /**
@@ -3090,39 +3945,76 @@ declare class PlayFabAdminApi 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/admin/playstream/getplayersinsegment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayersInSegment({
+     *   "SegmentId": "1337AA00",
+     *   "SecondsToLive": 5,
+     *   "MaxBatchSize": 500
+     * });
      */
     GetPlayersInSegment(request: GetPlayersInSegmentRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentResult>;
     /**
      * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have
      * a reset interval.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayerStatisticDefinitions({});
      */
     GetPlayerStatisticDefinitions(request: GetPlayerStatisticDefinitionsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerStatisticDefinitionsResult>;
     /**
      * Retrieves the information on the available versions of the specified statistic.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/playstream/getplayertags
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags Microsoft Documentation}
+     * @example
+     * await adminClient.GetPlayerTags({
+     *   "PlayFabId": "10931252888739651331",
+     *   "Namespace": "title.AAA"
+     * });
      */
     GetPlayerTags(request: GetPlayerTagsRequest, extraHeaders?: Record<string, string>): Promise<GetPlayerTagsResult>;
     /**
      * Gets the requested policy.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy Microsoft Documentation}
+     * @example
+     * await adminClient.GetPolicy({
+     *   "PolicyName": "ApiPolicy"
+     * });
      */
     GetPolicy(request: GetPolicyRequest, extraHeaders?: Record<string, string>): Promise<GetPolicyResponse>;
     /**
      * Retrieves the key-value store of custom publisher settings
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata Microsoft Documentation}
+     * @example
+     * await adminClient.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 random drop table configuration for the title
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables Microsoft Documentation}
+     * @example
+     * await adminClient.GetRandomResultTables({});
      */
     GetRandomResultTables(request: GetRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<GetRandomResultTablesResult>;
     /**
@@ -3130,221 +4022,895 @@ declare class PlayFabAdminApi extends PlayFabCommon {
      * complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls
      * from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of
      * the export
-     * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport Microsoft Documentation}
+     * @example
+     * await adminClient.GetSegmentExport({
+     *   "ExportId": "ABCDEF1234567890"
+     * });
      */
     GetSegmentExport(request: GetPlayersInSegmentExportRequest, extraHeaders?: Record<string, string>): Promise<GetPlayersInSegmentExportResponse>;
     /**
      * Get detail information of a segment and its associated definition(s) and action(s) for a title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments Microsoft Documentation}
+     * @example
+     * await adminClient.GetSegments({
+     *   "SegmentIds": [
+     *     "B05FC8CB558A6570",
+     *     "97EF0E9302CBE996"
+     *   ]
+     * });
      */
     GetSegments(request: GetSegmentsRequest, extraHeaders?: Record<string, string>): Promise<GetSegmentsResponse>;
+    /**
+     * Retrieves the build details for the specified game server executable
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/getserverbuildinfo Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    GetServerBuildInfo(request: GetServerBuildInfoRequest, extraHeaders?: Record<string, string>): Promise<GetServerBuildInfoResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retrieves the set of items defined for the specified store, including all prices defined
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems Microsoft Documentation}
+     * @example
+     * await adminClient.GetStoreItems({
+     *   "StoreId": "BonusStore"
+     * });
      */
     GetStoreItems(request: GetStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<GetStoreItemsResult>;
     /**
      * Query for task instances by task, status, or time range.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances Microsoft Documentation}
+     * @example
+     * await adminClient.GetTaskInstances({
+     *   "StatusFilter": "Failed",
+     *   "StartedAtRangeFrom": "2016-08-23T11:00:00Z"
+     * });
      */
     GetTaskInstances(request: GetTaskInstancesRequest, extraHeaders?: Record<string, string>): Promise<GetTaskInstancesResult>;
     /**
      * Get definition information on a specified task or all tasks within a title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks Microsoft Documentation}
+     * @example
+     * await adminClient.GetTasks({
+     *   "Identifier": {
+     *     "Name": "EnableDailyHappyHour"
+     *   }
+     * });
      */
     GetTasks(request: GetTasksRequest, extraHeaders?: Record<string, string>): Promise<GetTasksResult>;
     /**
      * Retrieves the key-value store of custom title settings which can be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata Microsoft Documentation}
+     * @example
+     * await adminClient.GetTitleData({
+     *   "Keys": [
+     *     "color",
+     *     "propertyA"
+     *   ]
+     * });
      */
     GetTitleData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
     /**
      * Retrieves the key-value store of custom title settings which cannot be read by the client
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata Microsoft Documentation}
+     * @example
+     * await adminClient.GetTitleInternalData({
+     *   "Keys": [
+     *     "color",
+     *     "propertyA"
+     *   ]
+     * });
      */
     GetTitleInternalData(request: GetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<GetTitleDataResult>;
     /**
      * Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo Microsoft Documentation}
+     * @example
+     * await adminClient.GetUserAccountInfo({
+     *   "PlayFabId": "293753934",
+     *   "IgnoreMissingTitleActivation": false
+     * });
      */
     GetUserAccountInfo(request: LookupUserAccountInfoRequest, extraHeaders?: Record<string, string>): Promise<LookupUserAccountInfoResult>;
     /**
      * Gets all bans for a user.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/getuserdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserdata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/getuserinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserinternaldata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-item-management/getuserinventory
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/getuserinventory Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/getuserpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherdata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/getuserpublisherinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherinternaldata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/getuserpublisherreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherreadonlydata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/getuserreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserreadonlydata Microsoft Documentation}
+     * @example
+     * await adminClient.GetUserReadOnlyData({
+     *   "PlayFabId": "2039475",
+     *   "Keys": [
+     *     "preferences",
+     *     "progress"
+     *   ],
+     *   "IfChangedFromDataVersion": 13
+     * });
      */
     GetUserReadOnlyData(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._ Adds the specified items to the specified user inventories
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers Microsoft Documentation}
+     * @example
+     * await adminClient.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>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Increases the global count for the given scarce resource.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability Microsoft Documentation}
+     * @example
+     * await adminClient.IncrementLimitedEditionItemAvailability({
+     *   "CatalogVersion": "Rares",
+     *   "ItemId": "FreeHoodie",
+     *   "Amount": 50
+     * });
      */
     IncrementLimitedEditionItemAvailability(request: IncrementLimitedEditionItemAvailabilityRequest, extraHeaders?: Record<string, string>): Promise<IncrementLimitedEditionItemAvailabilityResult>;
     /**
      * Resets the indicated statistic, removing all player entries for it and backing up the old values.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion Microsoft Documentation}
+     * @example
+     * await adminClient.IncrementPlayerStatisticVersion({
+     *   "StatisticName": "headshots"
+     * });
      */
     IncrementPlayerStatisticVersion(request: IncrementPlayerStatisticVersionRequest, extraHeaders?: Record<string, string>): Promise<IncrementPlayerStatisticVersionResult>;
     /**
      * Retrieves a list of all Open ID Connect providers registered to a title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection Microsoft Documentation}
+     * @example
+     * await adminClient.ListOpenIdConnection({});
      */
     ListOpenIdConnection(request: ListOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<ListOpenIdConnectionResponse>;
     /**
      * Retrieves title-specific custom property values for a player.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties Microsoft Documentation}
+     * @example
+     * await adminClient.ListPlayerCustomProperties({
+     *   "PlayFabId": "2039475"
+     * });
      */
     ListPlayerCustomProperties(request: ListPlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<ListPlayerCustomPropertiesResult>;
+    /**
+     * Retrieves the build details for all game server executables which are currently defined for the title
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/listserverbuilds Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    ListServerBuilds(request: ListBuildsRequest, extraHeaders?: Record<string, string>): Promise<ListBuildsResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Retuns the list of all defined virtual currencies for the title
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes Microsoft Documentation}
+     * @example
+     * await adminClient.ListVirtualCurrencyTypes({});
      */
     ListVirtualCurrencyTypes(request: ListVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<ListVirtualCurrencyTypesResult>;
+    /**
+     * Updates the game server mode details for the specified game server executable
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/matchmaking/modifymatchmakergamemodes Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    ModifyMatchmakerGameModes(request: ModifyMatchmakerGameModesRequest, extraHeaders?: Record<string, string>): Promise<ModifyMatchmakerGameModesResult>;
+    /**
+     * Updates the build details for the specified game server executable
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/modifyserverbuild Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    ModifyServerBuild(request: ModifyServerBuildRequest, extraHeaders?: Record<string, string>): Promise<ModifyServerBuildResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Attempts to process an order refund through the original real money payment provider.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase Microsoft Documentation}
+     * @example
+     * await adminClient.RefundPurchase({
+     *   "PlayFabId": "20394883",
+     *   "OrderId": "B456AE0",
+     *   "Reason": "Customer Request"
+     * });
      */
     RefundPurchase(request: RefundPurchaseRequest, extraHeaders?: Record<string, string>): Promise<RefundPurchaseResponse>;
     /**
      * 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/admin/playstream/removeplayertag
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag Microsoft Documentation}
+     * @example
+     * await adminClient.RemovePlayerTag({
+     *   "PlayFabId": "10931252888739651331",
+     *   "TagName": "MostKilled"
+     * });
      */
     RemovePlayerTag(request: RemovePlayerTagRequest, extraHeaders?: Record<string, string>): Promise<RemovePlayerTagResult>;
+    /**
+     * Removes the game server executable specified from the set of those a client is permitted to request in a call to
+     * StartGame
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/custom-server-management/removeserverbuild Microsoft Documentation}
+     * @deprecated Do not use
+     */
+    RemoveServerBuild(request: RemoveServerBuildRequest, extraHeaders?: Record<string, string>): Promise<RemoveServerBuildResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Removes one or more virtual currencies from the set defined for the title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes Microsoft Documentation}
+     * @example
+     * await adminClient.RemoveVirtualCurrencyTypes({
+     *   "VirtualCurrencies": [
+     *     {
+     *       "CurrencyCode": "CC"
+     *     },
+     *     {
+     *       "CurrencyCode": "GC"
+     *     }
+     *   ]
+     * });
      */
     RemoveVirtualCurrencyTypes(request: RemoveVirtualCurrencyTypesRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
     /**
      * Completely removes all statistics for the specified character, for the current game
-     * https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics Microsoft Documentation}
+     * @example
+     * await adminClient.ResetCharacterStatistics({
+     *   "PlayFabId": "293753934",
+     *   "CharacterId": "7654321"
+     * });
      */
     ResetCharacterStatistics(request: ResetCharacterStatisticsRequest, extraHeaders?: Record<string, string>): Promise<ResetCharacterStatisticsResult>;
     /**
      * Reset a player's password for a given title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword Microsoft Documentation}
+     * @example
+     * await adminClient.ResetPassword({
+     *   "Token": "2B584FA1DF645E4",
+     *   "Password": "ExampleSecret@r"
+     * });
      */
     ResetPassword(request: ResetPasswordRequest, extraHeaders?: Record<string, string>): Promise<ResetPasswordResult>;
+    /**
+     * Resets all title-specific information about a particular account, including user data, virtual currency balances,
+     * inventory, purchase history, and statistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetusers Microsoft Documentation}
+     * @deprecated Please use DeletePlayer instead.
+     */
+    ResetUsers(request: ResetUsersRequest, extraHeaders?: Record<string, string>): Promise<BlankResult>;
     /**
      * Completely removes all statistics for the specified user, for the current game
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics Microsoft Documentation}
+     * @example
+     * await adminClient.ResetUserStatistics({
+     *   "PlayFabId": "293753934"
+     * });
      */
     ResetUserStatistics(request: ResetUserStatisticsRequest, extraHeaders?: Record<string, string>): Promise<ResetUserStatisticsResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Attempts to resolve a dispute with the original order's payment provider.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute Microsoft Documentation}
+     * @example
+     * await adminClient.ResolvePurchaseDispute({
+     *   "PlayFabId": "20394883",
+     *   "OrderId": "B456AE0",
+     *   "Reason": "Customer Request",
+     *   "Outcome": "Reinstate"
+     * });
      */
     ResolvePurchaseDispute(request: ResolvePurchaseDisputeRequest, extraHeaders?: Record<string, string>): Promise<ResolvePurchaseDisputeResponse>;
     /**
      * Revoke all active bans for a user.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/account-management/revokebans
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-item-management/revokeinventoryitem
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-item-management/revokeinventoryitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems Microsoft Documentation}
+     * @example
+     * await adminClient.RevokeInventoryItems({
+     *   "Items": [
+     *     {
+     *       "PlayFabId": "203945882",
+     *       "ItemInstanceId": "2048583045"
+     *     }
+     *   ]
+     * });
      */
     RevokeInventoryItems(request: RevokeInventoryItemsRequest, extraHeaders?: Record<string, string>): Promise<RevokeInventoryItemsResult>;
     /**
      * Run a task immediately regardless of its schedule.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask Microsoft Documentation}
+     * @example
+     * await adminClient.RunTask({
+     *   "Identifier": {
+     *     "Id": "E1772FD927D8539D"
+     *   }
+     * });
      */
     RunTask(request: RunTaskRequest, extraHeaders?: Record<string, string>): Promise<RunTaskResult>;
     /**
      * Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to
      * change the password.If an account recovery email template ID is provided, an email using the custom email template will
      * be used.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail Microsoft Documentation}
+     * @example
+     * await adminClient.SendAccountRecoveryEmail({
+     *   "Email": "assignedemail@here.com",
+     *   "EmailTemplateId": "D53AB15D8F12E330"
+     * });
      */
     SendAccountRecoveryEmail(request: SendAccountRecoveryEmailRequest, extraHeaders?: Record<string, string>): Promise<SendAccountRecoveryEmailResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems Microsoft Documentation}
+     * @example
+     * await adminClient.SetCatalogItems({
+     *   "CatalogVersion": "5",
+     *   "Catalog": [
+     *     {
+     *       "ItemId": "shield_level_5",
+     *       "ItemClass": "shields",
+     *       "DisplayName": "Level 5 Shield",
+     *       "Description": "Strong defense against projectile attacks",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 199,
+     *         "GV": 25
+     *       },
+     *       "RealCurrencyPrices": {
+     *         "GBP": 149,
+     *         "EUR": 169
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "energy_boost_1",
+     *       "ItemClass": "boosts",
+     *       "DisplayName": "Energy Drink Six-Pack",
+     *       "Description": "Get a quick burst of energy whenever you need it",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 199,
+     *         "GV": 25
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_1",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 1",
+     *       "Description": "Item 1 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_2",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 2",
+     *       "Description": "Item 2 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_3",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 3",
+     *       "Description": "Item 3 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_4",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 4",
+     *       "Description": "Item 4 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "granted_item_a",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Granted Item A",
+     *       "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "consumable_item_1",
+     *       "ItemClass": "Consumables",
+     *       "DisplayName": "Consumable Item 1",
+     *       "Description": "Item demonstrating usage-based consumables",
+     *       "VirtualCurrencyPrices": {
+     *         "GV": 500
+     *       },
+     *       "Consumable": {
+     *         "UsageCount": 3
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "consumable_item_2",
+     *       "ItemClass": "Consumables",
+     *       "DisplayName": "Consumable Item 2",
+     *       "Description": "Item demonstrating time-based consumables",
+     *       "VirtualCurrencyPrices": {
+     *         "GV": 750
+     *       },
+     *       "Consumable": {
+     *         "UsagePeriod": 3600,
+     *         "UsagePeriodGroup": "usage_group_1"
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_bundle_item_1",
+     *       "ItemClass": "Bundles",
+     *       "DisplayName": "Bundled Item 1",
+     *       "Description": "Item which is added to the user inventory as part of a bundle",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_bundle_item_2",
+     *       "ItemClass": "Bundles",
+     *       "DisplayName": "Bundled Item 2",
+     *       "Description": "Item which is added to the user inventory as part of a bundle",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "item_bundle_1",
+     *       "ItemClass": "Bundles",
+     *       "DisplayName": "Item bundle 1",
+     *       "Description": "Item which, when added to the user inventory, also adds other bundled items",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 599
+     *       },
+     *       "Bundle": {
+     *         "BundledItems": [
+     *           "sub_bundle_item_1",
+     *           "sub_bundle_item_2"
+     *         ],
+     *         "BundledResultTables": [
+     *           "random_result_1"
+     *         ],
+     *         "BundledVirtualCurrencies": {
+     *           "GV": 1000
+     *         }
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "key_item_1",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Key Item 1",
+     *       "Description": "Key used to unlock Container 1",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 199
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_container_item_1",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Container Item 1",
+     *       "Description": "Item which is added to the user inventory as part of opening a container",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_container_item_2",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Container Item 2",
+     *       "Description": "Item which is added to the user inventory as part of opening a container",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "item_container_1",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Item Container 1",
+     *       "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 499
+     *       },
+     *       "Consumable": {
+     *         "UsageCount": 1
+     *       },
+     *       "Container": {
+     *         "KeyItemId": "key_item_1",
+     *         "ItemContents": [
+     *           "sub_container_item_1",
+     *           "sub_container_item_2"
+     *         ],
+     *         "ResultTableContents": [
+     *           "random_result_1"
+     *         ],
+     *         "VirtualCurrencyContents": {
+     *           "GV": 1000
+     *         }
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "item_container_2",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Item Container 2",
+     *       "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 99
+     *       },
+     *       "Consumable": {
+     *         "UsageCount": 1
+     *       },
+     *       "Container": {
+     *         "VirtualCurrencyContents": {
+     *           "GV": 1000
+     *         }
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "starterpack_1",
+     *       "ItemClass": "starterpacks",
+     *       "DisplayName": "Super Starter Pack",
+     *       "Description": "Everything you need to get started fast track at the right price",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     }
+     *   ]
+     * });
      */
     SetCatalogItems(request: UpdateCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
+    /**
+     * Updates the sink to which to route PlayStream and Telemetry event data.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/playstream/seteventsink Microsoft Documentation}
+     * @example
+     * await adminClient.SetEventSink({
+     *   "Sink": {
+     *     "Name": "MyStorage",
+     *     "DestinationType": "AzureBlobStorage",
+     *     "IsEnabled": true,
+     *     "SinkSettings": {
+     *       "AccountName": "mystorageaccount",
+     *       "ContainerName": "mycontainername",
+     *       "TenantId": null,
+     *       "Credentials": {
+     *         "Secret": ""
+     *       }
+     *     }
+     *   }
+     * });
+     */
+    SetEventSink(request: SetEventSinkRequest, extraHeaders?: Record<string, string>): Promise<SetEventSinkResult>;
     /**
      * Sets the override expiration for a membership subscription
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride Microsoft Documentation}
+     * @example
+     * await adminClient.SetMembershipOverride({
+     *   "ExpirationTime": "2014-04-06T00:00:00Z",
+     *   "MembershipId": "ShieldBonusMembership",
+     *   "PlayFabId": "204883457"
+     * });
      */
     SetMembershipOverride(request: SetMembershipOverrideRequest, extraHeaders?: Record<string, string>): Promise<SetMembershipOverrideResult>;
     /**
      * Sets or resets the player's secret. Player secrets are used to sign API requests.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret Microsoft Documentation}
+     * @example
+     * await adminClient.SetPlayerSecret({
+     *   "PlayerSecret": "ExampleSecret",
+     *   "PlayFabId": "ABCD1234"
+     * });
      */
     SetPlayerSecret(request: SetPlayerSecretRequest, extraHeaders?: Record<string, string>): Promise<SetPlayerSecretResult>;
     /**
      * Sets the currently published revision of a title Cloud Script
-     * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision Microsoft Documentation}
+     * @example
+     * await adminClient.SetPublishedRevision({
+     *   "Version": 1,
+     *   "Revision": 3
+     * });
      */
     SetPublishedRevision(request: SetPublishedRevisionRequest, extraHeaders?: Record<string, string>): Promise<SetPublishedRevisionResult>;
     /**
      * Updates the key-value store of custom publisher settings
-     * https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata Microsoft Documentation}
+     * @example
+     * await adminClient.SetPublisherData({
+     *   "Key": "Running Speed",
+     *   "Value": "1.03"
+     * });
      */
     SetPublisherData(request: SetPublisherDataRequest, extraHeaders?: Record<string, string>): Promise<SetPublisherDataResult>;
     /**
      * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for
      * version 2._ Sets all the items in one virtual store
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems Microsoft Documentation}
+     * @example
+     * await adminClient.SetStoreItems({
+     *   "StoreId": "BonusStore",
+     *   "Store": [
+     *     {
+     *       "ItemId": "shield_level_5",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 180,
+     *         "GV": 20
+     *       },
+     *       "RealCurrencyPrices": {
+     *         "GBP": 100
+     *       }
+     *     },
+     *     {
+     *       "ItemId": "energy_boost_1",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 250,
+     *         "GV": 30
+     *       }
+     *     },
+     *     {
+     *       "ItemId": "starterpack_1",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 399
+     *       }
+     *     }
+     *   ]
+     * });
      */
     SetStoreItems(request: UpdateStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
     /**
@@ -3352,131 +4918,756 @@ declare class PlayFabAdminApi extends PlayFabCommon {
      * developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
      * movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
      * build.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata Microsoft Documentation}
+     * @example
+     * await adminClient.SetTitleData({
+     *   "Key": "Running Speed",
+     *   "Value": "1.03"
+     * });
      */
     SetTitleData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
     /**
      * Set and delete key-value pairs in a title data override instance.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides Microsoft Documentation}
+     * @example
+     * await adminClient.SetTitleDataAndOverrides({
+     *   "OverrideLabel": "Holiday title data",
+     *   "TitleId": "8FF3A797",
+     *   "KeyValues": [
+     *     {
+     *       "Key": "Running Speed",
+     *       "Value": "1.03"
+     *     },
+     *     {
+     *       "Key": "Walking Speed",
+     *       "Value": "0.05"
+     *     }
+     *   ]
+     * });
      */
     SetTitleDataAndOverrides(request: SetTitleDataAndOverridesRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataAndOverridesResult>;
     /**
      * Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
      * tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata Microsoft Documentation}
+     * @example
+     * await adminClient.SetTitleInternalData({
+     *   "Key": "Running Speed",
+     *   "Value": "1.03"
+     * });
      */
     SetTitleInternalData(request: SetTitleDataRequest, extraHeaders?: Record<string, string>): Promise<SetTitleDataResult>;
     /**
      * Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can
      * be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device
      * Messaging is not supported.
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification Microsoft Documentation}
+     * @example
+     * await adminClient.SetupPushNotification({
+     *   "Platform": "APNS_SANDBOX",
+     *   "Key": "MyKey123",
+     *   "Credential": "MyCredentialsXYZ",
+     *   "OverwriteOldARN": false
+     * });
      */
     SetupPushNotification(request: SetupPushNotificationRequest, extraHeaders?: Record<string, string>): Promise<SetupPushNotificationResult>;
     /**
      * _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 specified virtual currency by the stated amount
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency Microsoft Documentation}
+     * @example
+     * await adminClient.SubtractUserVirtualCurrency({
+     *   "PlayFabId": "20394883",
+     *   "VirtualCurrency": "GC",
+     *   "Amount": 100
+     * });
      */
     SubtractUserVirtualCurrency(request: SubtractUserVirtualCurrencyRequest, extraHeaders?: Record<string, string>): Promise<ModifyUserVirtualCurrencyResult>;
     /**
      * Updates information of a list of existing bans specified with Ban Ids.
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans Microsoft Documentation}
+     * @example
+     * await adminClient.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>;
     /**
      * _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 catalog configuration for virtual goods in the specified catalog version
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateCatalogItems({
+     *   "CatalogVersion": "5",
+     *   "Catalog": [
+     *     {
+     *       "ItemId": "shield_level_5",
+     *       "ItemClass": "shields",
+     *       "DisplayName": "Level 5 Shield",
+     *       "Description": "Strong defense against projectile attacks",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 199,
+     *         "GV": 25
+     *       },
+     *       "RealCurrencyPrices": {
+     *         "GBP": 149,
+     *         "EUR": 169
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "energy_boost_1",
+     *       "ItemClass": "boosts",
+     *       "DisplayName": "Energy Drink Six-Pack",
+     *       "Description": "Get a quick burst of energy whenever you need it",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 199,
+     *         "GV": 25
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_1",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 1",
+     *       "Description": "Item 1 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_2",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 2",
+     *       "Description": "Item 2 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_3",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 3",
+     *       "Description": "Item 3 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "required_item_for_grant_a_4",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Grant Set Item 4",
+     *       "Description": "Item 4 from the set of items needed to get Granted Item A for free",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 249,
+     *         "GV": 1500
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "granted_item_a",
+     *       "ItemClass": "sets",
+     *       "DisplayName": "Granted Item A",
+     *       "Description": "Bonus item granted for free once the full set of 4 Grant Set items are collected",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "consumable_item_1",
+     *       "ItemClass": "Consumables",
+     *       "DisplayName": "Consumable Item 1",
+     *       "Description": "Item demonstrating usage-based consumables",
+     *       "VirtualCurrencyPrices": {
+     *         "GV": 500
+     *       },
+     *       "Consumable": {
+     *         "UsageCount": 3
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "consumable_item_2",
+     *       "ItemClass": "Consumables",
+     *       "DisplayName": "Consumable Item 2",
+     *       "Description": "Item demonstrating time-based consumables",
+     *       "VirtualCurrencyPrices": {
+     *         "GV": 750
+     *       },
+     *       "Consumable": {
+     *         "UsagePeriod": 3600,
+     *         "UsagePeriodGroup": "usage_group_1"
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_bundle_item_1",
+     *       "ItemClass": "Bundles",
+     *       "DisplayName": "Bundled Item 1",
+     *       "Description": "Item which is added to the user inventory as part of a bundle",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_bundle_item_2",
+     *       "ItemClass": "Bundles",
+     *       "DisplayName": "Bundled Item 2",
+     *       "Description": "Item which is added to the user inventory as part of a bundle",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "item_bundle_1",
+     *       "ItemClass": "Bundles",
+     *       "DisplayName": "Item bundle 1",
+     *       "Description": "Item which, when added to the user inventory, also adds other bundled items",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 599
+     *       },
+     *       "Bundle": {
+     *         "BundledItems": [
+     *           "sub_bundle_item_1",
+     *           "sub_bundle_item_2"
+     *         ],
+     *         "BundledResultTables": [
+     *           "random_result_1"
+     *         ],
+     *         "BundledVirtualCurrencies": {
+     *           "GV": 1000
+     *         }
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "key_item_1",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Key Item 1",
+     *       "Description": "Key used to unlock Container 1",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 199
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_container_item_1",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Container Item 1",
+     *       "Description": "Item which is added to the user inventory as part of opening a container",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "sub_container_item_2",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Container Item 2",
+     *       "Description": "Item which is added to the user inventory as part of opening a container",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "item_container_1",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Item Container 1",
+     *       "Description": "Item which, when opened with Key Item 1, also adds the items it holds to the user inventory",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 499
+     *       },
+     *       "Consumable": {
+     *         "UsageCount": 1
+     *       },
+     *       "Container": {
+     *         "KeyItemId": "key_item_1",
+     *         "ItemContents": [
+     *           "sub_container_item_1",
+     *           "sub_container_item_2"
+     *         ],
+     *         "ResultTableContents": [
+     *           "random_result_1"
+     *         ],
+     *         "VirtualCurrencyContents": {
+     *           "GV": 1000
+     *         }
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "item_container_2",
+     *       "ItemClass": "Containers",
+     *       "DisplayName": "Item Container 2",
+     *       "Description": "Item which, when opened (no key needed), adds the items it holds to the user inventory",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 99
+     *       },
+     *       "Consumable": {
+     *         "UsageCount": 1
+     *       },
+     *       "Container": {
+     *         "VirtualCurrencyContents": {
+     *           "GV": 1000
+     *         }
+     *       },
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     },
+     *     {
+     *       "ItemId": "starterpack_1",
+     *       "ItemClass": "starterpacks",
+     *       "DisplayName": "Super Starter Pack",
+     *       "Description": "Everything you need to get started fast track at the right price",
+     *       "CanBecomeCharacter": false,
+     *       "IsStackable": false,
+     *       "IsTradable": false,
+     *       "IsLimitedEdition": false,
+     *       "InitialLimitedEditionCount": 0
+     *     }
+     *   ]
+     * });
      */
     UpdateCatalogItems(request: UpdateCatalogItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateCatalogItemsResult>;
     /**
      * Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be
      * submitted in the revision.
-     * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateCloudScript({
+     *   "Files": [
+     *     {
+     *       "Filename": "main.js",
+     *       "FileContents": "var LevelRewards =\r\n[\r\n\t[\"TestItem1\"],\r\n\t[\"TestItem2\"],\r\n\t[\"TestItem3\"],\r\n\t[\"TestItem1\", \"TestItem2\"],\r\n\t[\"TestItem2\", \"TestItem2\"],\r\n\t[\"TestItem3\", \"TestItem3\"]\r\n]\r\n\r\nhandlers.onLevelComplete = function(args)\r\n{\r\n\tvar levelNum = args.level;\r\n\t\r\n\t// Do some basic input validation\r\n\tif(levelNum < 0 || levelNum >= LevelRewards.length)\r\n\t{\r\n\t\tlog.info(\"Invalid level \"+levelNum+\" completed by \"+currentPlayerId);\r\n\t\treturn {};\r\n\t}\r\n\t\r\n\tvar levelCompleteKey = \"LevelCompleted\"+levelNum;\r\n\t\r\n\t// Get the user's internal data\r\n\tvar playerInternalData = server.GetUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tKeys: [levelCompleteKey]\r\n\t});\r\n\t\r\n\t// Did they already complete this level?\r\n\tif(playerInternalData.Data[levelCompleteKey])\r\n\t{\r\n\t\tlog.info(\"Player \"+currentPlayerId+\" already completed level \"+levelNum);\r\n\t\treturn {};\r\n\t}\r\n\t\r\n\tvar rewards = LevelRewards[levelNum];\r\n\t\r\n\tvar resultItems = null;\r\n\tif(rewards)\r\n\t{\r\n\t\t// Grant reward items to player for completing the level\r\n\t\tvar itemGrantResult = server.GrantItemsToUser(\r\n\t\t{\r\n\t\t\tPlayFabId: currentPlayerId,\r\n\t\t\tAnnotation: \"Given by completing level \"+levelNum,\r\n\t\t\tItemIds: rewards\r\n\t\t});\r\n\t\t\r\n\t\tresultItems = itemGrantResult.ItemGrantResults;\r\n\t}\r\n\t\r\n\t// Mark the level as being completed so they can't get the reward again\r\n\tvar saveData = {};\r\n\tsaveData[levelCompleteKey] = \"true\";\r\n\tserver.UpdateUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tData: saveData\r\n\t});\r\n\r\n\t// Return the results of the item grant so the client can see what they got\r\n\treturn {\r\n\t\trewards: resultItems\r\n\t};\r\n}\r\n\r\nvar monsterRewards =\r\n{\r\n\t\"skrill\" : { \"ChumpCoins\" : 100},\r\n\t\"lumpur\" : { \"ChumpCoins\" : 200}\r\n}\r\n\r\nvar killCoolDown = 60;\r\n\r\nfunction currTimeSeconds()\r\n{\r\n\tvar now = new Date();\r\n\treturn now.getTime() / 1000;\r\n}\r\n\r\nhandlers.monsterKilled = function(args)\r\n{\r\n\tvar monsterType = args.type;\r\n\t\r\n\tvar now = currTimeSeconds();\r\n\t\r\n\t// Get the user's internal data\r\n\tvar playerInternalData = server.GetUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tKeys: [\"lastKill\"]\r\n\t});\r\n\t\r\n\t// Check when the last time they killed a monster was \r\n\tvar lastKill = playerInternalData.Data[\"lastKill\"];\r\n\tif(lastKill)\r\n\t{\r\n\t\t// We have a value, see when it is\r\n\t\tvar lastKillTime = parseInt(lastKill.Value);\r\n\t\tif(now - lastKillTime < killCoolDown)\r\n\t\t{\r\n\t\t\t// In this particular game, it should not be possible to kill a monster more often than once a minute, so they might be cheating\r\n\t\t\tlog.info(\"Player \"+currentPlayerId+\" killed \"+monsterType+\" again too quickly!\");\r\n\t\t\treturn {};\r\n\t\t}\r\n\t}\r\n\t\r\n\tvar killReward = monsterRewards[monsterType];\r\n\t\r\n\tif(killReward)\r\n\t{\r\n\t\tfor(var currency in killReward)\r\n\t\t{\r\n\t\t\tvar amount = killReward[currency];\r\n\t\t\tserver.AddUserVirtualCurrency({ PlayFabId: currentPlayerId, VirtualCurrency: currency, Amount: amount });\r\n\t\t}\r\n\t}\r\n\t\r\n\t// Reset the kill timer\r\n\tserver.UpdateUserInternalData(\r\n\t{\r\n\t\tPlayFabId: currentPlayerId,\r\n\t\tData: {\r\n\t\t\t\"lastKill\" : String(now)\r\n\t\t}\r\n\t});\r\n\t\r\n\treturn {\r\n\t\trewards: killReward\r\n\t};\r\n}"
+     *     }
+     *   ],
+     *   "Publish": false
+     * });
      */
     UpdateCloudScript(request: UpdateCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<UpdateCloudScriptResult>;
     /**
      * Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateOpenIdConnection({
+     *   "ConnectionId": "oidconnection1",
+     *   "ClientId": "example_id_1",
+     *   "ClientSecret": "new_example_secret",
+     *   "IssuerInformation": {
+     *     "Issuer": "https://issuer.example.com/",
+     *     "AuthorizationUrl": "https://issuer.example.com/authorize",
+     *     "TokenUrl": "https://issuer.example.com/oauth2/token",
+     *     "JsonWebKeySet": {
+     *       "keys": [
+     *         "..."
+     *       ]
+     *     }
+     *   },
+     *   "IssuerOverride": "https://issueroverride.example.com/"
+     * });
      */
     UpdateOpenIdConnection(request: UpdateOpenIdConnectionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates the title-specific custom property values for a player
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties Microsoft Documentation}
+     * @example
+     * await adminClient.UpdatePlayerCustomProperties({
+     *   "PlayFabId": "2039475",
+     *   "Properties": [
+     *     {
+     *       "Name": "level",
+     *       "Value": 5
+     *     },
+     *     {
+     *       "Name": "created",
+     *       "Value": false
+     *     }
+     *   ],
+     *   "ExpectedPropertiesVersion": 12
+     * });
      */
     UpdatePlayerCustomProperties(request: UpdatePlayerCustomPropertiesRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerCustomPropertiesResult>;
     /**
      * Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available
      * after this API returns.
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret Microsoft Documentation}
+     * @example
+     * await adminClient.UpdatePlayerSharedSecret({
+     *   "SecretKey": "keysaresecret",
+     *   "FriendlyName": "XBox Users",
+     *   "Disabled": false
+     * });
      */
     UpdatePlayerSharedSecret(request: UpdatePlayerSharedSecretRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerSharedSecretResult>;
     /**
      * Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition Microsoft Documentation}
+     * @example
+     * await adminClient.UpdatePlayerStatisticDefinition({
+     *   "StatisticName": "headshots",
+     *   "VersionChangeInterval": "Day",
+     *   "ShouldProvisionLeaderboard": false
+     * });
      */
     UpdatePlayerStatisticDefinition(request: UpdatePlayerStatisticDefinitionRequest, extraHeaders?: Record<string, string>): Promise<UpdatePlayerStatisticDefinitionResult>;
     /**
      * Changes a policy for a title
-     * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy Microsoft Documentation}
+     * @example
+     * await adminClient.UpdatePolicy({
+     *   "PolicyName": "ApiPolicy",
+     *   "Statements": [
+     *     {
+     *       "Resource": "pfrn:api--*",
+     *       "Action": "*",
+     *       "Effect": "Allow",
+     *       "Principal": "*",
+     *       "Comment": "The default allow all policy"
+     *     },
+     *     {
+     *       "Resource": "pfrn:api--/Client/ConfirmPurchase",
+     *       "Action": "*",
+     *       "Effect": "Allow",
+     *       "Principal": "*",
+     *       "Comment": "This statement allows only request to ConfirmPurchase"
+     *     }
+     *   ],
+     *   "OverwritePolicy": false,
+     *   "PolicyVersion": 0
+     * });
      */
     UpdatePolicy(request: UpdatePolicyRequest, extraHeaders?: Record<string, string>): Promise<UpdatePolicyResponse>;
     /**
      * _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 random drop table configuration for the title
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateRandomResultTables({
+     *   "Tables": [
+     *     {
+     *       "TableId": "DropTable 1",
+     *       "Nodes": [
+     *         {
+     *           "ResultItemType": "ItemId",
+     *           "ResultItem": "Gold Crown 1",
+     *           "Weight": 20
+     *         },
+     *         {
+     *           "ResultItemType": "ItemId",
+     *           "ResultItem": "Magic Sword 3",
+     *           "Weight": 50
+     *         },
+     *         {
+     *           "ResultItemType": "ItemId",
+     *           "ResultItem": "Clear Shield 3",
+     *           "Weight": 70
+     *         }
+     *       ]
+     *     }
+     *   ]
+     * });
      */
     UpdateRandomResultTables(request: UpdateRandomResultTablesRequest, extraHeaders?: Record<string, string>): Promise<UpdateRandomResultTablesResult>;
     /**
      * Updates an existing player segment and its associated definition(s) and action(s) for a title.
-     * https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateSegment({
+     *   "SegmentModel": {
+     *     "SegmentId": "B05FC8CB558A6570",
+     *     "Name": "My user segment",
+     *     "LastUpdateTime": "0001-01-01T00:00:00Z",
+     *     "SegmentOrDefinitions": [
+     *       {
+     *         "SegmentAndDefinitions": [
+     *           {
+     *             "AllPlayersFilter": {}
+     *           }
+     *         ]
+     *       }
+     *     ],
+     *     "EnteredSegmentActions": [
+     *       {
+     *         "BanPlayerAction": {
+     *           "BanHours": 2,
+     *           "ReasonForBan": "Not played for a year"
+     *         }
+     *       }
+     *     ],
+     *     "LeftSegmentActions": [
+     *       {
+     *         "ExecuteAzureFunctionAction": {
+     *           "AzureFunction": "AzureFunction1",
+     *           "FunctionParameter": "{\"InputParam\": \"1\"}",
+     *           "GenerateFunctionExecutedEvents": false
+     *         }
+     *       }
+     *     ]
+     *   }
+     * });
      */
     UpdateSegment(request: UpdateSegmentRequest, extraHeaders?: Record<string, string>): Promise<UpdateSegmentResponse>;
     /**
      * _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 an existing virtual item store with new or modified items
-     * https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateStoreItems({
+     *   "StoreId": "BonusStore",
+     *   "Store": [
+     *     {
+     *       "ItemId": "shield_level_5",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 180,
+     *         "GV": 20
+     *       },
+     *       "RealCurrencyPrices": {
+     *         "GBP": 100
+     *       }
+     *     },
+     *     {
+     *       "ItemId": "energy_boost_1",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 250,
+     *         "GV": 30
+     *       }
+     *     },
+     *     {
+     *       "ItemId": "starterpack_1",
+     *       "VirtualCurrencyPrices": {
+     *         "RM": 399
+     *       }
+     *     }
+     *   ]
+     * });
      */
     UpdateStoreItems(request: UpdateStoreItemsRequest, extraHeaders?: Record<string, string>): Promise<UpdateStoreItemsResult>;
     /**
      * Update an existing task.
-     * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateTask({
+     *   "Identifier": {
+     *     "Name": "PushEventNotificationVIP_Halloween"
+     *   },
+     *   "Name": "PushEventNotificationVIP_Thanksgiving",
+     *   "Description": "Send push notification to VIP about Thanksgiving event",
+     *   "IsActive": false,
+     *   "Type": "ActionsOnPlayerSegment",
+     *   "Parameter": {
+     *     "SegmentId": "E2B0F9C19B02D796",
+     *     "Actions": [
+     *       {
+     *         "GrantItemContent": {
+     *           "CatalogVersion": "foo",
+     *           "ItemId": "bar",
+     *           "ItemQuantity": 1
+     *         }
+     *       }
+     *     ]
+     *   }
+     * });
      */
     UpdateTask(request: UpdateTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
     /**
      * Updates the title-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/updateuserinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserinternaldata Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateUserInternalData({
+     *   "PlayFabId": "2039475",
+     *   "Data": {
+     *     "Class": "Fighter",
+     *     "Gender": "Female",
+     *     "Icon": "Guard 3",
+     *     "Theme": "Colorful"
+     *   }
+     * });
      */
     UpdateUserInternalData(request: UpdateUserInternalDataRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserDataResult>;
     /**
      * Updates the publisher-specific custom data for the user which is readable and writable by the client
-     * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/updateuserpublisherinternaldata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherinternaldata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/updateuserpublisherreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherreadonlydata Microsoft Documentation}
+     * @example
+     * await adminClient.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/admin/player-data-management/updateuserreadonlydata
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserreadonlydata Microsoft Documentation}
+     * @example
+     * await adminClient.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 title specific display name for a user
-     * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname Microsoft Documentation}
+     * @example
+     * await adminClient.UpdateUserTitleDisplayName({
+     *   "PlayFabId": "293438",
+     *   "DisplayName": "New Display Name"
+     * });
      */
     UpdateUserTitleDisplayName(request: UpdateUserTitleDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<UpdateUserTitleDisplayNameResult>;
 }