@xmobitea/gn-typescript-client 2.6.13-tsc → 2.6.14

package/dist/runtime/constant/OperationCode.d.ts

@@ -1,4 +1,32 @@
+/**
+ * Canonical operation-code strings recognised by the GearN backend.
+ *
+ * Every typed `*OperationRequest` wrapper sets one of these values
+ * as its `operationCode`, the SDK transports embed the value into
+ * the wire frame produced by {@link OperationHelper.toSocketData}
+ * and the URL produced by {@link HttpPeer.send}, and log lines
+ * surface the same string for traceability.
+ *
+ * Grouping inside this class mirrors the backend's capability
+ * areas (dashboard / authenticate / link / unlink / character /
+ * game-player / master-player / group / inventory / store /
+ * multiplayer / cloudscript / content). Each group maps roughly
+ * to a {@link RequestType} value and to a public `*Api`
+ * namespace on {@link GNNetwork}, but the mapping is not strictly
+ * one-to-one: dashboard operations span several `*Api` instances
+ * (`.dashboard`, `.authenticate.admin`, ...) because the backend
+ * resolves the role from the auth token rather than from a
+ * dedicated request type.
+ *
+ * Adding a new code: extend the matching group and ship a typed
+ * wrapper that references the new name, plus the matching method
+ * on the relevant `*Api` class. Renaming an existing code requires
+ * a coordinated backend change.
+ */
 export declare class OperationCode {
+    /**
+     * Dashboard and administrative maintenance operations.
+     */
     static readonly LoginByAdminAccount: string;
     static readonly ChangePasswordAdminAccount: string;
     static readonly GetGameList: string;
@@ -25,6 +53,9 @@ export declare class OperationCode {
     static readonly GetBackupStatisticsLeaderboardVersion: string;
     static readonly GetServerGameData: string;
     static readonly DeleteInDatabase: string;
+    /**
+     * Client authentication and account-bootstrap operations.
+     */
     static readonly LoginByAccount: string;
     static readonly LoginByAndroidDeviceId: string;
     static readonly LoginByApple: string;
@@ -40,6 +71,9 @@ export declare class OperationCode {
     static readonly LoginByWindowsDeviceId: string;
     static readonly LoginByWindowsPhoneDeviceId: string;
     static readonly RegisterAccount: string;
+    /**
+     * External identity link operations for existing accounts.
+     */
     static readonly LinkAccount: string;
     static readonly LinkAndroidDeviceId: string;
     static readonly LinkApple: string;
@@ -54,6 +88,9 @@ export declare class OperationCode {
     static readonly LinkMacOSDeviceId: string;
     static readonly LinkWindowsDeviceId: string;
     static readonly LinkWindowsPhoneDeviceId: string;
+    /**
+     * External identity unlink operations for existing accounts.
+     */
     static readonly UnlinkAccount: string;
     static readonly UnlinkAndroidDeviceId: string;
     static readonly UnlinkApple: string;
@@ -68,6 +105,9 @@ export declare class OperationCode {
     static readonly UnlinkMacOSDeviceId: string;
     static readonly UnlinkWindowsDeviceId: string;
     static readonly UnlinkWindowsPhoneDeviceId: string;
+    /**
+     * Shared profile metadata operations reused across player-like entities.
+     */
     static readonly AddSegment: string;
     static readonly RemoveSegment: string;
     static readonly GetSegment: string;
@@ -96,6 +136,9 @@ export declare class OperationCode {
     static readonly GetCustomData: string;
     static readonly SetPlayerData: string;
     static readonly GetPlayerData: string;
+    /**
+     * Composite profile and search operations.
+     */
     static readonly GetPlayerInformation: string;
     static readonly GetPlayersWithApple: string;
     static readonly GetPlayersWithFacebook: string;
@@ -144,7 +187,7 @@ export declare class OperationCode {
     static readonly GetItemInformation: string;
     static readonly GetAmount: string;
     static readonly GetItemType: string;
-    static readonly SetTsLastLogin: string;
+    static readonly UpdateTsLastLogin: string;
     static readonly SetRemoveStatus: string;
     static readonly SetAmount: string;
     static readonly RemoveGroup: string;
@@ -161,6 +204,9 @@ export declare class OperationCode {
     static readonly SetOwner: string;
     static readonly RemoveGroupItem: string;
     static readonly GetClassId: string;
+    /**
+     * Store catalog and commerce operations.
+     */
     static readonly GetStoreItemInformation: string;
     static readonly GetStoreItemsWithTag: string;
     static readonly CreateStoreItem: string;
@@ -173,6 +219,9 @@ export declare class OperationCode {
     static readonly GetFriendStatisticsLeaderboard: string;
     static readonly SetEmail: string;
     static readonly GetEmail: string;
+    /**
+     * Content/file metadata upload and download operations.
+     */
     static readonly CreateNewFileUploadInfo: string;
     static readonly GetFileUploadInfo: string;
     static readonly RequestDownloadFileUploadInfo: string;
@@ -180,6 +229,9 @@ export declare class OperationCode {
     static readonly GetFileUploadInfoList: string;
     static readonly SetStoreItemInformation: string;
     static readonly RefreshAuthToken: string;
+    /**
+     * Multiplayer matchmaking and match-query operations.
+     */
     static readonly CancelAllMatchmakingTicket: string;
     static readonly CancelMatchmakingTicket: string;
     static readonly CreateMatchmakingTicket: string;
@@ -189,11 +241,17 @@ export declare class OperationCode {
     static readonly JoinMatchmakingTicket: string;
     static readonly ListMatchmakingTicketsForPlayer: string;
     static readonly GetCurrencyLeaderboard: string;
+    /**
+     * CloudScript management and execution operations.
+     */
     static readonly ExecuteFunction: string;
     static readonly GetFunctions: string;
     static readonly AddFunction: string;
     static readonly EditFunction: string;
     static readonly GetFunction: string;
+    /**
+     * Provider-specific platform login/link/unlink and lookup operations.
+     */
     static readonly LoginByGooglePlayGameService: string;
     static readonly LoginByGameCenter: string;
     static readonly LinkGooglePlayGameService: string;
@@ -204,18 +262,33 @@ export declare class OperationCode {
     static readonly GetPlayersWithGameCenter: string;
     static readonly GetLastLoginLeaderboard: string;
     static readonly GetCreateLeaderboard: string;
+    /**
+     * Administrative multiplayer inspection operations.
+     */
     static readonly GetAllMatchmakingTicket: string;
     static readonly GetAllMatch: string;
+    /**
+     * Event-delivery, audit-log, and realtime utility operations.
+     */
     static readonly SendSocketOperationEvent: string;
     static readonly GetStatisticsLog: string;
     static readonly GetCurrencyLog: string;
+    /**
+     * Store gifting and store-log inspection operations.
+     */
     static readonly PresentStoreItem: string;
     static readonly GetStoreLog: string;
+    /**
+     * Outbound email and push-notification operations.
+     */
     static readonly SendEmail: string;
     static readonly SendPushNotification: string;
     static readonly AddPushNotification: string;
     static readonly RemovePushNotification: string;
     static readonly GetPushNotification: string;
+    /**
+     * Post-purchase store-usage tracking operations.
+     */
     static readonly GetStoreUsed: string;
     static readonly RemoveStoreUsed: string;
 }

package/dist/runtime/constant/ReturnCode.d.ts

@@ -1,14 +1,86 @@
+/**
+ * Transport-level return codes surfaced through
+ * {@link OperationResponse.getReturnCode}.
+ *
+ * These codes describe **transport**, gateway, authorisation,
+ * validation, throttling and operation-level execution status —
+ * **not** business-domain errors. Domain errors travel inside
+ * successful responses through {@link ErrorCode} and are checked
+ * only after the transport return code is `Ok`.
+ *
+ * Wire-protocol contract: the codes here are mirrored verbatim
+ * onto every response, plus synthesised by
+ * {@link PeerBase.service} for client-side timeouts. Adding a new
+ * value requires a coordinated backend change.
+ *
+ * Read order for callers:
+ * 1. Inspect {@link OperationResponse.getReturnCode} (or the
+ *    typed wrapper's {@link CustomOperationResponse.hasReturnCodeError}).
+ *    Anything other than {@link Ok} indicates a transport failure.
+ * 2. When the return code is {@link Ok}, switch to the business
+ *    layer and inspect `errorCode` (from {@link ErrorCode}) on the
+ *    typed response.
+ *
+ * Value conventions:
+ * - `1`: the request completed successfully at the protocol level.
+ * - `0`: the request failed without a more specific mapped return
+ *   code.
+ * - negative values: the request was rejected, timed out, or
+ *   failed before a valid business response could be produced.
+ */
 export declare class ReturnCode {
+    /**
+     * The selected secret key is missing, wrong, or does not match the current route/game context.
+     */
     static readonly SecretInvalid: number;
+    /**
+     * The serialized request payload exceeded the maximum size accepted by the backend.
+     */
     static readonly MaxSizeRequestReject: number;
+    /**
+     * The backend rejected the request because the current caller exceeded a request-rate limit.
+     */
     static readonly MaxRequestReject: number;
+    /**
+     * The backend rejected the request because the current concurrent-user/session limit was exceeded.
+     */
     static readonly MaxCCUReject: number;
+    /**
+     * The target operation exists, but the caller is not authorized for the selected role or target resource.
+     */
     static readonly OperationNotAuthorized: number;
+    /**
+     * The request shape or one or more request-member values are invalid.
+     * When available, inspect `invalidMembers` for field-level details.
+     */
     static readonly InvalidRequestParameters: number;
+    /**
+     * The requested operation code is unknown or is not valid for the selected request type/role.
+     */
     static readonly OperationInvalid: number;
+    /**
+     * The backend hit an unhandled internal failure before producing a valid business response.
+     */
     static readonly InternalServerError: number;
+    /**
+     * The operation is known and the secret key is valid, but the permission rules attached
+     * to the current secret key do not allow this operation in the current target context.
+     * This usually maps to missing `selfEnable`, `otherSelfEnable`, `serverSelfEnable`,
+     * or `adminSelfEnable` permission for the resolved request.
+     */
     static readonly OperationNotAllow: number;
+    /**
+     * The request timed out before a response was received.
+     * This code may be synthesized by the SDK timeout layer as well as returned by the backend.
+     */
     static readonly OperationTimeout: number;
+    /**
+     * The request failed, but no more specific low-level return code was mapped.
+     */
     static readonly UnknownError: number;
+    /**
+     * The request completed successfully at protocol level and produced a response payload.
+     * Callers must still validate the business `errorCode` in that payload.
+     */
     static readonly Ok: number;
 }

package/dist/runtime/constant/enumType/ExecuteResponseStatus.d.ts

@@ -1,7 +1,38 @@
+/**
+ * Result discriminator returned by `executeFunction*` operations on
+ * `GNNetwork.cloudScript`.
+ *
+ * CloudScript runs server-side scripts on demand — this enum
+ * distinguishes the four well-known failure modes from a clean
+ * success so the application can show the right error message.
+ *
+ * Surfaced on
+ * `CloudScriptModels.ExecuteFunctionResponseData.executeResponseStatus`.
+ */
 export declare enum ExecuteResponseStatus {
+    /**
+     * Function ran to completion and returned a result. Inspect
+     * `executeResult` for the script's output.
+     */
     Ok = 1,
+    /**
+     * Function ran but threw an exception. Inspect
+     * `executeException` / `debugMessage` for the captured error.
+     */
     Exception = 2,
+    /**
+     * The script version exists but does not export a function
+     * with the requested name.
+     */
     FunctionNameNotFound = 3,
+    /**
+     * The selected script version is invalid, missing, or has
+     * been retired.
+     */
     VersionInvalid = 4,
+    /**
+     * The function exceeded the configured execution-time limit
+     * and was aborted.
+     */
     Timeout = 5
 }

package/dist/runtime/constant/enumType/FriendStatus.d.ts

@@ -1,6 +1,45 @@
+/**
+ * Lifecycle states for a friend relationship between two
+ * GearN players.
+ *
+ * The state describes the relationship from the perspective of the
+ * **viewing** player — the same friendship reads as
+ * `WaitingAccept` for the side that received the invite and
+ * `SentRequestAndWaitingAccept` for the side that sent it.
+ *
+ * The numeric values are persisted into the
+ * {@link CharacterPlayerFriendUpdate} / {@link GamePlayerFriendUpdate}
+ * payloads (decoded from the wire as `FriendItem.status`) and are
+ * therefore part of the stable backend contract — do not reorder.
+ *
+ * Typical state transitions:
+ * - `NotFriend` → `SentRequestAndWaitingAccept` after the local
+ *   player issues `acceptCharacterPlayerFriend` /
+ *   `addGamePlayerFriend` (or equivalent).
+ * - `WaitingAccept` → `Friend` once the remote player accepts.
+ * - Any state → `NotFriend` after a `removeFriend` call.
+ */
 export declare enum FriendStatus {
+    /**
+     * Both sides have accepted; the relationship is active.
+     */
     Friend = 1,
+    /**
+     * The viewing player received an invite and has not acted on
+     * it yet. Use this state to show "Accept / Decline" UI.
+     */
     WaitingAccept = 2,
+    /**
+     * The viewing player sent an invite and is waiting for the
+     * other side to accept. Use this state to show
+     * "Cancel request" UI.
+     */
     SentRequestAndWaitingAccept = 3,
+    /**
+     * No friendship relation. This is the implicit value when the
+     * backend has no row at all — the SDK still includes it
+     * explicitly so list queries can express "all known players,
+     * none friended yet".
+     */
     NotFriend = 4
 }

package/dist/runtime/constant/enumType/GoogleLoginType.d.ts

@@ -1,4 +1,27 @@
+/**
+ * Discriminator for the Google credential supplied to
+ * `loginByGoogle` / `linkGoogle`.
+ *
+ * Google's identity stack issues two distinct token types. The
+ * GearN backend cannot tell them apart from the wire, so the
+ * client passes this enum alongside the `token` field to indicate
+ * which validation path the backend should run.
+ *
+ * Used by {@link AuthenticateModels.LoginByGoogleRequestData.type}
+ * and the matching `linkGoogle` model.
+ */
 export declare enum GoogleLoginType {
+    /**
+     * OAuth 2.0 access token obtained from a server-side or client
+     * SDK login flow. Validated by the backend by introspecting
+     * the token against Google's userinfo endpoint.
+     */
     AccessToken = 1,
+    /**
+     * OpenID Connect ID token (JWT). Validated by the backend by
+     * verifying the signature against Google's published JWKS.
+     * Preferred for native sign-in flows because the JWT contains
+     * the user identity directly.
+     */
     IdToken = 2
 }

package/dist/runtime/constant/enumType/GroupStatus.d.ts

@@ -1,6 +1,38 @@
+/**
+ * Lifecycle states for a player's membership in a group.
+ *
+ * Mirrors {@link FriendStatus} but for group membership. The state
+ * describes the relationship from the perspective of the **viewing**
+ * player — the same pending invitation reads as `WaitingAccept` for
+ * the player that received it and `SentRequestAndWaitingAccept` for
+ * the player that asked to join.
+ *
+ * The numeric values are persisted into
+ * {@link CharacterPlayerGroupUpdate} / {@link GamePlayerGroupUpdate}
+ * payloads (decoded as `GroupItem.status`) and are part of the
+ * stable backend contract.
+ */
 export declare enum GroupStatus {
+    /**
+     * The player is an active member of the group with full
+     * membership privileges (subject to role).
+     */
     Member = 1,
+    /**
+     * The player received an invitation and has not acted on it
+     * yet. Use to show "Accept / Decline" UI.
+     */
     WaitingAccept = 2,
+    /**
+     * The player asked to join the group and is waiting for an
+     * existing member with the right permission to accept. Use to
+     * show "Cancel request" UI.
+     */
     SentRequestAndWaitingAccept = 3,
+    /**
+     * No active membership. Like {@link FriendStatus.NotFriend},
+     * this state is explicit so list queries can include
+     * non-member players too.
+     */
     NotMember = 4
 }

package/dist/runtime/constant/enumType/InvalidMemberType.d.ts

@@ -1,17 +1,92 @@
+/**
+ * Validation failure categories used by the GearN backend when it
+ * rejects a malformed request.
+ *
+ * Each entry describes **why** a specific request parameter failed
+ * validation. The backend ships a list of `[code, type]` pairs in
+ * the `invalidRequestParameters` array of a response with
+ * `ReturnCode.InvalidRequestParameters`; the SDK decodes those
+ * pairs into typed {@link InvalidMember} entries accessible via
+ * {@link OperationResponse.getInvalidMembers}.
+ *
+ * The categories cover the validation rules declared by the
+ * `@*DataMember` decorator family:
+ * - `*Null` — `mustNonNull = true` was violated.
+ * - `*MinLength` / `*MaxLength` — string / hashtable / array
+ *   length bounds.
+ * - `Number*` — numeric range / integer constraints.
+ * - `DataRequired` — the parameter was missing entirely.
+ * - `TypeInvalid` — the value was present but had the wrong
+ *   runtime type.
+ * - `UnknownError` — backend-side rejection that does not map to
+ *   any of the above.
+ */
 export declare enum InvalidMemberType {
+    /**
+     * Catch-all category for backend-side validation rejections
+     * that do not fit any of the structured cases below.
+     */
     UnknownError = 1,
+    /**
+     * The parameter is required but the request did not include
+     * it (the wire payload had no entry for the matching `code`).
+     */
     DataRequired = 2,
+    /**
+     * The parameter was present but had a runtime type the backend
+     * did not expect (e.g. a number where a string was declared).
+     */
     TypeInvalid = 3,
+    /**
+     * `@StringDataMember({ mustNonNull: true })` was violated — the
+     * value was `null`.
+     */
     StringNull = 4,
+    /**
+     * String length is below the configured `minLength`.
+     */
     StringMinLength = 5,
+    /**
+     * String length is above the configured `maxLength`.
+     */
     StringMaxLength = 6,
+    /**
+     * Numeric value is below the configured `minValue`.
+     */
     NumberMinValue = 7,
+    /**
+     * Numeric value is above the configured `maxValue`.
+     */
     NumberMaxValue = 8,
+    /**
+     * `@NumberDataMember({ mustInt: true })` was violated — the
+     * value was a fractional number.
+     */
     NumberMustInt = 9,
+    /**
+     * `@GNHashtableDataMember({ mustNonNull: true })` was violated.
+     */
     GNHashtableNull = 10,
+    /**
+     * `GNHashtable` member key count is below the configured
+     * `minLength`.
+     */
     GNHashtableMinLength = 11,
+    /**
+     * `GNHashtable` member key count is above the configured
+     * `maxLength`.
+     */
     GNHashtableMaxLength = 12,
+    /**
+     * `@GNArrayDataMember({ mustNonNull: true })` was violated.
+     */
     GNArrayNull = 13,
+    /**
+     * `GNArray` element count is below the configured `minLength`.
+     */
     GNArrayMinLength = 14,
+    /**
+     * `GNArray` element count is above the configured `maxLength`.
+     */
     GNArrayMaxLength = 15
 }

package/dist/runtime/constant/enumType/ItemType.d.ts

@@ -1,4 +1,27 @@
+/**
+ * Stacking discriminator for inventory item catalog entries.
+ *
+ * Decides how the GearN backend tracks ownership when a player
+ * acquires multiple units of the same catalog item — as separate
+ * ledger rows ({@link NonStackable}) or as a single row with an
+ * integer amount ({@link Stackable}).
+ *
+ * Configured at catalog setup time and surfaced on
+ * `InventoryModels.ItemMetadata.itemType`. The SDK does not
+ * convert between the two on the fly — choose the value that
+ * matches the gameplay semantics of the item.
+ */
 export declare enum ItemType {
+    /**
+     * Each acquisition produces a unique inventory row with its
+     * own item id. Use for items that need to track per-instance
+     * state (durability, custom name, equipped slot, ...).
+     */
     NonStackable = 1,
+    /**
+     * Repeated acquisitions accumulate into a single inventory
+     * row whose `amount` field carries the count. Use for
+     * fungible currencies-as-items, consumables, materials.
+     */
     Stackable = 2
 }

package/dist/runtime/constant/enumType/MatchStatus.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Lifecycle states for the **match** record produced once a
+ * matchmaking ticket succeeds.
+ *
+ * Distinct from {@link MatchmakingTicketStatus}, which tracks the
+ * earlier stages (waiting for members, finding a match). A single
+ * ticket eventually produces one match record whose state then
+ * progresses through the values below until the gameplay session
+ * starts or is cancelled.
+ *
+ * Surfaced on `MultiplayerModels.MatchEntry.status`.
+ */
+export declare enum MatchStatus {
+    /**
+     * The match was created but the dedicated server allocation
+     * has not yet completed. Connection details are unavailable.
+     */
+    WaitingForServer = 1,
+    /**
+     * The dedicated server is ready and the match record carries
+     * connection details. The application can connect.
+     */
+    Matched = 2,
+    /**
+     * The match was cancelled before completion (server
+     * allocation failure, manual cancel). Application should
+     * abort the lobby flow.
+     */
+    Canceled = 3
+}

package/dist/runtime/constant/enumType/MatchmakingMemberStatus.d.ts

@@ -1,5 +1,29 @@
+/**
+ * Per-member state inside a matchmaking ticket.
+ *
+ * GearN tickets can include multiple players (party / pre-made
+ * group matchmaking). Each player has their own independent
+ * confirmation lifecycle described by this enum. Once every
+ * member is `Joined`, the ticket can transition out of
+ * {@link MatchmakingTicketStatus.WaitingForMembers}.
+ *
+ * Surfaced on
+ * `MultiplayerModels.TicketMember.matchmakingMemberStatus`.
+ */
 export declare enum MatchmakingMemberStatus {
+    /**
+     * The ticket creator declared the member but the player has
+     * not joined / confirmed yet (e.g. invitation pending).
+     */
     Pending = 1,
+    /**
+     * The member confirmed and is part of the active ticket.
+     */
     Joined = 2,
+    /**
+     * The member declined or left the ticket. The ticket may
+     * still complete if it had enough remaining members; the SDK
+     * keeps the cancelled entry in the roster for audit purposes.
+     */
     Canceled = 3
 }

package/dist/runtime/constant/enumType/MatchmakingTicketStatus.d.ts

@@ -1,7 +1,41 @@
+/**
+ * Lifecycle states for a matchmaking ticket.
+ *
+ * Tickets progress through these states in order: members confirm,
+ * the matchmaking engine searches, a match is allocated, and
+ * finally the dedicated server reports ready. Cancellation can
+ * happen from any state.
+ *
+ * Distinct from {@link MatchStatus}, which describes the **match**
+ * record produced once the ticket succeeds.
+ *
+ * Surfaced on `MultiplayerModels.TicketEntry.status`.
+ */
 export declare enum MatchmakingTicketStatus {
+    /**
+     * Some declared members have not joined the ticket yet — see
+     * {@link MatchmakingMemberStatus.Pending}.
+     */
     WaitingForMembers = 1,
+    /**
+     * All members are joined; the matchmaking engine is searching
+     * for opponents matching the ticket's queue / criteria.
+     */
     WaitingForMatch = 2,
+    /**
+     * A match was found; the backend is provisioning the
+     * dedicated server. Connection details are not yet available.
+     */
     WaitingForServer = 3,
+    /**
+     * The dedicated server is ready and the ticket points at a
+     * match record. Use the match id to look up
+     * {@link MatchStatus.Matched} connection details.
+     */
     Matched = 4,
+    /**
+     * The ticket was cancelled before completion (member declined,
+     * matchmaking timed out, server allocation failed).
+     */
     Canceled = 5
 }

package/dist/runtime/constant/enumType/OwnerType.d.ts

@@ -1,8 +1,48 @@
+/**
+ * Discriminator for the entity that owns a given resource (an
+ * inventory row, a stored data item, a currency balance, ...).
+ *
+ * GearN keeps its data model normalised around a top-level
+ * "owner" concept so the same resource type can attach to a
+ * master player, a single character, a group, a store,
+ * etc. The wire payload always pairs an `OwnerType` with the
+ * owner's id.
+ *
+ * Surfaced through `GenericModels` resource entries (currency,
+ * statistics, custom data) and `InventoryModels.InventoryItem`.
+ */
 export declare enum OwnerType {
+    /**
+     * Master-player account — the top-level user record (one per
+     * GearN account). Use for cross-character resources like
+     * account-level wallets or profile metadata.
+     */
     MasterPlayer = 1,
+    /**
+     * Game-player entity — the per-game profile attached to a
+     * master player. Use for resources scoped to a single game
+     * but shared across that game's characters.
+     */
     GamePlayer = 2,
+    /**
+     * Character-player entity — the per-character profile.
+     * Use for resources isolated to a single in-game character.
+     */
     CharacterPlayer = 3,
+    /**
+     * Group entity — guild / clan. Use for shared group
+     * inventories, group currencies, group statistics.
+     */
     Group = 4,
+    /**
+     * Inventory item — an inventory row may itself own nested
+     * resources (e.g. socketed gems on an equipment item).
+     */
     Inventory = 5,
+    /**
+     * Store-inventory entity — a store catalog or its
+     * configuration row. Used by audit / analytics flows that
+     * track resources tied to a specific storefront.
+     */
     StoreInventory = 6
 }