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

package/dist/Data.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 AbortFileUploadsRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -8,7 +8,7 @@ interface AbortFileUploadsRequest extends IPlayFabRequestCommon {
     /** Names of the files to have their pending uploads aborted. */
     FileNames: string[];
     /**
-     * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
+     * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
      * be performed.
      */
     ProfileVersion?: number;
@@ -27,7 +27,7 @@ interface DeleteFilesRequest extends IPlayFabRequestCommon {
     /** Names of the files to be deleted. */
     FileNames: string[];
     /**
-     * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
+     * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
      * be performed.
      */
     ProfileVersion?: number;
@@ -43,13 +43,18 @@ 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 FinalizeFileUploadsRequest 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;
-    /** Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
+    /** Names of the files to be finalized. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
     FileNames: string[];
     /** The current version of the profile, can be used for concurrency control during updates. */
     ProfileVersion: number;
@@ -57,7 +62,7 @@ interface FinalizeFileUploadsRequest extends IPlayFabRequestCommon {
 interface FinalizeFileUploadsResponse extends IPlayFabResultCommon {
     /** The entity id and type. */
     Entity?: EntityKey;
-    /** Collection of metadata for the entity's files */
+    /** Collection of metadata for the entity&#39;s files */
     Metadata?: Record<string, GetFileMetadata>;
     /** The current version of the profile, can be used for concurrency control during updates. */
     ProfileVersion: number;
@@ -71,7 +76,7 @@ interface GetFileMetadata {
     FileName?: string;
     /** Last UTC time the file was modified */
     LastModified: string;
-    /** Storage service's reported byte count */
+    /** Storage service&#39;s reported byte count */
     Size: number;
 }
 interface GetFilesRequest extends IPlayFabRequestCommon {
@@ -83,7 +88,7 @@ interface GetFilesRequest extends IPlayFabRequestCommon {
 interface GetFilesResponse extends IPlayFabResultCommon {
     /** The entity id and type. */
     Entity?: EntityKey;
-    /** Collection of metadata for the entity's files */
+    /** Collection of metadata for the entity&#39;s files */
     Metadata?: Record<string, GetFileMetadata>;
     /** The current version of the profile, can be used for concurrency control during updates. */
     ProfileVersion: number;
@@ -118,10 +123,10 @@ interface InitiateFileUploadsRequest extends IPlayFabRequestCommon {
     CustomTags?: Record<string, string | null>;
     /** The entity to perform this action on. */
     Entity: EntityKey;
-    /** Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
+    /** Names of the files to be set. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
     FileNames: string[];
     /**
-     * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not
+     * The expected version of the profile, if set and doesn&#39;t match the current version of the profile the operation will not
      * be performed.
      */
     ProfileVersion?: number;
@@ -139,7 +144,7 @@ interface ObjectResult {
     DataObject?: any;
     /** Escaped string JSON body of the object, if EscapeObject is true. */
     EscapedDataObject?: string;
-    /** Name of the object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */
+    /** Name of the object. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
     ObjectName?: string;
 }
 interface SetObject {
@@ -155,7 +160,7 @@ interface SetObject {
      * exists, or no operation will occur if it does not exist. Only one of DataObject or EscapedDataObject fields may be used.
      */
     EscapedDataObject?: string;
-    /** Name of object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */
+    /** Name of object. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39;. */
     ObjectName: string;
 }
 interface SetObjectInfo {
@@ -190,37 +195,151 @@ interface SetObjectsResponse extends IPlayFabResultCommon {
 declare class PlayFabDataApi extends PlayFabCommon {
     /**
      * Abort pending file uploads to an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/file/abortfileuploads
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/abortfileuploads Microsoft Documentation}
+     * @example
+     * await fileClient.AbortFileUploads({
+     *   "FileNames": [
+     *     "avatar",
+     *     "game_state"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     AbortFileUploads(request: AbortFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<AbortFileUploadsResponse>;
     /**
      * Delete files on an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/file/deletefiles
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/deletefiles Microsoft Documentation}
+     * @example
+     * await fileClient.DeleteFiles({
+     *   "FileNames": [
+     *     "game_state",
+     *     "avatar"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     DeleteFiles(request: DeleteFilesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFilesResponse>;
     /**
      * Finalize file uploads to an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/file/finalizefileuploads
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/finalizefileuploads Microsoft Documentation}
+     * @example
+     * await fileClient.FinalizeFileUploads({
+     *   "ProfileVersion": 0,
+     *   "FileNames": [
+     *     "avatar",
+     *     "game_state"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     FinalizeFileUploads(request: FinalizeFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<FinalizeFileUploadsResponse>;
     /**
      * Retrieves file metadata from an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/file/getfiles
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/getfiles Microsoft Documentation}
+     * @example
+     * await fileClient.GetFiles({
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     GetFiles(request: GetFilesRequest, extraHeaders?: Record<string, string>): Promise<GetFilesResponse>;
     /**
      * Retrieves objects from an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/object/getobjects
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/object/object/getobjects Microsoft Documentation}
+     * @example
+     * await objectClient.GetObjects({
+     *   "Entity": {
+     *     "Id": "ABC90712ABC",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     GetObjects(request: GetObjectsRequest, extraHeaders?: Record<string, string>): Promise<GetObjectsResponse>;
     /**
      * Initiates file uploads to an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/file/initiatefileuploads
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/initiatefileuploads Microsoft Documentation}
+     * @example
+     * await fileClient.InitiateFileUploads({
+     *   "FileNames": [
+     *     "avatar",
+     *     "game_state"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     InitiateFileUploads(request: InitiateFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<InitiateFileUploadsResponse>;
     /**
      * Sets objects on an entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/data/object/setobjects
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/object/object/setobjects Microsoft Documentation}
+     * @example
+     * await objectClient.SetObjects({
+     *   "ExpectedProfileVersion": 5,
+     *   "Objects": [
+     *     {
+     *       "ObjectName": "SaveSate",
+     *       "DataObject": {
+     *         "PlayerDetails": {
+     *           "LastMissionSuccess": "2017-06-15T11:05:19Z",
+     *           "LastMissionFailure": "2017-06-12T11:05:19Z",
+     *           "MapPosition": [
+     *             22.0,
+     *             37.78
+     *           ],
+     *           "IsPaidUpgrade": true
+     *         },
+     *         "GameSettings": {
+     *           "Screen": "FriendsList",
+     *           "Favorites": [
+     *             "Place 1",
+     *             "Place 2"
+     *           ]
+     *         }
+     *       },
+     *       "SimpleStatements": {
+     *         "Read": [
+     *           {
+     *             "Friend": true
+     *           }
+     *         ],
+     *         "Write": [
+     *           "Self"
+     *         ]
+     *       }
+     *     }
+     *   ],
+     *   "Entity": {
+     *     "Id": "A8140AB9109712B",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     SetObjects(request: SetObjectsRequest, extraHeaders?: Record<string, string>): Promise<SetObjectsResponse>;
 }

package/dist/Data.js

@@ -1,7 +1,7 @@
 import {
   PlayFabDataApi
-} from "./chunk-UX7LFJCX.js";
-import "./chunk-62SULWOK.js";
+} from "./chunk-ADHTNFTN.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabDataApi as default
 };