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

package/dist/Addon.d.ts

@@ -69,12 +69,12 @@ interface CreateOrUpdateGoogleRequest extends IPlayFabRequestCommon {
     /** If an error should be returned if the addon already exists. */
     ErrorIfExists?: boolean;
     /**
-     * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
+     * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
      * Required if using Google Authentication.
      */
     OAuthClientID?: string;
     /**
-     * Google OAuth Client Secret obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
+     * Google OAuth Client Secret obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
      * Required if using Google Authentication.
      */
     OAuthClientSecret?: string;
@@ -102,7 +102,7 @@ interface CreateOrUpdateKongregateRequest extends IPlayFabRequestCommon {
 interface CreateOrUpdateKongregateResponse extends IPlayFabResultCommon {
 }
 interface CreateOrUpdateNintendoRequest extends IPlayFabRequestCommon {
-    /** Nintendo Switch Application ID, without the "0x" prefix. */
+    /** Nintendo Switch Application ID, without the "0x" prefix. */
     ApplicationID?: string;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -140,7 +140,7 @@ interface CreateOrUpdatePSNRequest extends IPlayFabRequestCommon {
 interface CreateOrUpdatePSNResponse extends IPlayFabResultCommon {
 }
 interface CreateOrUpdateSteamRequest extends IPlayFabRequestCommon {
-    /** Application ID obtained after setting up your app in Valve's developer portal. */
+    /** Application ID obtained after setting up your app in Valve&#39;s developer portal. */
     ApplicationId: string;
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -150,7 +150,7 @@ interface CreateOrUpdateSteamRequest extends IPlayFabRequestCommon {
     Entity?: EntityKey;
     /** If an error should be returned if the addon already exists. */
     ErrorIfExists?: boolean;
-    /** Sercet Key obtained after setting up your app in Valve's developer portal. */
+    /** Sercet Key obtained after setting up your app in Valve&#39;s developer portal. */
     SecretKey: string;
     /** Use Steam Payments sandbox endpoint for test transactions. */
     UseSandbox?: boolean;
@@ -272,6 +272,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 GetAppleRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -330,7 +335,7 @@ interface GetGoogleResponse extends IPlayFabResultCommon {
     /** Addon status. */
     Created: boolean;
     /**
-     * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
+     * Google OAuth Client ID obtained through the Google Developer Console by creating a new set of &quot;OAuth Client ID&quot;.
      * Required if using Google Authentication.
      */
     OAuthClientID?: string;
@@ -358,7 +363,7 @@ interface GetNintendoRequest extends IPlayFabRequestCommon {
     Entity?: EntityKey;
 }
 interface GetNintendoResponse extends IPlayFabResultCommon {
-    /** Nintendo Switch Application ID, without the "0x" prefix. */
+    /** Nintendo Switch Application ID, without the &quot;0x&quot; prefix. */
     ApplicationID?: string;
     /** Addon status. */
     Created: boolean;
@@ -389,7 +394,7 @@ interface GetSteamRequest extends IPlayFabRequestCommon {
     Entity?: EntityKey;
 }
 interface GetSteamResponse extends IPlayFabResultCommon {
-    /** Application ID obtained after setting up your game in Valve's developer portal. */
+    /** Application ID obtained after setting up your game in Valve&#39;s developer portal. */
     ApplicationId?: string;
     /** Addon status. */
     Created: boolean;
@@ -438,152 +443,287 @@ interface NintendoEnvironment {
 declare class PlayFabAddonApi extends PlayFabCommon {
     /**
      * Creates the Apple addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdateapple
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdateapple Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateApple({
+     *   "AppBundleId": "123456",
+     *   "AppSharedSecret": "654321",
+     *   "RequireSecureAuthentication": true
+     * });
      */
     CreateOrUpdateApple(request: CreateOrUpdateAppleRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateAppleResponse>;
     /**
      * Creates the Facebook addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebook
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebook Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateFacebook({
+     *   "AppID": "123456",
+     *   "AppSecret": "654321",
+     *   "NotificationEmail": "user@example.com"
+     * });
      */
     CreateOrUpdateFacebook(request: CreateOrUpdateFacebookRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookResponse>;
     /**
      * Creates the Facebook Instant Games addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebookinstantgames
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebookinstantgames Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateFacebookInstantGames({
+     *   "AppID": "123456",
+     *   "AppSecret": "654321"
+     * });
      */
     CreateOrUpdateFacebookInstantGames(request: CreateOrUpdateFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateFacebookInstantGamesResponse>;
     /**
      * Creates the Google addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdategoogle
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdategoogle Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateGoogle({
+     *   "AppPackageID": "abcdef",
+     *   "AppLicenseKey": "fedcba",
+     *   "OAuthClientID": "123456",
+     *   "OAuthClientSecret": "654321",
+     *   "OAuthCustomRedirectUri": "https://yourdomaingoeshere.com"
+     * });
      */
     CreateOrUpdateGoogle(request: CreateOrUpdateGoogleRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateGoogleResponse>;
     /**
      * Creates the Kongregate addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatekongregate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatekongregate Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateKongregate({
+     *   "SecretAPIKey": "123456"
+     * });
      */
     CreateOrUpdateKongregate(request: CreateOrUpdateKongregateRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateKongregateResponse>;
     /**
      * Creates the Nintendo addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatenintendo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatenintendo Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateNintendo({
+     *   "ApplicationID": "123456",
+     *   "Environments": [
+     *     {
+     *       "ID": "1",
+     *       "ClientID": "123456",
+     *       "ClientSecret": "654321"
+     *     }
+     *   ]
+     * });
      */
     CreateOrUpdateNintendo(request: CreateOrUpdateNintendoRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateNintendoResponse>;
     /**
      * Creates the PSN addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatepsn
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatepsn Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdatePSN({
+     *   "ClientID": "123456",
+     *   "ClientSecret": "abcdef",
+     *   "NextGenClientID": "654321",
+     *   "NextGenClientSecret": "fedcba"
+     * });
      */
     CreateOrUpdatePSN(request: CreateOrUpdatePSNRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdatePSNResponse>;
     /**
      * Creates the Steam addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatesteam
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatesteam Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateSteam({
+     *   "ApplicationId": "123456",
+     *   "SecretKey": "654321",
+     *   "UseSandbox": true,
+     *   "EnforceServiceSpecificTickets": true
+     * });
      */
     CreateOrUpdateSteam(request: CreateOrUpdateSteamRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateSteamResponse>;
     /**
      * Creates the ToxMod addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetoxmod
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetoxmod Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateToxMod({
+     *   "Enabled": false,
+     *   "AccountId": "123456",
+     *   "AccountKey": "654321"
+     * });
      */
     CreateOrUpdateToxMod(request: CreateOrUpdateToxModRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateToxModResponse>;
     /**
      * Creates the Twitch addon on a title, or updates it if it already exists.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetwitch
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetwitch Microsoft Documentation}
+     * @example
+     * await addonClient.CreateOrUpdateTwitch({
+     *   "ClientID": "123456",
+     *   "ClientSecret": "654321"
+     * });
      */
     CreateOrUpdateTwitch(request: CreateOrUpdateTwitchRequest, extraHeaders?: Record<string, string>): Promise<CreateOrUpdateTwitchResponse>;
     /**
      * Deletes the Apple addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteApple({});
      */
     DeleteApple(request: DeleteAppleRequest, extraHeaders?: Record<string, string>): Promise<DeleteAppleResponse>;
     /**
      * Deletes the Facebook addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteFacebook({});
      */
     DeleteFacebook(request: DeleteFacebookRequest, extraHeaders?: Record<string, string>): Promise<DeleteFacebookResponse>;
     /**
      * Deletes the Facebook addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteFacebookInstantGames({});
      */
     DeleteFacebookInstantGames(request: DeleteFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFacebookInstantGamesResponse>;
     /**
      * Deletes the Google addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteGoogle({});
      */
     DeleteGoogle(request: DeleteGoogleRequest, extraHeaders?: Record<string, string>): Promise<DeleteGoogleResponse>;
     /**
      * Deletes the Kongregate addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteKongregate({});
      */
     DeleteKongregate(request: DeleteKongregateRequest, extraHeaders?: Record<string, string>): Promise<DeleteKongregateResponse>;
     /**
      * Deletes the Nintendo addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteNintendo({});
      */
     DeleteNintendo(request: DeleteNintendoRequest, extraHeaders?: Record<string, string>): Promise<DeleteNintendoResponse>;
     /**
      * Deletes the PSN addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn Microsoft Documentation}
+     * @example
+     * await addonClient.DeletePSN({});
      */
     DeletePSN(request: DeletePSNRequest, extraHeaders?: Record<string, string>): Promise<DeletePSNResponse>;
     /**
      * Deletes the Steam addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteSteam({});
      */
     DeleteSteam(request: DeleteSteamRequest, extraHeaders?: Record<string, string>): Promise<DeleteSteamResponse>;
     /**
      * Deletes the ToxMod addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteToxMod({});
      */
     DeleteToxMod(request: DeleteToxModRequest, extraHeaders?: Record<string, string>): Promise<DeleteToxModResponse>;
     /**
      * Deletes the Twitch addon on a title.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch Microsoft Documentation}
+     * @example
+     * await addonClient.DeleteTwitch({});
      */
     DeleteTwitch(request: DeleteTwitchRequest, extraHeaders?: Record<string, string>): Promise<DeleteTwitchResponse>;
     /**
      * Gets information of the Apple addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple Microsoft Documentation}
+     * @example
+     * await addonClient.GetApple({});
      */
     GetApple(request: GetAppleRequest, extraHeaders?: Record<string, string>): Promise<GetAppleResponse>;
     /**
      * Gets information of the Facebook addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook Microsoft Documentation}
+     * @example
+     * await addonClient.GetFacebook({});
      */
     GetFacebook(request: GetFacebookRequest, extraHeaders?: Record<string, string>): Promise<GetFacebookResponse>;
     /**
      * Gets information of the Facebook Instant Games addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames Microsoft Documentation}
+     * @example
+     * await addonClient.GetFacebookInstantGames({});
      */
     GetFacebookInstantGames(request: GetFacebookInstantGamesRequest, extraHeaders?: Record<string, string>): Promise<GetFacebookInstantGamesResponse>;
     /**
      * Gets information of the Google addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle Microsoft Documentation}
+     * @example
+     * await addonClient.GetGoogle({});
      */
     GetGoogle(request: GetGoogleRequest, extraHeaders?: Record<string, string>): Promise<GetGoogleResponse>;
     /**
      * Gets information of the Kongregate addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate Microsoft Documentation}
+     * @example
+     * await addonClient.GetKongregate({});
      */
     GetKongregate(request: GetKongregateRequest, extraHeaders?: Record<string, string>): Promise<GetKongregateResponse>;
     /**
      * Gets information of the Nintendo addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo Microsoft Documentation}
+     * @example
+     * await addonClient.GetNintendo({});
      */
     GetNintendo(request: GetNintendoRequest, extraHeaders?: Record<string, string>): Promise<GetNintendoResponse>;
     /**
      * Gets information of the PSN addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn Microsoft Documentation}
+     * @example
+     * await addonClient.GetPSN({});
      */
     GetPSN(request: GetPSNRequest, extraHeaders?: Record<string, string>): Promise<GetPSNResponse>;
     /**
      * Gets information of the Steam addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam Microsoft Documentation}
+     * @example
+     * await addonClient.GetSteam({});
      */
     GetSteam(request: GetSteamRequest, extraHeaders?: Record<string, string>): Promise<GetSteamResponse>;
     /**
      * Gets information of the ToxMod addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod Microsoft Documentation}
+     * @example
+     * await addonClient.GetToxMod({});
      */
     GetToxMod(request: GetToxModRequest, extraHeaders?: Record<string, string>): Promise<GetToxModResponse>;
     /**
      * Gets information of the Twitch addon on a title, omits secrets.
-     * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch Microsoft Documentation}
+     * @example
+     * await addonClient.GetTwitch({});
      */
     GetTwitch(request: GetTwitchRequest, extraHeaders?: Record<string, string>): Promise<GetTwitchResponse>;
 }

package/dist/Addon.js

@@ -1,7 +1,7 @@
 import {
   PlayFabAddonApi
-} from "./chunk-7UQYMDJQ.js";
-import "./chunk-6TH6EJYH.js";
+} from "./chunk-P7UVG26J.js";
+import "./chunk-XVDYM74A.js";
 export {
   PlayFabAddonApi as default
 };