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

package/dist/Multiplayer.js

@@ -1,7 +1,7 @@
 import {
   PlayFabMultiplayerApi
-} from "./chunk-BX65UND2.js";
-import "./chunk-62SULWOK.js";
+} from "./chunk-PFXZB4UN.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabMultiplayerApi as default
 };

package/dist/{PlayFabCommon-BX3jSqGx.d.ts → PlayFabCommon-Dnp_xHg5.d.ts}

@@ -8,7 +8,6 @@ interface IPlayFabError {
     errorMessage: string;
     errorDetails?: Record<string, string[]>;
     request?: any;
-    customData?: any;
     retryAfterSeconds?: number;
 }
 interface IPlayFabResultCommon extends IPlayFabError {
@@ -42,9 +41,6 @@ declare class PlayFabCommon {
         readonly sdk: string;
     };
     errorTitleId: string;
-    errorLoggedIn: string;
-    errorEntityToken: string;
-    errorSecretKey: string;
     private _context;
     constructor(settings?: Partial<ISettings> | undefined);
     get settings(): ISettings;
@@ -55,7 +51,9 @@ declare class PlayFabCommon {
     set entityToken(value: string | null);
     GetServerUrl(): string;
     InjectHeaders(xhr: XMLHttpRequest, headersObj: Record<string, string> | undefined): void;
-    ExecuteRequest<T extends IPlayFabResultCommon>(url: string, body: any, authkey: string | null, authValue: string | null, extraHeaders?: Record<string, string>): Promise<T>;
+    ExecuteRequest<T extends IPlayFabResultCommon>(url: string, body: any, authkey: string | null, authValue: string | null, extraHeaders?: Record<string, string>): Promise<{
+        data: T;
+    }>;
     UpdateAuthenticationContext(currentAuthContext: AuthContext, result: any): AuthContext;
     GetAuthInfo(request: any, authKey: string): {
         authKey: string;

package/dist/Profiles.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 EntityDataObject {
     /** Un-escaped JSON object, if DataAsObject is true. */
@@ -13,6 +13,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 EntityLineage {
     /** The Character Id of the associated entity. */
@@ -29,7 +34,7 @@ interface EntityLineage {
     TitlePlayerAccountId?: string;
 }
 interface EntityPermissionStatement {
-    /** The action this statement effects. May be 'Read', 'Write' or '*' for both read and write. */
+    /** The action this statement effects. May be 'Read', 'Write' or '*' for both read and write. */
     Action: string;
     /** A comment about the statement. Intended solely for bookkeeping and debugging. */
     Comment?: string;
@@ -39,7 +44,7 @@ interface EntityPermissionStatement {
     Effect: string;
     /** The principal this statement will effect. */
     Principal: any;
-    /** The resource this statements effects. Similar to 'pfrn:data--title![Title ID]/Profile/*' */
+    /** The resource this statements effects. Similar to 'pfrn:data--title![Title ID]/Profile/*' */
     Resource: string;
 }
 interface EntityProfileBody {
@@ -49,7 +54,7 @@ interface EntityProfileBody {
     Created: string;
     /**
      * The display name of the entity. This field may serve different purposes for different entity types. i.e.: for a title
-     * player account it could represent the display name of the player, whereas on a character it could be character's name.
+     * player account it could represent the display name of the player, whereas on a character it could be character's name.
      */
     DisplayName?: string;
     /** The entity id and type. */
@@ -86,7 +91,7 @@ interface EntityProfileFileMetadata {
     FileName?: string;
     /** Last UTC time the file was modified */
     LastModified: string;
-    /** Storage service's reported byte count */
+    /** Storage service's reported byte count */
     Size: number;
 }
 interface EntityStatisticValue {
@@ -156,7 +161,7 @@ interface GetTitlePlayersFromMasterPlayerAccountIdsResponse extends IPlayFabResu
 interface GetTitlePlayersFromProviderIDsResponse extends IPlayFabResultCommon {
     /**
      * Dictionary of provider identifiers mapped to title_player_account lineage. Missing lineage indicates the player either
-     * doesn't exist or doesn't play the requested title.
+     * doesn't exist or doesn't play the requested title.
      */
     TitlePlayerAccounts?: Record<string, EntityLineage>;
 }
@@ -170,10 +175,30 @@ interface GetTitlePlayersFromXboxLiveIDsRequest extends IPlayFabRequestCommon {
     /** List of Xbox Live XUIDs */
     XboxLiveIds: string[];
 }
+interface SetAvatarUrlRequest extends IPlayFabRequestCommon {
+    /** URL of the avatar image. If empty, it removes the existing avatar URL */
+    AvatarUrl: string;
+    /** 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 expected version of the profile to perform this update on */
+    ProfileVersion?: number;
+}
+interface SetAvatarUrlResponse extends IPlayFabResultCommon {
+    /** 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 type of operation that occurred on the profile&#39;s avatar URL */
+    OperationResult?: string;
+    /** The updated version of the profile after the avatar URL update */
+    ProfileVersion?: number;
+}
 interface SetDisplayNameRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
-    /** The new value to be set on Entity Profile's display name */
+    /** The new value to be set on Entity Profile&#39;s display name */
     DisplayName?: string;
     /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
     Entity?: EntityKey;
@@ -181,7 +206,7 @@ interface SetDisplayNameRequest extends IPlayFabRequestCommon {
     ExpectedVersion?: number;
 }
 interface SetDisplayNameResponse extends IPlayFabResultCommon {
-    /** The type of operation that occured on the profile's display name */
+    /** The type of operation that occured on the profile&#39;s display name */
     OperationResult?: string;
     /** The updated version of the profile after the display name update */
     VersionNumber?: number;
@@ -216,11 +241,11 @@ interface SetProfileLanguageRequest extends IPlayFabRequestCommon {
     Entity?: EntityKey;
     /** The expected version of a profile to perform this update on */
     ExpectedVersion?: number;
-    /** The language to set on the given entity. Deletes the profile's language if passed in a null string. */
+    /** The language to set on the given entity. Deletes the profile&#39;s language if passed in a null string. */
     Language?: string;
 }
 interface SetProfileLanguageResponse extends IPlayFabResultCommon {
-    /** The type of operation that occured on the profile's language */
+    /** The type of operation that occured on the profile&#39;s language */
     OperationResult?: string;
     /** The updated version of the profile after the language update */
     VersionNumber?: number;
@@ -229,48 +254,167 @@ interface SetProfileLanguageResponse extends IPlayFabResultCommon {
 declare class PlayFabProfilesApi extends PlayFabCommon {
     /**
      * Gets the global title access policy
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/getglobalpolicy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getglobalpolicy Microsoft Documentation}
+     * @example
+     * await profileClient.GetGlobalPolicy({});
      */
     GetGlobalPolicy(request: GetGlobalPolicyRequest, extraHeaders?: Record<string, string>): Promise<GetGlobalPolicyResponse>;
     /**
      * Retrieves the entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/getprofile
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofile Microsoft Documentation}
+     * @example
+     * await profileClient.GetProfile({
+     *   "Entity": {
+     *     "Id": "1234567787392",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     GetProfile(request: GetEntityProfileRequest, extraHeaders?: Record<string, string>): Promise<GetEntityProfileResponse>;
     /**
      * Retrieves the entity's profile.
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/getprofiles
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofiles Microsoft Documentation}
+     * @example
+     * await profileClient.GetProfiles({
+     *   "Entities": [
+     *     {
+     *       "Id": "1234567787392",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     },
+     *     {
+     *       "Id": "42434567785265",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
      */
     GetProfiles(request: GetEntityProfilesRequest, extraHeaders?: Record<string, string>): Promise<GetEntityProfilesResponse>;
     /**
      * Retrieves the title player accounts associated with the given master player account.
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/gettitleplayersfrommasterplayeraccountids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfrommasterplayeraccountids Microsoft Documentation}
+     * @example
+     * await profileClient.GetTitlePlayersFromMasterPlayerAccountIds({
+     *   "MasterPlayerAccountIds": [
+     *     "1233455677"
+     *   ],
+     *   "TitleId": "abc123"
+     * });
      */
     GetTitlePlayersFromMasterPlayerAccountIds(request: GetTitlePlayersFromMasterPlayerAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePlayersFromMasterPlayerAccountIdsResponse>;
     /**
      * Retrieves the title player accounts associated with the given XUIDs.
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/gettitleplayersfromxboxliveids
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfromxboxliveids Microsoft Documentation}
+     * @example
+     * await profileClient.GetTitlePlayersFromXboxLiveIDs({
+     *   "XboxLiveIds": [
+     *     "1233455677"
+     *   ],
+     *   "Sandbox": "RETAIL"
+     * });
      */
     GetTitlePlayersFromXboxLiveIDs(request: GetTitlePlayersFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePlayersFromProviderIDsResponse>;
+    /**
+     * Update the avatar url of the entity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setavatarurl Microsoft Documentation}
+     * @example
+     * await profileClient.SetAvatarUrl({
+     *   "AvatarUrl": "https://test.com/image.png",
+     *   "ProfileVersion": 123,
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    SetAvatarUrl(request: SetAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<SetAvatarUrlResponse>;
     /**
      * Update the display name of the entity
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setdisplayname
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setdisplayname Microsoft Documentation}
+     * @example
+     * await profileClient.SetDisplayName({
+     *   "DisplayName": "My new display name",
+     *   "ExpectedVersion": 123,
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     SetDisplayName(request: SetDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<SetDisplayNameResponse>;
     /**
      * Sets the global title access policy
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setglobalpolicy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setglobalpolicy Microsoft Documentation}
+     * @example
+     * await profileClient.SetGlobalPolicy({
+     *   "Permissions": [
+     *     {
+     *       "Resource": "pfrn:data--title_player_account!90901000/Profile/SomethingCool",
+     *       "Action": "*",
+     *       "Effect": "Allow",
+     *       "Principal": {
+     *         "ChildOf": {
+     *           "EntityType": "[SELF]"
+     *         }
+     *       },
+     *       "Comment": "An example policy"
+     *     }
+     *   ]
+     * });
      */
     SetGlobalPolicy(request: SetGlobalPolicyRequest, extraHeaders?: Record<string, string>): Promise<SetGlobalPolicyResponse>;
     /**
      * Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account
      * language, Master Player Account language, and then title default language if the first two aren't set or supported.
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setprofilelanguage
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilelanguage Microsoft Documentation}
+     * @example
+     * await profileClient.SetProfileLanguage({
+     *   "Language": "en",
+     *   "ExpectedVersion": 123,
+     *   "Entity": {
+     *     "Id": "1234",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     SetProfileLanguage(request: SetProfileLanguageRequest, extraHeaders?: Record<string, string>): Promise<SetProfileLanguageResponse>;
     /**
      * Sets the profiles access policy
-     * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setprofilepolicy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilepolicy Microsoft Documentation}
+     * @example
+     * await profileClient.SetProfilePolicy({
+     *   "Statements": [
+     *     {
+     *       "Resource": "pfrn:data--*!*\/Profile/Files/avatar.png",
+     *       "Action": "Read",
+     *       "Effect": "Allow",
+     *       "Principal": {
+     *         "FriendOf": "true"
+     *       },
+     *       "Comment": "Allow my friends to read my avatar"
+     *     }
+     *   ],
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
      */
     SetProfilePolicy(request: SetEntityProfilePolicyRequest, extraHeaders?: Record<string, string>): Promise<SetEntityProfilePolicyResponse>;
 }

package/dist/Profiles.js

@@ -1,7 +1,7 @@
 import {
   PlayFabProfilesApi
-} from "./chunk-POMI7LEF.js";
-import "./chunk-62SULWOK.js";
+} from "./chunk-73SVDH45.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabProfilesApi as default
 };