async-playfab-web-sdk 1.192.250526-1

package/dist/CloudScript.d.ts

@@ -0,0 +1,511 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-BUv4zqXf.js';
+
+interface AdCampaignAttributionModel {
+    /** UTC time stamp of attribution */
+    AttributedAt: string;
+    /** Attribution campaign identifier */
+    CampaignId?: string;
+    /** Attribution network name */
+    Platform?: string;
+}
+interface ContactEmailInfoModel {
+    /** The email address */
+    EmailAddress?: string;
+    /** The name of the email info data */
+    Name?: string;
+    /** The verification status of the email */
+    VerificationStatus?: string;
+}
+interface EmptyResult extends IPlayFabResultCommon {
+}
+interface EntityKey {
+    /** Unique ID of the entity. */
+    Id: string;
+    /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
+    Type?: string;
+}
+interface EventHubFunctionModel {
+    /** The connection string for the event hub. */
+    ConnectionString?: string;
+    /** The name of the event hub that triggers the Azure Function. */
+    EventHubName?: string;
+    /** The name the function was registered under. */
+    FunctionName?: string;
+}
+interface ExecuteCloudScriptResult extends IPlayFabResultCommon {
+    /** Number of PlayFab API requests issued by the CloudScript function */
+    APIRequestsIssued: number;
+    /** Information about the error, if any, that occurred during execution */
+    Error?: ScriptExecutionError;
+    ExecutionTimeSeconds: number;
+    /** The name of the function that executed */
+    FunctionName?: string;
+    /** The object returned from the CloudScript function, if any */
+    FunctionResult?: any;
+    /**
+     * Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if
+     * the total event size is larger than 350KB.
+     */
+    FunctionResultTooLarge?: boolean;
+    /** Number of external HTTP requests issued by the CloudScript function */
+    HttpRequestsIssued: number;
+    /**
+     * Entries logged during the function execution. These include both entries logged in the function code using log.info()
+     * and log.error() and error entries for API and HTTP request failures.
+     */
+    Logs?: LogStatement[];
+    /**
+     * Flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total
+     * event size is larger than 350KB after the FunctionResult was removed.
+     */
+    LogsTooLarge?: boolean;
+    MemoryConsumedBytes: number;
+    /**
+     * Processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP
+     * requests.
+     */
+    ProcessorTimeSeconds: number;
+    /** The revision of the CloudScript that executed */
+    Revision: number;
+}
+interface ExecuteEntityCloudScriptRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The name of the CloudScript function to execute */
+    FunctionName: string;
+    /** 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
+     * 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'.
+     */
+    RevisionSelection?: string;
+    /** The specific revision to execute, when RevisionSelection is set to 'Specific' */
+    SpecificRevision?: number;
+}
+interface ExecuteFunctionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The name of the CloudScript function to execute */
+    FunctionName: string;
+    /** 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
+     * other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
+     */
+    GeneratePlayStreamEvent?: boolean;
+}
+interface ExecuteFunctionResult extends IPlayFabResultCommon {
+    /** 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 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;
+}
+interface FunctionModel {
+    /** The address of the function. */
+    FunctionAddress?: string;
+    /** The name the function was registered under. */
+    FunctionName?: string;
+    /** The trigger type for the function. */
+    TriggerType?: string;
+}
+interface GetFunctionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the function to register */
+    FunctionName: string;
+}
+interface GetFunctionResult extends IPlayFabResultCommon {
+    /** The connection string for the storage account containing the queue for a queue trigger Azure Function. */
+    ConnectionString?: string;
+    /** The URL to be invoked to execute an HTTP triggered function. */
+    FunctionUrl?: string;
+    /** The name of the queue for a queue trigger Azure Function. */
+    QueueName?: string;
+    /** The trigger type for the function. */
+    TriggerType?: string;
+}
+interface HttpFunctionModel {
+    /** The name the function was registered under. */
+    FunctionName?: string;
+    /** The URL of the function. */
+    FunctionUrl?: string;
+}
+interface LinkedPlatformAccountModel {
+    /** Linked account email of the user on the platform, if available */
+    Email?: string;
+    /** Authentication platform */
+    Platform?: string;
+    /** Unique account identifier of the user on the platform */
+    PlatformUserId?: string;
+    /** Linked account username of the user on the platform, if available */
+    Username?: string;
+}
+interface ListEventHubFunctionsResult extends IPlayFabResultCommon {
+    /** The list of EventHub triggered functions that are currently registered for the title. */
+    Functions?: EventHubFunctionModel[];
+}
+interface ListFunctionsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface ListFunctionsResult extends IPlayFabResultCommon {
+    /** The list of functions that are currently registered for the title. */
+    Functions?: FunctionModel[];
+}
+interface ListHttpFunctionsResult extends IPlayFabResultCommon {
+    /** The list of HTTP triggered functions that are currently registered for the title. */
+    Functions?: HttpFunctionModel[];
+}
+interface ListQueuedFunctionsResult extends IPlayFabResultCommon {
+    /** The list of Queue triggered functions that are currently registered for the title. */
+    Functions?: QueuedFunctionModel[];
+}
+interface LocationModel {
+    /** City name. */
+    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 geographic location. */
+    Latitude?: number;
+    /** Longitude coordinate of the geographic location. */
+    Longitude?: number;
+}
+interface LogStatement {
+    /** Optional object accompanying the message as contextual information */
+    Data?: any;
+    /** 'Debug', 'Info', or 'Error' */
+    Level?: string;
+    Message?: string;
+}
+interface MembershipModel {
+    /** Whether this membership is active. That is, whether the MembershipExpiration time has been reached. */
+    IsActive: boolean;
+    /** The time this membership expires */
+    MembershipExpiration: string;
+    /** The id of the membership */
+    MembershipId?: string;
+    /**
+     * Membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been
+     * overridden, this will be the new expiration time.
+     */
+    OverrideExpiration?: string;
+    /** The list of subscriptions that this player has for this membership */
+    Subscriptions?: SubscriptionModel[];
+}
+interface NameIdentifier {
+    /** Id Identifier, if present */
+    Id?: string;
+    /** Name Identifier, if present */
+    Name?: string;
+}
+interface PlayerProfileModel {
+    /** List of advertising campaigns the player has been attributed to */
+    AdCampaignAttributions?: AdCampaignAttributionModel[];
+    /** URL of the player's avatar image */
+    AvatarUrl?: string;
+    /** If the player is currently banned, the UTC Date when the ban expires */
+    BannedUntil?: string;
+    /** List of all contact email info associated with the player account */
+    ContactEmailAddresses?: ContactEmailInfoModel[];
+    /** Player record created */
+    Created?: string;
+    /** Player display name */
+    DisplayName?: string;
+    /**
+     * List of experiment variants for the player. Note that these variants are not guaranteed to be up-to-date when returned
+     * during login because the player profile is updated only after login. Instead, use the LoginResult.TreatmentAssignment
+     * property during login to get the correct variants and variables.
+     */
+    ExperimentVariants?: string[];
+    /** UTC time when the player most recently logged in to the title */
+    LastLogin?: string;
+    /** List of all authentication systems linked to this player account */
+    LinkedAccounts?: LinkedPlatformAccountModel[];
+    /** List of geographic locations from which the player has logged in to the title */
+    Locations?: LocationModel[];
+    /** List of memberships for the player, along with whether are expired. */
+    Memberships?: MembershipModel[];
+    /** Player account origination */
+    Origination?: string;
+    /** PlayFab player account unique identifier */
+    PlayerId?: string;
+    /** Publisher this player belongs to */
+    PublisherId?: string;
+    /** List of configured end points registered for sending the player push notifications */
+    PushNotificationRegistrations?: PushNotificationRegistrationModel[];
+    /** List of leaderboard statistic values for the player */
+    Statistics?: StatisticModel[];
+    /** 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
+     * 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 */
+    ValuesToDate?: ValueToDateModel[];
+}
+interface PlayStreamEventEnvelopeModel {
+    /** The ID of the entity the event is about. */
+    EntityId?: string;
+    /** The type of the entity the event is about. */
+    EntityType?: string;
+    /** Data specific to this event. */
+    EventData?: string;
+    /** The name of the event. */
+    EventName?: string;
+    /** The namespace of the event. */
+    EventNamespace?: string;
+    /** Settings for the event. */
+    EventSettings?: string;
+}
+interface PostFunctionResultForEntityTriggeredActionRequest 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. */
+    Entity: EntityKey;
+    /** The result of the function execution. */
+    FunctionResult: ExecuteFunctionResult;
+}
+interface PostFunctionResultForFunctionExecutionRequest 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. */
+    Entity: EntityKey;
+    /** The result of the function execution. */
+    FunctionResult: ExecuteFunctionResult;
+}
+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 result of the function execution. */
+    FunctionResult: ExecuteFunctionResult;
+    /** The player profile the function was invoked with. */
+    PlayerProfile: PlayerProfileModel;
+    /** The triggering PlayStream event, if any, that caused the function to be invoked. */
+    PlayStreamEventEnvelope?: PlayStreamEventEnvelopeModel;
+}
+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 result of the function execution */
+    FunctionResult: ExecuteFunctionResult;
+    /** The id of the scheduled task that invoked the function. */
+    ScheduledTaskId: NameIdentifier;
+}
+interface PushNotificationRegistrationModel {
+    /** Notification configured endpoint */
+    NotificationEndpointARN?: string;
+    /** Push notification platform */
+    Platform?: string;
+}
+interface QueuedFunctionModel {
+    /** The connection string for the Azure Storage Account that hosts the queue. */
+    ConnectionString?: string;
+    /** The name the function was registered under. */
+    FunctionName?: string;
+    /** The name of the queue that triggers the Azure Function. */
+    QueueName?: string;
+}
+interface RegisterEventHubFunctionRequest extends IPlayFabRequestCommon {
+    /** A connection string for the namespace of the event hub for the Azure Function. */
+    ConnectionString: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the event hub for the Azure Function. */
+    EventHubName: string;
+    /** The name of the function to register */
+    FunctionName: string;
+}
+interface RegisterHttpFunctionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the function to register */
+    FunctionName: string;
+    /** Full URL for Azure Function that implements the function. */
+    FunctionUrl: string;
+}
+interface RegisterQueuedFunctionRequest extends IPlayFabRequestCommon {
+    /** A connection string for the storage account that hosts the queue for the Azure Function. */
+    ConnectionString: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the function to register */
+    FunctionName: string;
+    /** The name of the queue for the Azure Function. */
+    QueueName: string;
+}
+interface ScriptExecutionError {
+    /**
+     * Error code, such as CloudScriptNotFound, JavascriptException, CloudScriptFunctionArgumentSizeExceeded,
+     * CloudScriptAPIRequestCountExceeded, CloudScriptAPIRequestError, or CloudScriptHTTPRequestError
+     */
+    Error?: string;
+    /** Details about the error */
+    Message?: string;
+    /** Point during the execution of the script at which the error occurred, if any */
+    StackTrace?: string;
+}
+interface StatisticModel {
+    /** Statistic name */
+    Name?: string;
+    /** Statistic value */
+    Value: number;
+    /** Statistic version (0 if not a versioned statistic) */
+    Version: number;
+}
+interface SubscriptionModel {
+    /** When this subscription expires. */
+    Expiration: string;
+    /** The time the subscription was orignially purchased */
+    InitialSubscriptionTime: string;
+    /** Whether this subscription is currently active. That is, if Expiration > now. */
+    IsActive: boolean;
+    /** The status of this subscription, according to the subscription provider. */
+    Status?: string;
+    /** The id for this subscription */
+    SubscriptionId?: string;
+    /** The item id for this subscription from the primary catalog */
+    SubscriptionItemId?: string;
+    /** The provider for this subscription. Apple or Google Play are supported today. */
+    SubscriptionProvider?: string;
+}
+interface TagModel {
+    /** Full value of the tag, including namespace */
+    TagValue?: string;
+}
+interface UnregisterFunctionRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The name of the function to register */
+    FunctionName: string;
+}
+interface ValueToDateModel {
+    /** ISO 4217 code of the currency used in the purchases */
+    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')
+     */
+    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'.
+     */
+    TotalValueAsDecimal?: string;
+}
+
+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
+     */
+    ExecuteEntityCloudScript(request: ExecuteEntityCloudScriptRequest, customData?: any, 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
+     */
+    ExecuteFunction(request: ExecuteFunctionRequest, customData?: any, 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
+     */
+    GetFunction(request: GetFunctionRequest, customData?: any, 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
+     */
+    ListEventHubFunctions(request: ListFunctionsRequest, customData?: any, 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
+     */
+    ListFunctions(request: ListFunctionsRequest, customData?: any, 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
+     */
+    ListHttpFunctions(request: ListFunctionsRequest, customData?: any, 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
+     */
+    ListQueuedFunctions(request: ListFunctionsRequest, customData?: any, 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
+     */
+    PostFunctionResultForEntityTriggeredAction(request: PostFunctionResultForEntityTriggeredActionRequest, customData?: any, 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
+     */
+    PostFunctionResultForFunctionExecution(request: PostFunctionResultForFunctionExecutionRequest, customData?: any, 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
+     */
+    PostFunctionResultForPlayerTriggeredAction(request: PostFunctionResultForPlayerTriggeredActionRequest, customData?: any, 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
+     */
+    PostFunctionResultForScheduledTask(request: PostFunctionResultForScheduledTaskRequest, customData?: any, 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
+     */
+    RegisterEventHubFunction(request: RegisterEventHubFunctionRequest, customData?: any, 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
+     */
+    RegisterHttpFunction(request: RegisterHttpFunctionRequest, customData?: any, 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
+     */
+    RegisterQueuedFunction(request: RegisterQueuedFunctionRequest, customData?: any, 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
+     */
+    UnregisterFunction(request: UnregisterFunctionRequest, customData?: any, extraHeaders?: Record<string, string>): Promise<EmptyResult>;
+}
+
+export { PlayFabCloudScriptApi as default };