@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -1,106 +1,324 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { InventoryModels } from "./InventoryModels";
+/**
+ * Typed response wrappers for the Inventory domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link InventoryModels}. The
+ * same wrapper is reused across the client / server / admin
+ * role variants because the response shape does not depend on
+ * the role.
+ *
+ * Many read operations resolve to a list-style envelope
+ * (`InventoryResponseData` or a derived shape) whose
+ * `infoResponseParameters` field is gated by the matching
+ * request DTO's `infoRequestParam` flags.
+ */
 export declare namespace InventoryResponseModels {
+    /**
+     * Maps the AddSegment operation to a typed response wrapper.
+     */
     class AddSegmentOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new AddSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAmount operation to a typed response wrapper.
+     */
     class GetAmountOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetAmountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAvatar operation to a typed response wrapper.
+     */
     class GetAvatarOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCatalogId operation to a typed response wrapper.
+     */
     class GetCatalogIdOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetCatalogIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetClassId operation to a typed response wrapper.
+     */
     class GetClassIdOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetClassIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCustomData operation to a typed response wrapper.
+     */
     class GetCustomDataOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetDisplayName operation to a typed response wrapper.
+     */
     class GetDisplayNameOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemData operation to a typed response wrapper.
+     */
     class GetItemDataOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetItemDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemInformation operation to a typed response wrapper.
+     */
     class GetItemInformationOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetItemInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemStatistics operation to a typed response wrapper.
+     */
     class GetItemStatisticsOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetItemStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemsWithDisplayName operation to a typed response wrapper.
+     */
     class GetItemsWithDisplayNameOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoriesWithItemIdResponseData> {
+        /**
+         * Creates a new GetItemsWithDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemsWithSegment operation to a typed response wrapper.
+     */
     class GetItemsWithSegmentOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoriesWithItemIdResponseData> {
+        /**
+         * Creates a new GetItemsWithSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemsWithTag operation to a typed response wrapper.
+     */
     class GetItemsWithTagOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoriesWithItemIdResponseData> {
+        /**
+         * Creates a new GetItemsWithTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetItemType operation to a typed response wrapper.
+     */
     class GetItemTypeOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetItemTypeOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetOwner operation to a typed response wrapper.
+     */
     class GetOwnerOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetOwnerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetRemoveStatus operation to a typed response wrapper.
+     */
     class GetRemoveStatusOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetRemoveStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetSegment operation to a typed response wrapper.
+     */
     class GetSegmentOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboardAroundItem operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardAroundItemOperationResponse extends CustomOperationResponseAbstract<InventoryModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardAroundItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<InventoryModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTag operation to a typed response wrapper.
+     */
     class GetTagOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTsCreate operation to a typed response wrapper.
+     */
     class GetTsCreateOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new GetTsCreateOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveSegment operation to a typed response wrapper.
+     */
     class RemoveSegmentOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveTag operation to a typed response wrapper.
+     */
     class RemoveTagOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetAmount operation to a typed response wrapper.
+     */
     class SetAmountOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new SetAmountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetAvatar operation to a typed response wrapper.
+     */
     class SetAvatarOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new SetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetCustomData operation to a typed response wrapper.
+     */
     class SetCustomDataOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new SetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetDisplayName operation to a typed response wrapper.
+     */
     class SetDisplayNameOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new SetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetItemData operation to a typed response wrapper.
+     */
     class SetItemDataOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new SetItemDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangeItemStatistics operation to a typed response wrapper.
+     */
     class ChangeItemStatisticsOperationResponse extends CustomOperationResponseAbstract<InventoryModels.InventoryResponseData> {
+        /**
+         * Creates a new ChangeItemStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetOwner operation to a typed response wrapper.
+     */
     class SetOwnerOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new SetOwnerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetRemoveStatus operation to a typed response wrapper.
+     */
     class SetRemoveStatusOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new SetRemoveStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetTag operation to a typed response wrapper.
+     */
     class SetTagOperationResponse extends CustomOperationResponseAbstract<InventoryModels.EmptyResponseData> {
+        /**
+         * Creates a new SetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCreateLeaderboard operation to a typed response wrapper.
+     */
     class GetCreateLeaderboardOperationResponse extends CustomOperationResponseAbstract<InventoryModels.GetCreateLeaderboardResponseData> {
+        /**
+         * Creates a new GetCreateLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLog operation to a typed response wrapper.
+     */
     class GetStatisticsLogOperationResponse extends CustomOperationResponseAbstract<InventoryModels.GetStatisticsLogResponseData> {
+        /**
+         * Creates a new GetStatisticsLogOperationResponse instance.
+         */
         constructor();
     }
 }