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

package/dist/Client.js

@@ -1,7 +1,7 @@
 import {
   PlayFabClientApi
-} from "./chunk-JGDO2ZE3.js";
-import "./chunk-62SULWOK.js";
+} from "./chunk-SR2RIRLX.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabClientApi as default
 };

package/dist/CloudScript.d.ts

@@ -1,4 +1,4 @@
-import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-BX3jSqGx.js';
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
 
 interface AdCampaignAttributionModel {
     /** UTC time stamp of attribution */
@@ -23,6 +23,11 @@ interface EntityKey {
     Id: string;
     /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
     Type?: string;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
 }
 interface EventHubFunctionModel {
     /** The connection string for the event hub. */
@@ -78,17 +83,17 @@ interface ExecuteEntityCloudScriptRequest extends IPlayFabRequestCommon {
     /** Object that is passed in to the function as the first argument */
     FunctionParameter?: any;
     /**
-     * Generate a 'entity_executed_cloudscript' PlayStream event containing the results of the function execution and other
+     * Generate a 'entity_executed_cloudscript' PlayStream event containing the results of the function execution and other
      * contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
      */
     GeneratePlayStreamEvent?: boolean;
     /**
-     * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
-     * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
-     * 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.
+     * Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
+     * executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
+     * 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.
      */
     RevisionSelection?: string;
-    /** The specific revision to execute, when RevisionSelection is set to 'Specific' */
+    /** The specific revision to execute, when RevisionSelection is set to 'Specific' */
     SpecificRevision?: number;
 }
 interface ExecuteFunctionRequest extends IPlayFabRequestCommon {
@@ -101,7 +106,7 @@ interface ExecuteFunctionRequest extends IPlayFabRequestCommon {
     /** Object that is passed in to the function as the FunctionArgument field of the FunctionExecutionContext data structure */
     FunctionParameter?: any;
     /**
-     * Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and
+     * Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and
      * other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
      */
     GeneratePlayStreamEvent?: boolean;
@@ -204,7 +209,7 @@ interface LocationModel {
 interface LogStatement {
     /** Optional object accompanying the message as contextual information */
     Data?: any;
-    /** 'Debug', 'Info', or 'Error' */
+    /** 'Debug', 'Info', or 'Error' */
     Level?: string;
     Message?: string;
 }
@@ -220,6 +225,8 @@ interface MembershipModel {
      * overridden, this will be the new expiration time.
      */
     OverrideExpiration?: string;
+    /** Whether the override expiration is set. */
+    OverrideIsSet?: boolean;
     /** The list of subscriptions that this player has for this membership */
     Subscriptions?: SubscriptionModel[];
 }
@@ -232,7 +239,7 @@ interface NameIdentifier {
 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's avatar image */
     AvatarUrl?: string;
     /** If the player is currently banned, the UTC Date when the ban expires */
     BannedUntil?: string;
@@ -266,16 +273,16 @@ interface PlayerProfileModel {
     PushNotificationRegistrations?: PushNotificationRegistrationModel[];
     /** List of leaderboard statistic values for the player */
     Statistics?: StatisticModel[];
-    /** List of player's tags for segmentation */
+    /** List of player'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'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's lifetime purchase totals, summed by real-money currency */
     ValuesToDate?: ValueToDateModel[];
 }
 interface PlayStreamEventEnvelopeModel {
@@ -311,6 +318,11 @@ interface PostFunctionResultForFunctionExecutionRequest extends IPlayFabRequestC
 interface PostFunctionResultForPlayerTriggeredActionRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
+    /**
+     * The optional entity to perform this action on. Defaults to the currently logged in entity.
+     * @deprecated Do not use
+     */
+    Entity?: EntityKey;
     /** The result of the function execution. */
     FunctionResult: ExecuteFunctionResult;
     /** The player profile the function was invoked with. */
@@ -321,6 +333,11 @@ interface PostFunctionResultForPlayerTriggeredActionRequest extends IPlayFabRequ
 interface PostFunctionResultForScheduledTaskRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
+    /**
+     * The entity to perform this action on.
+     * @deprecated Do not use
+     */
+    Entity?: EntityKey;
     /** The result of the function execution */
     FunctionResult: ExecuteFunctionResult;
     /** The id of the scheduled task that invoked the function. */
@@ -392,7 +409,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;
@@ -418,12 +435,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;
 }
@@ -432,78 +449,229 @@ declare class PlayFabCloudScriptApi extends PlayFabCommon {
     /**
      * Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
      * custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.ExecuteEntityCloudScript({
+     *   "FunctionName": "levelCompleted",
+     *   "FunctionParameter": {
+     *     "level": 3,
+     *     "points": 400
+     *   },
+     *   "RevisionSelection": "Live",
+     *   "GeneratePlayStreamEvent": true,
+     *   "Entity": {
+     *     "Id": "aaa",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     ExecuteEntityCloudScript(request: ExecuteEntityCloudScriptRequest, extraHeaders?: Record<string, string>): Promise<ExecuteCloudScriptResult>;
     /**
      * Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of
      * custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.ExecuteFunction({
+     *   "FunctionName": "LevelCompleted",
+     *   "FunctionParameter": {
+     *     "level": 3,
+     *     "points": 400
+     *   },
+     *   "GeneratePlayStreamEvent": true,
+     *   "Entity": {
+     *     "Id": "aaa",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     ExecuteFunction(request: ExecuteFunctionRequest, extraHeaders?: Record<string, string>): Promise<ExecuteFunctionResult>;
     /**
      * Gets registered Azure Functions for a given title id and function name.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.GetFunction({
+     *   "FunctionName": "LevelCompleted"
+     * });
      */
     GetFunction(request: GetFunctionRequest, extraHeaders?: Record<string, string>): Promise<GetFunctionResult>;
     /**
      * Lists all currently registered Event Hub triggered Azure Functions for a given title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listeventhubfunctions Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.ListEventHubFunctions({});
      */
     ListEventHubFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListEventHubFunctionsResult>;
     /**
      * Lists all currently registered Azure Functions for a given title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.ListFunctions({});
      */
     ListFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListFunctionsResult>;
     /**
      * Lists all currently registered HTTP triggered Azure Functions for a given title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.ListHttpFunctions({});
      */
     ListHttpFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListHttpFunctionsResult>;
     /**
      * Lists all currently registered Queue triggered Azure Functions for a given title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.ListQueuedFunctions({});
      */
     ListQueuedFunctions(request: ListFunctionsRequest, extraHeaders?: Record<string, string>): Promise<ListQueuedFunctionsResult>;
     /**
      * Generate an entity PlayStream event for the provided function result.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.PostFunctionResultForEntityTriggeredAction({
+     *   "FunctionResult": {
+     *     "ExecutionTimeMilliseconds": 367,
+     *     "FunctionName": "LevelCompleted",
+     *     "FunctionResult": {
+     *       "newScore": 25,
+     *       "isWinner": false
+     *     }
+     *   },
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     PostFunctionResultForEntityTriggeredAction(request: PostFunctionResultForEntityTriggeredActionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Generate an entity PlayStream event for the provided function result.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.PostFunctionResultForFunctionExecution({
+     *   "FunctionResult": {
+     *     "ExecutionTimeMilliseconds": 367,
+     *     "FunctionName": "LevelCompleted",
+     *     "FunctionResult": {
+     *       "newScore": 25,
+     *       "isWinner": false
+     *     }
+     *   },
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     PostFunctionResultForFunctionExecution(request: PostFunctionResultForFunctionExecutionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Generate a player PlayStream event for the provided function result.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.PostFunctionResultForPlayerTriggeredAction({
+     *   "PlayStreamEventEnvelope": {
+     *     "EntityId": "1234ABCD",
+     *     "EntityType": "title_player_account",
+     *     "EventName": "player_logged_in",
+     *     "EventNamespace": "com.playfab",
+     *     "EventData": "someeventdata",
+     *     "EventSettings": "someeventsettings",
+     *     "EventToBeDropped": false
+     *   },
+     *   "PlayerProfile": {
+     *     "TitleId": "FFFF",
+     *     "PlayerId": "1234ABCD",
+     *     "Created": "2019-02-11T20:23:05Z",
+     *     "LastLogin": "2020-02-11T20:23:05Z",
+     *     "DisplayName": "Gudge"
+     *   },
+     *   "FunctionResult": {
+     *     "ExecutionTimeMilliseconds": 367,
+     *     "FunctionName": "LevelCompleted",
+     *     "FunctionResult": {
+     *       "newScore": 25,
+     *       "isWinner": false
+     *     }
+     *   }
+     * });
      */
     PostFunctionResultForPlayerTriggeredAction(request: PostFunctionResultForPlayerTriggeredActionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Generate a PlayStream event for the provided function result.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.PostFunctionResultForScheduledTask({
+     *   "ScheduledTaskId": {
+     *     "Name": "MyTask",
+     *     "Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
+     *   },
+     *   "FunctionResult": {
+     *     "ExecutionTimeMilliseconds": 367,
+     *     "FunctionName": "LevelCompleted",
+     *     "FunctionResult": {
+     *       "newScore": 25,
+     *       "isWinner": false
+     *     }
+     *   }
+     * });
      */
     PostFunctionResultForScheduledTask(request: PostFunctionResultForScheduledTaskRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Registers an event hub triggered Azure Function with a title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registereventhubfunction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.RegisterEventHubFunction({
+     *   "EventHubName": "fn-eventhub",
+     *   "ConnectionString": "SampleConnectionString",
+     *   "FunctionName": "functionName"
+     * });
      */
     RegisterEventHubFunction(request: RegisterEventHubFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Registers an HTTP triggered Azure function with a title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.RegisterHttpFunction({
+     *   "FunctionUrl": "http://function.url",
+     *   "FunctionName": "functionName"
+     * });
      */
     RegisterHttpFunction(request: RegisterHttpFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Registers a queue triggered Azure Function with a title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.RegisterQueuedFunction({
+     *   "QueueName": "fn-queue",
+     *   "ConnectionString": "SampleConnectionString",
+     *   "FunctionName": "functionName"
+     * });
      */
     RegisterQueuedFunction(request: RegisterQueuedFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
     /**
      * Unregisters an Azure Function with a title.
-     * https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction Microsoft Documentation}
+     * @example
+     * await cloudscriptClient.UnregisterFunction({
+     *   "FunctionName": "functionName"
+     * });
      */
     UnregisterFunction(request: UnregisterFunctionRequest, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
 }

package/dist/CloudScript.js

@@ -1,7 +1,7 @@
 import {
   PlayFabCloudScriptApi
-} from "./chunk-UOHHNVCJ.js";
-import "./chunk-62SULWOK.js";
+} from "./chunk-SQWILU5T.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabCloudScriptApi as default
 };