@community-fabs/playfab-web-sdk 1.193.250606-1

package/dist/Economy.js

@@ -0,0 +1,8 @@
+import {
+  PlayFabEconomyApi
+} from "./chunk-YI4OQ74L.js";
+import "./chunk-6OZSERVG.js";
+export {
+  PlayFabEconomyApi as default
+};
+//# sourceMappingURL=Economy.js.map

package/dist/Economy.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/Events.d.ts

@@ -0,0 +1,494 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
+
+interface CreateTelemetryKeyRequest 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 new key. Telemetry key names must be unique within the scope of the title. */
+    KeyName: string;
+}
+interface CreateTelemetryKeyResponse extends IPlayFabResultCommon {
+    /** Details about the newly created telemetry key. */
+    NewKeyDetails?: TelemetryKeyDetails;
+}
+interface DataConnectionAzureBlobSettings {
+    /** Name of the storage account. */
+    AccountName?: string;
+    /** Name of the container. */
+    ContainerName?: string;
+    /** Azure Entra Tenant Id. */
+    TenantId?: string;
+}
+interface DataConnectionAzureDataExplorerSettings {
+    /** The URI of the ADX cluster. */
+    ClusterUri?: string;
+    /** The database to write to. */
+    Database?: string;
+    /** The table to write to. */
+    Table?: string;
+}
+interface DataConnectionDetails {
+    /** Settings of the data connection. */
+    ConnectionSettings: DataConnectionSettings;
+    /** Whether or not the connection is currently active. */
+    IsActive: boolean;
+    /** The name of the data connection. */
+    Name: string;
+    /** Current status of the data connection, if any. */
+    Status?: DataConnectionStatusDetails;
+    /** The type of data connection. */
+    Type: string;
+}
+interface DataConnectionFabricKQLSettings {
+    /** The URI of the Fabric cluster. */
+    ClusterUri?: string;
+    /** The database to write to. */
+    Database?: string;
+    /** The table to write to. */
+    Table?: string;
+}
+interface DataConnectionSettings {
+    /** Settings if the type of connection is AzureBlobStorage. */
+    AzureBlobSettings?: DataConnectionAzureBlobSettings;
+    /** Settings if the type of connection is AzureDataExplorer. */
+    AzureDataExplorerSettings?: DataConnectionAzureDataExplorerSettings;
+    /** Settings if the type of connection is FabricKQL. */
+    AzureFabricKQLSettings?: DataConnectionFabricKQLSettings;
+}
+interface DataConnectionStatusDetails {
+    /** The name of the error affecting the data connection, if any. */
+    Error?: string;
+    /** A description of the error affecting the data connection, if any. This may be empty for some errors. */
+    ErrorMessage?: string;
+    /** The most recent time of the error affecting the data connection, if any. */
+    MostRecentErrorTime?: string;
+    /** Indicates if the connection is in a normal state or error state. */
+    State?: string;
+}
+interface DeleteDataConnectionRequest 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 data connection to delete. */
+    Name: string;
+}
+interface DeleteDataConnectionResponse extends IPlayFabResultCommon {
+    /** Indicates whether or not the connection was deleted as part of the request. */
+    WasDeleted: boolean;
+}
+interface DeleteEventSamplingRatioRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+}
+interface DeleteEventSamplingRatioResult extends IPlayFabResultCommon {
+}
+interface DeleteTelemetryKeyRequest 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 key to delete. */
+    KeyName: string;
+}
+interface DeleteTelemetryKeyResponse extends IPlayFabResultCommon {
+    /** Indicates whether or not the key was deleted. If false, no key with that name existed. */
+    WasKeyDeleted: boolean;
+}
+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;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
+}
+interface EventContents {
+    /**
+     * The optional custom tags associated with the event (e.g. build number, external trace identifiers, etc.). Before an
+     * event is written, this collection and the base request custom tags will be merged, but not overriden. This enables the
+     * caller to specify static tags and per event tags.
+     */
+    CustomTags?: Record<string, string | null>;
+    /** Entity associated with the event. If null, the event will apply to the calling entity. */
+    Entity?: EntityKey;
+    /** The namespace in which the event is defined. Allowed namespaces can vary by API. */
+    EventNamespace: string;
+    /** The name of this event. */
+    Name: string;
+    /**
+     * The original unique identifier associated with this event before it was posted to PlayFab. The value might differ from
+     * the EventId value, which is assigned when the event is received by the server.
+     */
+    OriginalId?: string;
+    /**
+     * The time (in UTC) associated with this event when it occurred. If specified, this value is stored in the
+     * OriginalTimestamp property of the PlayStream event.
+     */
+    OriginalTimestamp?: string;
+    /** Arbitrary data associated with the event. Only one of Payload or PayloadJSON is allowed. */
+    Payload?: any;
+    /**
+     * Arbitrary data associated with the event, represented as a JSON serialized string. Only one of Payload or PayloadJSON is
+     * allowed.
+     */
+    PayloadJSON?: string;
+}
+interface EventSamplingRatio {
+    EventName?: string;
+    EventNamespace?: string;
+    Ratio: number;
+}
+interface GetDataConnectionRequest 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 data connection to retrieve. */
+    Name: string;
+}
+interface GetDataConnectionResponse extends IPlayFabResultCommon {
+    /** The details of the queried Data Connection. */
+    DataConnection?: DataConnectionDetails;
+}
+interface GetEventSamplingRatioRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+}
+interface GetEventSamplingRatioResult extends IPlayFabResultCommon {
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+    /** Sampling ratio of the event */
+    Ratio: number;
+}
+interface GetEventSamplingRatiosRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface GetEventSamplingRatiosResult extends IPlayFabResultCommon {
+    Ratios?: EventSamplingRatio[];
+}
+interface GetTelemetryKeyRequest 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 key to retrieve. */
+    KeyName: string;
+}
+interface GetTelemetryKeyResponse extends IPlayFabResultCommon {
+    /** Details about the requested telemetry key. */
+    KeyDetails?: TelemetryKeyDetails;
+}
+interface ListDataConnectionsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+}
+interface ListDataConnectionsResponse extends IPlayFabResultCommon {
+    /** The list of existing Data Connections. */
+    DataConnections?: DataConnectionDetails[];
+}
+interface ListTelemetryKeysRequest 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;
+}
+interface ListTelemetryKeysResponse extends IPlayFabResultCommon {
+    /** The telemetry keys configured for the title. */
+    KeyDetails?: TelemetryKeyDetails[];
+}
+interface SetDataConnectionActiveRequest extends IPlayFabRequestCommon {
+    /** Whether to set the data connection to active (true) or deactivated (false). */
+    Active: boolean;
+    /** 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 data connection to update. */
+    Name: string;
+}
+interface SetDataConnectionActiveResponse extends IPlayFabResultCommon {
+    /** The most current details about the data connection that was to be updated. */
+    DataConnection?: DataConnectionDetails;
+    /**
+     * Indicates whether or not the data connection was updated. If false, the data connection was already in the desired
+     * state.
+     */
+    WasUpdated: boolean;
+}
+interface SetDataConnectionRequest extends IPlayFabRequestCommon {
+    /** Settings of the data connection. */
+    ConnectionSettings: DataConnectionSettings;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Whether or not the connection is currently active. */
+    IsActive: boolean;
+    /** The name of the data connection to update or create. */
+    Name: string;
+    /** The type of data connection. */
+    Type: string;
+}
+interface SetDataConnectionResponse extends IPlayFabResultCommon {
+    /** The details of the Data Connection to be created or updated. */
+    DataConnection?: DataConnectionDetails;
+}
+interface SetEventSamplingRatioRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Name of the sampled event */
+    EventName: string;
+    /** Namespace of the sampled event */
+    EventNamespace: string;
+    /** Sampling ratio of the event */
+    Ratio: number;
+}
+interface SetEventSamplingRatioResult extends IPlayFabResultCommon {
+}
+interface SetTelemetryKeyActiveRequest extends IPlayFabRequestCommon {
+    /** Whether to set the key to active (true) or deactivated (false). */
+    Active: boolean;
+    /** 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 key to update. */
+    KeyName: string;
+}
+interface SetTelemetryKeyActiveResponse extends IPlayFabResultCommon {
+    /** The most current details about the telemetry key that was to be updated. */
+    KeyDetails?: TelemetryKeyDetails;
+    /** Indicates whether or not the key was updated. If false, the key was already in the desired state. */
+    WasKeyUpdated: boolean;
+}
+interface TelemetryKeyDetails {
+    /** When the key was created. */
+    CreateTime: string;
+    /** Whether or not the key is currently active. Deactivated keys cannot be used for telemetry ingestion. */
+    IsActive: boolean;
+    /** The key that can be distributed to clients for use during telemetry ingestion. */
+    KeyValue?: string;
+    /** When the key was last updated. */
+    LastUpdateTime: string;
+    /** The name of the key. Telemetry key names are unique within the scope of the title. */
+    Name?: string;
+}
+interface WriteEventsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The collection of events to write. Up to 200 events can be written per request. */
+    Events: EventContents[];
+}
+interface WriteEventsResponse extends IPlayFabResultCommon {
+    /**
+     * The unique identifiers assigned by the server to the events, in the same order as the events in the request. Only
+     * returned if FlushToPlayStream option is true.
+     */
+    AssignedEventIds?: string[];
+}
+
+declare class PlayFabEventsApi extends PlayFabCommon {
+    /**
+     * Creates a new telemetry key for the title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/createtelemetrykey Microsoft Documentation}
+     * @example
+     * await eventClient.CreateTelemetryKey({
+     *   "KeyName": "MyTelemetryKey"
+     * });
+     */
+    CreateTelemetryKey(request: CreateTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<CreateTelemetryKeyResponse>;
+    /**
+     * Deletes a Data Connection from a title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/deletedataconnection Microsoft Documentation}
+     * @example
+     * await eventClient.DeleteDataConnection({
+     *   "Name": "MyDataConnection"
+     * });
+     */
+    DeleteDataConnection(request: DeleteDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<DeleteDataConnectionResponse>;
+    /**
+     * Deletes the sampling ratio for an event.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/deleteeventsamplingratio Microsoft Documentation}
+     */
+    DeleteEventSamplingRatio(request: DeleteEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<DeleteEventSamplingRatioResult>;
+    /**
+     * Deletes a telemetry key configured for the title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/deletetelemetrykey Microsoft Documentation}
+     * @example
+     * await eventClient.DeleteTelemetryKey({
+     *   "KeyName": "MyTelemetryKey"
+     * });
+     */
+    DeleteTelemetryKey(request: DeleteTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<DeleteTelemetryKeyResponse>;
+    /**
+     * Retrieves a single Data Connection associated with a title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/getdataconnection Microsoft Documentation}
+     * @example
+     * await eventClient.GetDataConnection({
+     *   "Name": "MyDataConnection"
+     * });
+     */
+    GetDataConnection(request: GetDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<GetDataConnectionResponse>;
+    /**
+     * Gets the sampling ratio for an event.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/geteventsamplingratio Microsoft Documentation}
+     * @example
+     * await eventClient.GetEventSamplingRatio({
+     *   "EventNamespace": "com.playfab",
+     *   "EventName": "player_executed_cloudscript"
+     * });
+     */
+    GetEventSamplingRatio(request: GetEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<GetEventSamplingRatioResult>;
+    /**
+     * Gets the event sampling ratios for a title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/geteventsamplingratios Microsoft Documentation}
+     */
+    GetEventSamplingRatios(request: GetEventSamplingRatiosRequest, extraHeaders?: Record<string, string>): Promise<GetEventSamplingRatiosResult>;
+    /**
+     * Gets information about a telemetry key configured for the title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/gettelemetrykey Microsoft Documentation}
+     * @example
+     * await eventClient.GetTelemetryKey({
+     *   "KeyName": "MyTelemetryKey"
+     * });
+     */
+    GetTelemetryKey(request: GetTelemetryKeyRequest, extraHeaders?: Record<string, string>): Promise<GetTelemetryKeyResponse>;
+    /**
+     * Retrieves the list of Data Connections associated with a title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/listdataconnections Microsoft Documentation}
+     * @example
+     * await eventClient.ListDataConnections({});
+     */
+    ListDataConnections(request: ListDataConnectionsRequest, extraHeaders?: Record<string, string>): Promise<ListDataConnectionsResponse>;
+    /**
+     * Lists all telemetry keys configured for the title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/listtelemetrykeys Microsoft Documentation}
+     * @example
+     * await eventClient.ListTelemetryKeys({});
+     */
+    ListTelemetryKeys(request: ListTelemetryKeysRequest, extraHeaders?: Record<string, string>): Promise<ListTelemetryKeysResponse>;
+    /**
+     * Creates or updates a Data Connection on a title.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/setdataconnection Microsoft Documentation}
+     * @example
+     * await eventClient.SetDataConnection({
+     *   "Name": "MyDataConnection",
+     *   "Type": "AzureDataExplorer",
+     *   "IsActive": true,
+     *   "ConnectionSettings": {
+     *     "AzureDataExplorerSettings": {
+     *       "ClusterUri": "https://myadxcluster.kusto.windows.net",
+     *       "Database": "MyDatabase",
+     *       "Table": "MyTable"
+     *     }
+     *   }
+     * });
+     */
+    SetDataConnection(request: SetDataConnectionRequest, extraHeaders?: Record<string, string>): Promise<SetDataConnectionResponse>;
+    /**
+     * Sets a Data Connection for the title to either the active or deactivated state.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/setdataconnectionactive Microsoft Documentation}
+     * @example
+     * await eventClient.SetDataConnectionActive({
+     *   "Name": "MyDataConnection",
+     *   "Active": false
+     * });
+     */
+    SetDataConnectionActive(request: SetDataConnectionActiveRequest, extraHeaders?: Record<string, string>): Promise<SetDataConnectionActiveResponse>;
+    /**
+     * Sets the sampling ratio for an event.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream/seteventsamplingratio Microsoft Documentation}
+     */
+    SetEventSamplingRatio(request: SetEventSamplingRatioRequest, extraHeaders?: Record<string, string>): Promise<SetEventSamplingRatioResult>;
+    /**
+     * Sets a telemetry key to the active or deactivated state.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/settelemetrykeyactive Microsoft Documentation}
+     * @example
+     * await eventClient.SetTelemetryKeyActive({
+     *   "KeyName": "MyTelemetryKey",
+     *   "Active": false
+     * });
+     */
+    SetTelemetryKeyActive(request: SetTelemetryKeyActiveRequest, extraHeaders?: Record<string, string>): Promise<SetTelemetryKeyActiveResponse>;
+    /**
+     * Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/writeevents Microsoft Documentation}
+     * @example
+     * await eventClient.WriteEvents({
+     *   "Events": [
+     *     {
+     *       "Entity": {
+     *         "Id": "A8140AB9109712B",
+     *         "Type": "title",
+     *         "TypeString": "title"
+     *       },
+     *       "EventNamespace": "com.playfab.events.example",
+     *       "Name": "something_happened",
+     *       "Payload": {
+     *         "Foo": "Bar",
+     *         "Nums": [
+     *           1,
+     *           2,
+     *           3
+     *         ]
+     *       }
+     *     }
+     *   ]
+     * });
+     */
+    WriteEvents(request: WriteEventsRequest, extraHeaders?: Record<string, string>): Promise<WriteEventsResponse>;
+    /**
+     * Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start
+     * with 'custom.'
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/event/playstream-events/writetelemetryevents Microsoft Documentation}
+     * @example
+     * await eventClient.WriteTelemetryEvents({
+     *   "Events": [
+     *     {
+     *       "Entity": {
+     *         "Id": "A8140AB9109712B",
+     *         "Type": "title",
+     *         "TypeString": "title"
+     *       },
+     *       "EventNamespace": "com.playfab.events.example",
+     *       "Name": "something_happened",
+     *       "Payload": {
+     *         "Foo": "Bar",
+     *         "Nums": [
+     *           1,
+     *           2,
+     *           3
+     *         ]
+     *       }
+     *     }
+     *   ]
+     * });
+     */
+    WriteTelemetryEvents(request: WriteEventsRequest, extraHeaders?: Record<string, string>): Promise<WriteEventsResponse>;
+}
+
+export { PlayFabEventsApi as default };

package/dist/Events.js

@@ -0,0 +1,8 @@
+import {
+  PlayFabEventsApi
+} from "./chunk-RVBFE5D5.js";
+import "./chunk-6OZSERVG.js";
+export {
+  PlayFabEventsApi as default
+};
+//# sourceMappingURL=Events.js.map

package/dist/Events.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}