@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -1,14 +1,60 @@
 import { GenericModels } from "./GenericModels";
+/**
+ * Reusable request and response DTOs for the Inventory domain.
+ *
+ * Inventory operations target a **specific item entity** by
+ * `itemId` (the per-owner ledger row, distinct from the
+ * catalog's `classId`). On client variants the backend
+ * cross-checks that the authenticated player owns the item
+ * (or has permission via group membership when `ownerType ==
+ * Group`).
+ *
+ * Three role variants per operation:
+ * - **Client** (no prefix): used by `GNNetwork.inventory`,
+ *   scoped to items the caller owns.
+ * - **`Server*`**: used by `GNNetwork.inventory.server`, can
+ *   target any owner with a valid server `secretKey`.
+ * - **`Admin*`**: used by `GNNetwork.inventory.admin`, full
+ *   privileged access including catalog edits.
+ *
+ * Stackability rules ({@link ItemType}) determine which
+ * mutation operations make sense for a given catalog row:
+ * `setItemAmount` / `addItemAmount` / `subtractItemAmount` only
+ * apply to `Stackable` items; `NonStackable` items always have
+ * an implicit amount of `1`.
+ */
 export declare namespace InventoryModels {
+    /**
+     * Defines the reusable parameter block CustomDataParam.
+     */
     class CustomDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Selects which optional inventory fields should be returned in `infoResponseParameters`.
+     * Boolean flags default to `false`; key arrays narrow list-style fields to specific keys only.
+     */
     class InfoRequestParam {
+        /**
+         * Includes the catalog ID from which this inventory item was created.
+         */
         catalogId?: boolean;
+        /**
+         * Includes the class ID of the inventory item.
+         */
         classId?: boolean;
+        /**
+         * Includes the item type mapped by the public `ItemType` enum.
+         */
         itemType?: boolean;
+        /**
+         * Includes the current item amount.
+         */
         amount?: boolean;
+        /**
+         * Includes the current owner descriptor.
+         */
         owner?: boolean;
         removeStatus?: boolean;
         segments?: boolean;
@@ -19,114 +65,238 @@ export declare namespace InventoryModels {
         tags?: boolean;
         itemStatistics?: boolean;
         itemDatas?: boolean;
+        /**
+         * Restricts `itemDatas` to the specified keys when that field is requested.
+         */
         itemDataKeys?: Array<string>;
+        /**
+         * Restricts `itemStatistics` to the specified statistic keys when that field is requested.
+         */
         itemStatisticsKeys?: Array<string>;
         customDataKeys?: Array<string>;
         tagKeys?: Array<string>;
     }
+    /**
+     * Defines the reusable parameter block ItemDataParam.
+     */
     class ItemDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Defines the reusable parameter block ItemStatisticsParam.
+     */
     class ItemStatisticsParam {
         key: string;
         value: number;
     }
+    /**
+     * Defines the request payload for AddSegment.
+     */
     class AddSegmentRequestData {
         itemId: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerAddSegment.
+     */
     class ServerAddSegmentRequestData extends AddSegmentRequestData {
     }
+    /**
+     * Defines the request payload for AdminAddSegment.
+     */
     class AdminAddSegmentRequestData extends ServerAddSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetAmount.
+     */
     class GetAmountRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetAmount.
+     */
     class ServerGetAmountRequestData extends GetAmountRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetAmount.
+     */
     class AdminGetAmountRequestData extends ServerGetAmountRequestData {
     }
+    /**
+     * Defines the request payload for GetAvatar.
+     */
     class GetAvatarRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetAvatar.
+     */
     class ServerGetAvatarRequestData extends GetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetAvatar.
+     */
     class AdminGetAvatarRequestData extends ServerGetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for GetCatalogId.
+     */
     class GetCatalogIdRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetCatalogId.
+     */
     class ServerGetCatalogIdRequestData extends GetCatalogIdRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCatalogId.
+     */
     class AdminGetCatalogIdRequestData extends ServerGetCatalogIdRequestData {
     }
+    /**
+     * Defines the request payload for GetClassId.
+     */
     class GetClassIdRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetClassId.
+     */
     class ServerGetClassIdRequestData extends GetClassIdRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetClassId.
+     */
     class AdminGetClassIdRequestData extends ServerGetClassIdRequestData {
     }
+    /**
+     * Defines the request payload for GetCustomData.
+     */
     class GetCustomDataRequestData {
         itemId: string;
         customDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetCustomData.
+     */
     class ServerGetCustomDataRequestData extends GetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCustomData.
+     */
     class AdminGetCustomDataRequestData extends ServerGetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for GetDisplayName.
+     */
     class GetDisplayNameRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetDisplayName.
+     */
     class ServerGetDisplayNameRequestData extends GetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetDisplayName.
+     */
     class AdminGetDisplayNameRequestData extends ServerGetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for GetItemData.
+     */
     class GetItemDataRequestData {
         itemId: string;
         itemDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetItemData.
+     */
     class ServerGetItemDataRequestData extends GetItemDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemData.
+     */
     class AdminGetItemDataRequestData extends ServerGetItemDataRequestData {
     }
+    /**
+     * Defines the request payload for GetItemInformation.
+     */
     class GetItemInformationRequestData {
         itemId: string;
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetItemInformation.
+     */
     class ServerGetItemInformationRequestData extends GetItemInformationRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemInformation.
+     */
     class AdminGetItemInformationRequestData extends ServerGetItemInformationRequestData {
     }
+    /**
+     * Reads statistics for one inventory item.
+     * Note that this request uses `statisticsKeys`, while `InfoRequestParam` uses `itemStatisticsKeys`.
+     */
     class GetItemStatisticsRequestData {
         itemId: string;
         statisticsKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetItemStatistics.
+     */
     class ServerGetItemStatisticsRequestData extends GetItemStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemStatistics.
+     */
     class AdminGetItemStatisticsRequestData extends ServerGetItemStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for GetItemsWithDisplayName.
+     */
     class GetItemsWithDisplayNameRequestData {
         keyword: string;
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetItemsWithDisplayName.
+     */
     class ServerGetItemsWithDisplayNameRequestData extends GetItemsWithDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemsWithDisplayName.
+     */
     class AdminGetItemsWithDisplayNameRequestData extends ServerGetItemsWithDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for GetItemsWithSegment.
+     */
     class GetItemsWithSegmentRequestData {
         value: string;
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetItemsWithSegment.
+     */
     class ServerGetItemsWithSegmentRequestData extends GetItemsWithSegmentRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemsWithSegment.
+     */
     class AdminGetItemsWithSegmentRequestData extends ServerGetItemsWithSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetItemsWithTag.
+     */
     class GetItemsWithTagRequestData {
         key: string;
         value: string;
@@ -134,38 +304,83 @@ export declare namespace InventoryModels {
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetItemsWithTag.
+     */
     class ServerGetItemsWithTagRequestData extends GetItemsWithTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemsWithTag.
+     */
     class AdminGetItemsWithTagRequestData extends ServerGetItemsWithTagRequestData {
     }
+    /**
+     * Defines the request payload for GetItemType.
+     */
     class GetItemTypeRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetItemType.
+     */
     class ServerGetItemTypeRequestData extends GetItemTypeRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetItemType.
+     */
     class AdminGetItemTypeRequestData extends ServerGetItemTypeRequestData {
     }
+    /**
+     * Defines the request payload for GetOwner.
+     */
     class GetOwnerRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetOwner.
+     */
     class ServerGetOwnerRequestData extends GetOwnerRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetOwner.
+     */
     class AdminGetOwnerRequestData extends ServerGetOwnerRequestData {
     }
+    /**
+     * Defines the request payload for GetRemoveStatus.
+     */
     class GetRemoveStatusRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetRemoveStatus.
+     */
     class ServerGetRemoveStatusRequestData extends GetRemoveStatusRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetRemoveStatus.
+     */
     class AdminGetRemoveStatusRequestData extends ServerGetRemoveStatusRequestData {
     }
+    /**
+     * Defines the request payload for GetSegment.
+     */
     class GetSegmentRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetSegment.
+     */
     class ServerGetSegmentRequestData extends GetSegmentRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetSegment.
+     */
     class AdminGetSegmentRequestData extends ServerGetSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboardAroundItem.
+     */
     class GetStatisticsLeaderboardAroundItemRequestData {
         itemId: string;
         key: string;
@@ -175,10 +390,19 @@ export declare namespace InventoryModels {
         loadFromCache?: boolean;
         catalogId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboardAroundItem.
+     */
     class ServerGetStatisticsLeaderboardAroundItemRequestData extends GetStatisticsLeaderboardAroundItemRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboardAroundItem.
+     */
     class AdminGetStatisticsLeaderboardAroundItemRequestData extends ServerGetStatisticsLeaderboardAroundItemRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -188,142 +412,300 @@ export declare namespace InventoryModels {
         version?: string;
         catalogId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboard.
+     */
     class ServerGetStatisticsLeaderboardRequestData extends GetStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboard.
+     */
     class AdminGetStatisticsLeaderboardRequestData extends ServerGetStatisticsLeaderboardRequestData {
     }
+    /**
+     * 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 {
     }
+    /**
+     * Defines the request payload for GetTag.
+     */
     class GetTagRequestData {
         itemId: string;
         tagKeys: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetTag.
+     */
     class ServerGetTagRequestData extends GetTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetTag.
+     */
     class AdminGetTagRequestData extends ServerGetTagRequestData {
     }
+    /**
+     * Defines the request payload for GetTsCreate.
+     */
     class GetTsCreateRequestData {
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerGetTsCreate.
+     */
     class ServerGetTsCreateRequestData extends GetTsCreateRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetTsCreate.
+     */
     class AdminGetTsCreateRequestData extends ServerGetTsCreateRequestData {
     }
+    /**
+     * Defines the request payload for RemoveSegment.
+     */
     class RemoveSegmentRequestData {
         itemId: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveSegment.
+     */
     class ServerRemoveSegmentRequestData extends RemoveSegmentRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemoveSegment.
+     */
     class AdminRemoveSegmentRequestData extends ServerRemoveSegmentRequestData {
     }
+    /**
+     * Defines the request payload for RemoveTag.
+     */
     class RemoveTagRequestData {
         itemId: string;
         key: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveTag.
+     */
     class ServerRemoveTagRequestData extends RemoveTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemoveTag.
+     */
     class AdminRemoveTagRequestData extends ServerRemoveTagRequestData {
     }
+    /**
+     * Replaces the stored amount with an absolute value.
+     * Use `ChangeItemStatistics` for statistics deltas; this contract is not a delta operation.
+     */
     class SetAmountRequestData {
         itemId: string;
         amount: number;
     }
+    /**
+     * Defines the request payload for ServerSetAmount.
+     */
     class ServerSetAmountRequestData extends SetAmountRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetAmount.
+     */
     class AdminSetAmountRequestData extends ServerSetAmountRequestData {
     }
+    /**
+     * Defines the request payload for SetAvatar.
+     */
     class SetAvatarRequestData {
         itemId: string;
         type: number;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerSetAvatar.
+     */
     class ServerSetAvatarRequestData extends SetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetAvatar.
+     */
     class AdminSetAvatarRequestData extends ServerSetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for SetCustomData.
+     */
     class SetCustomDataRequestData {
         itemId: string;
         customDatas: Array<CustomDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetCustomData.
+     */
     class ServerSetCustomDataRequestData extends SetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetCustomData.
+     */
     class AdminSetCustomDataRequestData extends ServerSetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for SetDisplayName.
+     */
     class SetDisplayNameRequestData {
         itemId: string;
         displayName: string;
     }
+    /**
+     * Defines the request payload for ServerSetDisplayName.
+     */
     class ServerSetDisplayNameRequestData extends SetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetDisplayName.
+     */
     class AdminSetDisplayNameRequestData extends ServerSetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for SetItemData.
+     */
     class SetItemDataRequestData {
         itemId: string;
         itemDatas: Array<ItemDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetItemData.
+     */
     class ServerSetItemDataRequestData extends SetItemDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetItemData.
+     */
     class AdminSetItemDataRequestData extends ServerSetItemDataRequestData {
     }
+    /**
+     * Applies delta updates to one or more item statistics.
+     */
     class ChangeItemStatisticsRequestData {
         itemId: string;
         itemStatistics: Array<ItemStatisticsParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangeItemStatistics.
+     */
     class ServerChangeItemStatisticsRequestData extends ChangeItemStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for AdminChangeItemStatistics.
+     */
     class AdminChangeItemStatisticsRequestData extends ServerChangeItemStatisticsRequestData {
     }
+    /**
+     * Transfers ownership of the inventory item to a different owner.
+     */
     class SetOwnerRequestData {
         itemId: string;
+        /**
+         * New owner identifier matching the selected `newOwnerType`.
+         */
         newOwnerId: string;
+        /**
+         * New owner type mapped by the public `OwnerType` enum.
+         */
         newOwnerType: number;
     }
+    /**
+     * Defines the request payload for ServerSetOwner.
+     */
     class ServerSetOwnerRequestData extends SetOwnerRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetOwner.
+     */
     class AdminSetOwnerRequestData extends ServerSetOwnerRequestData {
     }
+    /**
+     * Defines the request payload for SetRemoveStatus.
+     */
     class SetRemoveStatusRequestData {
         itemId: string;
         reason?: string;
     }
+    /**
+     * Defines the request payload for ServerSetRemoveStatus.
+     */
     class ServerSetRemoveStatusRequestData extends SetRemoveStatusRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetRemoveStatus.
+     */
     class AdminSetRemoveStatusRequestData extends ServerSetRemoveStatusRequestData {
     }
+    /**
+     * Defines the request payload for SetTag.
+     */
     class SetTagRequestData {
         itemId: string;
         key: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerSetTag.
+     */
     class ServerSetTagRequestData extends SetTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetTag.
+     */
     class AdminSetTagRequestData extends ServerSetTagRequestData {
     }
+    /**
+     * Reads statistic change logs for one inventory item.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetStatisticsLogRequestData {
         keys?: Array<string>;
         itemId?: string;
         limit?: number;
+        /**
+         * Continuation token returned by the previous page.
+         */
         token?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLog.
+     */
     class ServerGetStatisticsLogRequestData extends GetStatisticsLogRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLog.
+     */
     class AdminGetStatisticsLogRequestData extends ServerGetStatisticsLogRequestData {
     }
+    /**
+     * Contains the optional fields requested through `InfoRequestParam`.
+     */
     class InfoResponseParameters {
         catalogId?: string;
         classId?: string;
         itemType?: number;
         amount?: number;
+        /**
+         * Owner descriptor mapped by the public `OwnerType` enum.
+         */
         owner?: GenericModels.OwnerItem;
         removeStatus?: GenericModels.RemoveStatusItem;
         segments?: Array<string>;
@@ -335,16 +717,31 @@ export declare namespace InventoryModels {
         itemDatas?: Array<GenericModels.DataItem>;
         itemStatistics?: Array<GenericModels.StatisticsItem>;
     }
+    /**
+     * Base inventory response envelope.
+     */
     class InventoryResponseData {
+        /**
+         * Optional field bag controlled by the corresponding `InfoRequestParam`.
+         */
         infoResponseParameters: InfoResponseParameters;
     }
+    /**
+     * Inventory envelope that also exposes the resolved item ID.
+     */
     class InventoryWithItemIdResponseData extends InventoryResponseData {
         itemId: string;
     }
+    /**
+     * Defines the response payload for InventoryLeaderboard.
+     */
     class InventoryLeaderboardResponseData extends InventoryWithItemIdResponseData {
         position: number;
         backupValue?: number;
     }
+    /**
+     * Describes one inventory-statistics change log entry.
+     */
     class InventoryLogResponseData {
         itemId: string;
         tsCreate: number;
@@ -354,20 +751,38 @@ export declare namespace InventoryModels {
         startValue: number;
         finalValue: number;
     }
+    /**
+     * Defines the response payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardResponseData {
         results: Array<InventoryLeaderboardResponseData>;
         tsCreate: number;
     }
+    /**
+     * Defines the response payload for InventoriesWithItemId.
+     */
     class InventoriesWithItemIdResponseData {
         results: Array<InventoryWithItemIdResponseData>;
     }
+    /**
+     * Defines the response payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardResponseData {
         results: Array<InventoryLeaderboardResponseData>;
     }
+    /**
+     * Returns one page of inventory statistics logs.
+     */
     class GetStatisticsLogResponseData {
         results: Array<InventoryLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }