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

package/dist/Economy.d.ts

@@ -249,7 +249,7 @@ interface CatalogView {
      * The format to use when exporting the view file. Supported file formats are: Json, JsonLines, GZippedJson,
      * GZippedJsonLines
      */
-    FileFormat?: string;
+    FileFormat?: ViewFileFormat;
     /** An OData filter used to refine the search query. */
     Filter?: string;
     /** An optional alternate friendly ID associated with this view. */
@@ -282,8 +282,9 @@ interface CatalogViewDiagnostics {
     /** The last size of the view in bytes. */
     SizeInBytes?: number;
     /** The last status of the view. */
-    Status?: string;
+    Status?: CatalogViewStatus;
 }
+type CatalogViewStatus = "Unknown" | "Success" | "FileSizeExceeded" | "Error" | "StoreDoesNotExist" | "TransientError" | "PartialSuccess" | "Pending";
 interface CategoryRatingConfig {
     /** Name of the category. */
     Name?: string;
@@ -298,6 +299,7 @@ interface CompleteVersionedCatalogUploadResponse extends IPlayFabResultCommon {
     /** Version of the catalog. */
     Version?: string;
 }
+type ConcernCategory = "None" | "OffensiveContent" | "ChildExploitation" | "MalwareOrVirus" | "PrivacyConcerns" | "MisleadingApp" | "PoorPerformance" | "ReviewResponse" | "SpamAdvertising" | "Profanity";
 interface Content {
     /** The content unique ID. */
     Id?: string;
@@ -321,6 +323,7 @@ interface Content {
     /** The Azure CDN URL for retrieval of the catalog item binary content. */
     Url?: string;
 }
+type CountryCode = "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "Unknown";
 interface CreateDraftItemRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -467,8 +470,9 @@ interface DisplayPropertyIndexInfo {
     /** The property name in the &#39;DisplayProperties&#39; property to be indexed. */
     Name?: string;
     /** The type of the property to be indexed. */
-    Type?: string;
+    Type?: DisplayPropertyType;
 }
+type DisplayPropertyType = "None" | "QueryDateTime" | "QueryDouble" | "QueryString" | "SearchString";
 interface EntityKey {
     /** Unique ID of the entity. */
     Id: string;
@@ -779,7 +783,7 @@ interface GetItemPublishStatusRequest extends IPlayFabRequestCommon {
 }
 interface GetItemPublishStatusResponse extends IPlayFabResultCommon {
     /** High level status of the published item. */
-    Result?: string;
+    Result?: PublishResult;
     /** Descriptive message about the current status of the publish. */
     StatusMessage?: string;
 }
@@ -957,6 +961,7 @@ interface GooglePlayProductPurchase {
     /** The token provided to the player&#39;s device when the product was purchased */
     Token?: string;
 }
+type HelpfulnessVote = "None" | "UnHelpful" | "Helpful";
 interface IActionResult extends IPlayFabResultCommon {
 }
 interface Image {
@@ -1040,8 +1045,9 @@ interface ModerationState {
     /** The current stated reason for the associated item being moderated. */
     Reason?: string;
     /** The current moderation status for the associated item. */
-    Status?: string;
+    Status?: ModerationStatus;
 }
+type ModerationStatus = "Unknown" | "AwaitingModeration" | "Approved" | "Rejected";
 interface Permissions {
     /**
      * The list of ids of Segments that the a player can be in to purchase from the store. When a value is provided, the player
@@ -1067,6 +1073,7 @@ interface PublishDraftItemRequest extends IPlayFabRequestCommon {
 }
 interface PublishDraftItemResponse extends IPlayFabResultCommon {
 }
+type PublishResult = "Unknown" | "Pending" | "Succeeded" | "Failed" | "Canceled";
 interface PurchaseInventoryItemsOperation {
     /** The amount to purchase. */
     Amount?: number;
@@ -1187,7 +1194,7 @@ interface RedeemAppleAppStoreInventoryItemsRequest extends IPlayFabRequestCommon
     /** The id of the entity&#39;s collection to perform this action on. (Default=&quot;default&quot;) */
     CollectionId?: string;
     /** The country code of the real money transaction. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** 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. */
@@ -1212,7 +1219,7 @@ interface RedeemGooglePlayInventoryItemsRequest extends IPlayFabRequestCommon {
     /** The id of the entity&#39;s collection to perform this action on. (Default=&quot;default&quot;) */
     CollectionId?: string;
     /** The country code of the real money transaction. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** 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. */
@@ -1239,7 +1246,7 @@ interface RedeemMicrosoftStoreInventoryItemsRequest extends IPlayFabRequestCommo
     /** The OneStore Collections Id Key used for AAD authentication. */
     CollectionsIdKey?: string;
     /** The country code of the real money transaction. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** 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. */
@@ -1267,7 +1274,7 @@ interface RedeemNintendoEShopInventoryItemsRequest extends IPlayFabRequestCommon
     /** The id of the entity&#39;s collection to perform this action on. (Default=&quot;default&quot;) */
     CollectionId?: string;
     /** The country code of the real money transaction. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** 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. */
@@ -1294,7 +1301,7 @@ interface RedeemPlayStationStoreInventoryItemsRequest extends IPlayFabRequestCom
     /** The id of the entity&#39;s collection to perform this action on. (Default=&quot;default&quot;) */
     CollectionId?: string;
     /** The country code of the real money transaction. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** 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. */
@@ -1321,7 +1328,7 @@ interface RedeemSteamInventoryItemsRequest extends IPlayFabRequestCommon {
     /** The id of the entity&#39;s collection to perform this action on. (Default=&quot;default&quot;) */
     CollectionId?: string;
     /** The country code of the real money transaction. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** 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. */
@@ -1362,7 +1369,7 @@ interface ReportItemRequest extends IPlayFabRequestCommon {
     /** An alternate ID associated with this item. */
     AlternateId?: CatalogAlternateId;
     /** Category of concern for this report. */
-    ConcernCategory?: string;
+    ConcernCategory?: ConcernCategory;
     /** 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. */
@@ -1378,7 +1385,7 @@ interface ReportItemReviewRequest extends IPlayFabRequestCommon {
     /** An alternate ID of the item associated with the review. */
     AlternateId?: CatalogAlternateId;
     /** The reason this review is being reported. */
-    ConcernCategory?: string;
+    ConcernCategory?: ConcernCategory;
     /** 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. */
@@ -1490,7 +1497,7 @@ interface SetItemModerationStateRequest extends IPlayFabRequestCommon {
     /** The reason for the moderation state change for the associated item. */
     Reason?: string;
     /** The status to set for the associated item. */
-    Status?: string;
+    Status?: ModerationStatus;
 }
 interface SetItemModerationStateResponse extends IPlayFabResultCommon {
 }
@@ -1520,7 +1527,7 @@ interface SubmitItemReviewVoteRequest extends IPlayFabRequestCommon {
     /** The ID of the review to submit a helpfulness vote for. */
     ReviewId?: string;
     /** The helpfulness vote of the review. */
-    Vote?: string;
+    Vote?: HelpfulnessVote;
 }
 interface SubmitItemReviewVoteResponse extends IPlayFabResultCommon {
 }
@@ -1594,7 +1601,7 @@ interface Transaction {
     /** Additional details about the transaction. Null if it was not a clawback operation. */
     ClawbackDetails?: TransactionClawbackDetails;
     /** The country of the caller of the operation. */
-    CountryCode?: string;
+    CountryCode?: CountryCode;
     /** The type of item that the the operation occurred on. */
     ItemType?: string;
     /** The operations that occurred. */
@@ -1983,6 +1990,7 @@ interface VersionedCatalogItemStoreDetails {
     /** The global prices utilized in the store. These options are mutually exclusive with price options in item references. */
     PricesOverride?: VersionedCatalogItemPricesOverride;
 }
+type ViewFileFormat = "Unknown" | "Json" | "JsonLines" | "GZippedJson" | "GZippedJsonLines";
 
 declare class PlayFabEconomyApi extends PlayFabCommon {
     /**

package/dist/Events.d.ts

@@ -38,8 +38,9 @@ interface DataConnectionDetails {
     /** Current status of the data connection, if any. */
     Status?: DataConnectionStatusDetails;
     /** The type of data connection. */
-    Type: string;
+    Type: DataConnectionType;
 }
+type DataConnectionErrorState = "OK" | "Error";
 interface DataConnectionFabricKQLSettings {
     /** The URI of the Fabric cluster. */
     ClusterUri?: string;
@@ -64,8 +65,9 @@ interface DataConnectionStatusDetails {
     /** 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;
+    State?: DataConnectionErrorState;
 }
+type DataConnectionType = "AzureBlobStorage" | "AzureDataExplorer" | "FabricKQL";
 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>;
@@ -235,7 +237,7 @@ interface SetDataConnectionRequest extends IPlayFabRequestCommon {
     /** The name of the data connection to update or create. */
     Name: string;
     /** The type of data connection. */
-    Type: string;
+    Type: DataConnectionType;
 }
 interface SetDataConnectionResponse extends IPlayFabResultCommon {
     /** The details of the Data Connection to be created or updated. */

package/dist/Experimentation.d.ts

@@ -1,5 +1,6 @@
 import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
 
+type AnalysisTaskState = "Waiting" | "ReadyForSubmission" | "SubmittingToPipeline" | "Running" | "Completed" | "Failed" | "Canceled";
 interface CreateExclusionGroupRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -29,7 +30,7 @@ interface CreateExperimentRequest extends IPlayFabRequestCommon {
     /** Percentage of exclusion group traffic that will see this experiment. */
     ExclusionGroupTrafficAllocation?: number;
     /** Type of experiment. */
-    ExperimentType?: string;
+    ExperimentType?: ExperimentType;
     /** Friendly name of the experiment. */
     Name: string;
     /** Id of the segment to which this experiment applies. Defaults to the &#39;All Players&#39; segment. */
@@ -92,7 +93,7 @@ interface Experiment {
     /** Percentage of exclusion group traffic that will see this experiment. */
     ExclusionGroupTrafficAllocation?: number;
     /** Type of experiment. */
-    ExperimentType?: string;
+    ExperimentType?: ExperimentType;
     /** Id of the experiment. */
     Id?: string;
     /** Friendly name of the experiment. */
@@ -102,7 +103,7 @@ interface Experiment {
     /** When experiment should start/was started. */
     StartDate: string;
     /** State experiment is currently in. */
-    State?: string;
+    State?: ExperimentState;
     /**
      * List of title player account IDs that automatically receive treatments in the experiment, but are not included when
      * calculating experiment metrics.
@@ -119,6 +120,8 @@ interface ExperimentExclusionGroup {
     /** Friendly name of the exclusion group. */
     Name?: string;
 }
+type ExperimentState = "New" | "Started" | "Stopped" | "Deleted";
+type ExperimentType = "Active" | "Snapshot";
 interface GetExclusionGroupsRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -205,7 +208,7 @@ interface Scorecard {
     /** Friendly name of the experiment. */
     ExperimentName?: string;
     /** Represents the latest compute job status. */
-    LatestJobStatus?: string;
+    LatestJobStatus?: AnalysisTaskState;
     /** Represents the presence of a sample ratio mismatch in the scorecard data. */
     SampleRatioMismatch: boolean;
     /** Scorecard containing list of analysis. */
@@ -266,7 +269,7 @@ interface UpdateExperimentRequest extends IPlayFabRequestCommon {
     /** Percentage of exclusion group traffic that will see this experiment. */
     ExclusionGroupTrafficAllocation?: number;
     /** Type of experiment. */
-    ExperimentType?: string;
+    ExperimentType?: ExperimentType;
     /** Id of the experiment. */
     Id: string;
     /** Friendly name of the experiment. */

package/dist/Groups.d.ts

@@ -335,6 +335,7 @@ interface ListMembershipResponse extends IPlayFabResultCommon {
     /** The list of groups */
     Groups?: GroupWithRoles[];
 }
+type OperationTypes = "Created" | "Updated" | "Deleted" | "None";
 interface RemoveGroupApplicationRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
     CustomTags?: Record<string, string | null>;
@@ -393,7 +394,7 @@ interface UpdateGroupResponse extends IPlayFabResultCommon {
     /** New version of the group data. */
     ProfileVersion: number;
     /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
-    SetResult?: string;
+    SetResult?: OperationTypes;
 }
 interface UpdateGroupRoleRequest extends IPlayFabRequestCommon {
     /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
@@ -417,7 +418,7 @@ interface UpdateGroupRoleResponse extends IPlayFabResultCommon {
     /** New version of the role data. */
     ProfileVersion: number;
     /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
-    SetResult?: string;
+    SetResult?: OperationTypes;
 }
 
 declare class PlayFabGroupsApi extends PlayFabCommon {

package/dist/Matchmaker.d.ts

@@ -91,6 +91,7 @@ interface PlayerLeftRequest extends IPlayFabRequestCommon {
 /** @deprecated Do not use */
 interface PlayerLeftResponse extends IPlayFabResultCommon {
 }
+type Region = "USCentral" | "USEast" | "EUWest" | "Singapore" | "Japan" | "Brazil" | "Australia";
 /** @deprecated Do not use */
 interface RegisterGameRequest extends IPlayFabRequestCommon {
     /** Unique identifier of the build running on the Game Server Instance. */
@@ -108,7 +109,7 @@ interface RegisterGameRequest extends IPlayFabRequestCommon {
      * Region in which the Game Server Instance is running. For matchmaking using non-AWS region names, set this to any AWS
      * region and use Tags (below) to specify your custom region.
      */
-    Region: string;
+    Region: Region;
     /**
      * IPV4 address of the Game Server Instance.
      * @deprecated Please use ServerIPV4Address instead.
@@ -150,7 +151,7 @@ interface StartGameRequest extends IPlayFabRequestCommon {
     /** Game mode for this Game Server Instance. */
     GameMode: string;
     /** Region with which to associate the server, for filtering. */
-    Region: string;
+    Region: Region;
 }
 /** @deprecated Do not use */
 interface StartGameResponse extends IPlayFabResultCommon {