@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/dist/runtime/entity/models/MultiplayerResponseModels.d.ts

@@ -1,34 +1,108 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { MultiplayerModels } from "./MultiplayerModels";
+/**
+ * Typed response wrappers for the Multiplayer domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link MultiplayerModels}.
+ *
+ * Ticket and match polling flows consume these wrappers
+ * sequentially: the application keeps calling
+ * `getMatchmakingTicketAsync` until
+ * {@link MatchmakingTicketStatus.Matched} appears, then calls
+ * `getMatchAsync` to retrieve the connection details. The same
+ * wrapper class is reused across the
+ * client / server / admin role variants.
+ */
 export declare namespace MultiplayerResponseModels {
+    /**
+     * Maps the CancelAllMatchmakingTicket operation to a typed response wrapper.
+     */
     class CancelAllMatchmakingTicketOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.CancelAllMatchmakingTicketResponseData> {
+        /**
+         * Creates a new CancelAllMatchmakingTicketOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CancelMatchmakingTicket operation to a typed response wrapper.
+     */
     class CancelMatchmakingTicketOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.EmptyResponseData> {
+        /**
+         * Creates a new CancelMatchmakingTicketOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateMatchmakingTicket operation to a typed response wrapper.
+     */
     class CreateMatchmakingTicketOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.CreateMatchmakingTicketResponseData> {
+        /**
+         * Creates a new CreateMatchmakingTicketOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetMatchmakingTicket operation to a typed response wrapper.
+     */
     class GetMatchmakingTicketOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.GetMatchmakingTicketResponseData> {
+        /**
+         * Creates a new GetMatchmakingTicketOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetMatch operation to a typed response wrapper.
+     */
     class GetMatchOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.GetMatchResponseData> {
+        /**
+         * Creates a new GetMatchOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetQueueStatistics operation to a typed response wrapper.
+     */
     class GetQueueStatisticsOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.GetQueueStatisticsResponseData> {
+        /**
+         * Creates a new GetQueueStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the JoinMatchmakingTicket operation to a typed response wrapper.
+     */
     class JoinMatchmakingTicketOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.EmptyResponseData> {
+        /**
+         * Creates a new JoinMatchmakingTicketOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ListMatchmakingTicketsForPlayer operation to a typed response wrapper.
+     */
     class ListMatchmakingTicketsForPlayerOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.ListMatchmakingTicketsForPlayerResponseData> {
+        /**
+         * Creates a new ListMatchmakingTicketsForPlayerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAllMatch operation to a typed response wrapper.
+     */
     class GetAllMatchOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.GetAllMatchResponseData> {
+        /**
+         * Creates a new GetAllMatchOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAllMatchmakingTicket operation to a typed response wrapper.
+     */
     class GetAllMatchmakingTicketOperationResponse extends CustomOperationResponseAbstract<MultiplayerModels.GetAllMatchmakingTicketResponseData> {
+        /**
+         * Creates a new GetAllMatchmakingTicketOperationResponse instance.
+         */
         constructor();
     }
 }

package/dist/runtime/entity/models/StoreInventoryModels.d.ts

@@ -1,19 +1,56 @@
 import { GenericModels } from "./GenericModels";
+/**
+ * Reusable request and response DTOs for the StoreInventory
+ * domain.
+ *
+ * Store operations target a **logical owner** identified by
+ * `(ownerId, ownerType)` (see {@link OwnerType}) and operate
+ * against a concrete `storeId`. The store catalog is configured
+ * server-side; clients only read it.
+ *
+ * Three role variants per operation:
+ * - **Client** (no prefix): used by `GNNetwork.storeInventory`,
+ *   the owner is implicitly the authenticated player.
+ * - **`Server*`**: used by `GNNetwork.storeInventory.server`,
+ *   accepts explicit owner parameters so a backend can issue
+ *   purchases / gifts on behalf of any player.
+ * - **`Admin*`**: used by `GNNetwork.storeInventory.admin`,
+ *   plus catalog-edit and refund operations.
+ *
+ * Receipt-validation flows ship the platform receipt blob plus
+ * optional metadata; the backend records the
+ * {@link StoreReceiveType} on the audit log entry so analytics
+ * can distinguish in-game-currency purchases from platform-IAP
+ * grants.
+ */
 export declare namespace StoreInventoryModels {
+    /**
+     * Defines the reusable parameter block AvatarParam.
+     */
     class AvatarParam {
         type: number;
         value: string;
     }
+    /**
+     * Defines the reusable parameter block CurrencyParam.
+     */
     class CurrencyParam {
         key: string;
         value: number;
     }
+    /**
+     * Defines the reusable parameter block InAppPurchaseParam.
+     */
     class InAppPurchaseParam {
         facebookStoreId?: string;
         googlePlayStoreId?: string;
         appleAppStoreId?: string;
         analyticsPrice?: number;
     }
+    /**
+     * Selects which optional store fields should be returned in `infoResponseParameters`.
+     * Boolean flags default to `false`.
+     */
     class InfoRequestParam {
         storeItems?: boolean;
         storeItemType?: boolean;
@@ -27,93 +64,183 @@ export declare namespace StoreInventoryModels {
         tags?: boolean;
         storeDatas?: boolean;
     }
+    /**
+     * Defines the reusable parameter block StoreDataParam.
+     */
     class StoreDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Defines the reusable parameter block StoreItemParam.
+     */
     class StoreItemParam {
         catalogId: string;
         classId: string;
         amount: number;
     }
+    /**
+     * Defines the reusable parameter block TagParam.
+     */
     class TagParam {
         key: string;
         value: string;
     }
+    /**
+     * Represents InAppPurchaseItem.
+     */
     class InAppPurchaseItem {
         facebookStoreId: string;
         appleAppStoreId: string;
         googlePlayStoreId: string;
         analyticsPrice: number;
     }
+    /**
+     * Represents PriceCurrencyItem.
+     */
     class PriceCurrencyItem {
         key: string;
         value: number;
     }
+    /**
+     * Represents OwnerStoreInventoryItem.
+     */
     class OwnerStoreInventoryItem {
         itemId: string;
         catalogId: string;
         classId: string;
     }
+    /**
+     * Represents StoreInventoryItem.
+     */
     class StoreInventoryItem {
         catalogId: string;
         classId: string;
         amount: number;
     }
+    /**
+     * Purchases one store item for a target owner.
+     */
     class BuyStoreItemRequestData {
         storeId: string;
+        /**
+         * Target owner identifier.
+         */
         id: string;
+        /**
+         * Target owner type mapped by the public `OwnerType` enum.
+         */
         type: number;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerBuyStoreItem.
+     */
     class ServerBuyStoreItemRequestData extends BuyStoreItemRequestData {
     }
+    /**
+     * Defines the request payload for AdminBuyStoreItem.
+     */
     class AdminBuyStoreItemRequestData extends ServerBuyStoreItemRequestData {
     }
+    /**
+     * Grants one store item to a target owner without the normal purchase flow.
+     */
     class PresentStoreItemRequestData {
         storeId: string;
         id: string;
         type: number;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerPresentStoreItem.
+     */
     class ServerPresentStoreItemRequestData extends PresentStoreItemRequestData {
     }
+    /**
+     * Defines the request payload for AdminPresentStoreItem.
+     */
     class AdminPresentStoreItemRequestData extends ServerPresentStoreItemRequestData {
     }
+    /**
+     * Reads store logs using token-based pagination.
+     */
     class GetStoreLogRequestData {
         storeId?: string;
+        /**
+         * Filters by store receive types mapped by the public `StoreReceiveType` enum.
+         */
         storeReceiveTypes?: Array<number>;
         id?: string;
         limit?: number;
+        /**
+         * Continuation token returned by the previous page.
+         */
         token?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStoreLog.
+     */
     class ServerGetStoreLogRequestData extends GetStoreLogRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStoreLog.
+     */
     class AdminGetStoreLogRequestData extends ServerGetStoreLogRequestData {
     }
+    /**
+     * Defines the request payload for GetStoreUsed.
+     */
     class GetStoreUsedRequestData {
         storeId: string;
     }
+    /**
+     * Defines the request payload for ServerGetStoreUsed.
+     */
     class ServerGetStoreUsedRequestData extends GetStoreUsedRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStoreUsed.
+     */
     class AdminGetStoreUsedRequestData extends ServerGetStoreUsedRequestData {
     }
+    /**
+     * Defines the request payload for RemoveStoreUsed.
+     */
     class RemoveStoreUsedRequestData {
         storeId: string;
         ownerIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerRemoveStoreUsed.
+     */
     class ServerRemoveStoreUsedRequestData extends RemoveStoreUsedRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemoveStoreUsed.
+     */
     class AdminRemoveStoreUsedRequestData extends ServerRemoveStoreUsedRequestData {
     }
+    /**
+     * Defines the request payload for GetStoreItemInformation.
+     */
     class GetStoreItemInformationRequestData {
         storeId: string;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetStoreItemInformation.
+     */
     class ServerGetStoreItemInformationRequestData extends GetStoreItemInformationRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStoreItemInformation.
+     */
     class AdminGetStoreItemInformationRequestData extends ServerGetStoreItemInformationRequestData {
     }
+    /**
+     * Defines the request payload for GetStoreItemsWithTag.
+     */
     class GetStoreItemsWithTagRequestData {
         key: string;
         value: string;
@@ -121,28 +248,58 @@ export declare namespace StoreInventoryModels {
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetStoreItemsWithTag.
+     */
     class ServerGetStoreItemsWithTagRequestData extends GetStoreItemsWithTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStoreItemsWithTag.
+     */
     class AdminGetStoreItemsWithTagRequestData extends ServerGetStoreItemsWithTagRequestData {
     }
+    /**
+     * Defines the request payload for CreateStoreItem.
+     */
     class CreateStoreItemRequestData {
         storeId?: string;
         displayName?: string;
     }
+    /**
+     * Defines the request payload for ServerCreateStoreItem.
+     */
     class ServerCreateStoreItemRequestData extends CreateStoreItemRequestData {
     }
+    /**
+     * Defines the request payload for AdminCreateStoreItem.
+     */
     class AdminCreateStoreItemRequestData extends ServerCreateStoreItemRequestData {
     }
+    /**
+     * Defines the request payload for SetRemoveStatus.
+     */
     class SetRemoveStatusRequestData {
         storeId: string;
         reason?: string;
     }
+    /**
+     * Defines the request payload for ServerSetRemoveStatus.
+     */
     class ServerSetRemoveStatusRequestData extends SetRemoveStatusRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetRemoveStatus.
+     */
     class AdminSetRemoveStatusRequestData extends ServerSetRemoveStatusRequestData {
     }
+    /**
+     * Updates mutable store metadata for one store entry.
+     */
     class SetStoreItemInformationRequestData {
         storeId: string;
+        /**
+         * Store item type mapped by the public `StoreItemType` enum.
+         */
         storeItemType?: number;
         storeDatas?: Array<StoreDataParam>;
         storeItems?: Array<StoreItemParam>;
@@ -153,50 +310,95 @@ export declare namespace StoreInventoryModels {
         avatar?: AvatarParam;
         tags?: Array<TagParam>;
     }
+    /**
+     * Defines the request payload for ServerSetStoreItemInformation.
+     */
     class ServerSetStoreItemInformationRequestData extends SetStoreItemInformationRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetStoreItemInformation.
+     */
     class AdminSetStoreItemInformationRequestData extends ServerSetStoreItemInformationRequestData {
     }
+    /**
+     * Defines the request payload for ValidateAppleAppStoreReceipt.
+     */
     class ValidateAppleAppStoreReceiptRequestData {
         receipt: string;
         id: string;
         type: number;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerValidateAppleAppStoreReceipt.
+     */
     class ServerValidateAppleAppStoreReceiptRequestData extends ValidateAppleAppStoreReceiptRequestData {
     }
+    /**
+     * Defines the request payload for AdminValidateAppleAppStoreReceipt.
+     */
     class AdminValidateAppleAppStoreReceiptRequestData extends ServerValidateAppleAppStoreReceiptRequestData {
     }
+    /**
+     * Defines the request payload for ValidateFacebookStoreReceipt.
+     */
     class ValidateFacebookStoreReceiptRequestData {
         receipt: string;
         id: string;
         type: number;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerValidateFacebookStoreReceipt.
+     */
     class ServerValidateFacebookStoreReceiptRequestData extends ValidateFacebookStoreReceiptRequestData {
     }
+    /**
+     * Defines the request payload for AdminValidateFacebookStoreReceipt.
+     */
     class AdminValidateFacebookStoreReceiptRequestData extends ServerValidateFacebookStoreReceiptRequestData {
     }
+    /**
+     * Defines the request payload for ValidateGooglePlayStoreReceipt.
+     */
     class ValidateGooglePlayStoreReceiptRequestData {
         receipt: string;
         id: string;
         type: number;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerValidateGooglePlayStoreReceipt.
+     */
     class ServerValidateGooglePlayStoreReceiptRequestData extends ValidateGooglePlayStoreReceiptRequestData {
     }
+    /**
+     * Defines the request payload for AdminValidateGooglePlayStoreReceipt.
+     */
     class AdminValidateGooglePlayStoreReceiptRequestData extends ServerValidateGooglePlayStoreReceiptRequestData {
     }
+    /**
+     * Defines the request payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardRequestData {
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetCreateLeaderboard.
+     */
     class ServerGetCreateLeaderboardRequestData extends GetCreateLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCreateLeaderboard.
+     */
     class AdminGetCreateLeaderboardRequestData extends ServerGetCreateLeaderboardRequestData {
     }
+    /**
+     * Contains the optional fields requested through `InfoRequestParam`.
+     */
     class InfoResponseParameters {
         storeItems?: Array<StoreInventoryItem>;
         storeItemType?: number;
@@ -210,51 +412,93 @@ export declare namespace StoreInventoryModels {
         tags?: Array<GenericModels.TagItem>;
         storeDatas?: Array<GenericModels.DataItem>;
     }
+    /**
+     * Base store-inventory response envelope.
+     */
     class StoreInventoryResponseData {
+        /**
+         * Optional field bag controlled by the corresponding `InfoRequestParam`.
+         */
         infoResponseParameters: InfoResponseParameters;
     }
+    /**
+     * Defines the response payload for StoreInventoryWithStoreId.
+     */
     class StoreInventoryWithStoreIdResponseData extends StoreInventoryResponseData {
         storeId: string;
     }
+    /**
+     * Defines the response payload for StoreInventoryLeaderboard.
+     */
     class StoreInventoryLeaderboardResponseData extends StoreInventoryWithStoreIdResponseData {
         position: number;
     }
+    /**
+     * Defines the response payload for StoreInventoriesWithStoreId.
+     */
     class StoreInventoriesWithStoreIdResponseData {
         results: Array<StoreInventoryWithStoreIdResponseData>;
     }
+    /**
+     * Defines the response payload for CreateStoreItem.
+     */
     class CreateStoreItemResponseData {
         storeId: string;
     }
+    /**
+     * Describes the affected owner snapshot returned by buy/present flows.
+     */
     class OwnerInfoResponseParameters {
         currencies?: Array<PriceCurrencyItem>;
         inventories?: Array<OwnerStoreInventoryItem>;
     }
+    /**
+     * Describes the result of a store purchase workflow.
+     */
     class BuyStoreInventoryResponseData {
         storeItems?: Array<StoreInventoryItem>;
         storeCurrencies?: Array<PriceCurrencyItem>;
         priceCurrencies?: Array<PriceCurrencyItem>;
         infoResponseParameters?: OwnerInfoResponseParameters;
     }
+    /**
+     * Describes the result of a store present workflow.
+     */
     class PresentStoreInventoryResponseData {
         storeItems?: Array<StoreInventoryItem>;
         storeCurrencies?: Array<PriceCurrencyItem>;
         priceCurrencies?: Array<PriceCurrencyItem>;
         infoResponseParameters?: OwnerInfoResponseParameters;
     }
+    /**
+     * Defines the response payload for Currency.
+     */
     class CurrencyResponseData {
         key: string;
         value: number;
     }
+    /**
+     * Defines the response payload for StoreItem.
+     */
     class StoreItemResponseData {
         catalogId: string;
         classId: string;
         itemId: string;
     }
+    /**
+     * Describes one store transaction log entry.
+     */
     class StoreLogResponseData {
         storeId: string;
         id: string;
+        /**
+         * Owner type mapped by the public `OwnerType` enum.
+         */
         type: number;
         transactionId?: string;
+        /**
+         * Receive type mapped by the public `StoreReceiveType` enum.
+         */
         storeReceiveType: number;
         priceCurrencyStartValues: Array<CurrencyResponseData>;
         priceCurrencyAmountValues: Array<CurrencyResponseData>;
@@ -266,21 +510,39 @@ export declare namespace StoreInventoryModels {
         tsCreate: number;
         log: string;
     }
+    /**
+     * Defines the response payload for StoreUsed.
+     */
     class StoreUsedResponseData {
         id: string;
         type: number;
         tsCreate: number;
     }
+    /**
+     * Defines the response payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardResponseData {
         results: Array<StoreInventoryLeaderboardResponseData>;
     }
+    /**
+     * Returns one page of store logs.
+     */
     class GetStoreLogResponseData {
         results: Array<StoreLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Defines the response payload for GetStoreUsed.
+     */
     class GetStoreUsedResponseData {
         results: Array<StoreUsedResponseData>;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }