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

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

@@ -1,160 +1,492 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { GamePlayerModels } from "./GamePlayerModels";
+/**
+ * Typed response wrappers for the GamePlayer domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link GamePlayerModels}. The
+ * same wrapper class is reused across the
+ * client / server / admin role variants because the response
+ * shape does not depend on which role issued the request.
+ *
+ * Many read operations resolve to a profile-style envelope
+ * (`GamePlayerResponseData` or a derived shape) whose
+ * `infoResponseParameters` field is gated by the matching
+ * request DTO's `infoRequestParam` flags — only the fields the
+ * caller asked for are populated.
+ *
+ * Application code reads the typed payload through
+ * `response.responseData` after confirming
+ * `response.hasReturnCodeError() === false` and
+ * `response.errorCode === ErrorCode.Ok`.
+ */
 export declare namespace GamePlayerResponseModels {
+    /**
+     * Maps the AddPlayerFriend operation to a typed response wrapper.
+     */
     class AddPlayerFriendOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new AddPlayerFriendOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the AddSegment operation to a typed response wrapper.
+     */
     class AddSegmentOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new AddSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAvatar operation to a typed response wrapper.
+     */
     class GetAvatarOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCountryCode operation to a typed response wrapper.
+     */
     class GetCountryCodeOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetCountryCodeOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCustomData operation to a typed response wrapper.
+     */
     class GetCustomDataOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetDisplayName operation to a typed response wrapper.
+     */
     class GetDisplayNameOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFriendStatisticsLeaderboardAroundPlayer operation to a typed response wrapper.
+     */
     class GetFriendStatisticsLeaderboardAroundPlayerOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetFriendStatisticsLeaderboardAroundPlayerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFriendStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class GetFriendStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetFriendStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetIpAddressCreate operation to a typed response wrapper.
+     */
     class GetIpAddressCreateOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetIpAddressCreateOperationResponse instance.
+         */
         constructor();
     }
-    class GetOnlineStatusOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.OnlineStatusResponseData> {
+    /**
+     * Maps the GetOnlineStatus operation to a typed response wrapper.
+     */
+    class GetOnlineStatusOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetOnlineStatusOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerBan operation to a typed response wrapper.
+     */
     class GetPlayerBanOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerBanOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerCharacter operation to a typed response wrapper.
+     */
     class GetPlayerCharacterOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerCharacterOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerCurrency operation to a typed response wrapper.
+     */
     class GetPlayerCurrencyOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerCurrencyOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerData operation to a typed response wrapper.
+     */
     class GetPlayerDataOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerFriend operation to a typed response wrapper.
+     */
     class GetPlayerFriendOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerFriendOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerGroup operation to a typed response wrapper.
+     */
     class GetPlayerGroupOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerInformation operation to a typed response wrapper.
+     */
     class GetPlayerInformationOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerInventory operation to a typed response wrapper.
+     */
     class GetPlayerInventoryOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerInventoryOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayerStatistics operation to a typed response wrapper.
+     */
     class GetPlayerStatisticsOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetPlayerStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayersWithDisplayName operation to a typed response wrapper.
+     */
     class GetPlayersWithDisplayNameOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayersWithUserIdResponseData> {
+        /**
+         * Creates a new GetPlayersWithDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayersWithSegment operation to a typed response wrapper.
+     */
     class GetPlayersWithSegmentOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayersWithUserIdResponseData> {
+        /**
+         * Creates a new GetPlayersWithSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetPlayersWithTag operation to a typed response wrapper.
+     */
     class GetPlayersWithTagOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayersWithUserIdResponseData> {
+        /**
+         * Creates a new GetPlayersWithTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetSegment operation to a typed response wrapper.
+     */
     class GetSegmentOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboardAroundPlayer operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardAroundPlayerOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardAroundPlayerOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class GetStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetStatisticsLeaderboardResponseData> {
+        /**
+         * Creates a new GetStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTag operation to a typed response wrapper.
+     */
     class GetTagOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTsCreate operation to a typed response wrapper.
+     */
     class GetTsCreateOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetTsCreateOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetTsLastLogin operation to a typed response wrapper.
+     */
     class GetTsLastLoginOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new GetTsLastLoginOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateGroup operation to a typed response wrapper.
+     */
     class CreateGroupOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new CreateGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreatePlayerCharacter operation to a typed response wrapper.
+     */
     class CreatePlayerCharacterOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new CreatePlayerCharacterOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreatePlayerItem operation to a typed response wrapper.
+     */
     class CreatePlayerItemOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new CreatePlayerItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the JoinGroup operation to a typed response wrapper.
+     */
     class JoinGroupOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new JoinGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LeaveGroup operation to a typed response wrapper.
+     */
     class LeaveGroupOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new LeaveGroupOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemovePlayerCharacter operation to a typed response wrapper.
+     */
     class RemovePlayerCharacterOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemovePlayerCharacterOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemovePlayerFriend operation to a typed response wrapper.
+     */
     class RemovePlayerFriendOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemovePlayerFriendOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemovePlayerItem operation to a typed response wrapper.
+     */
     class RemovePlayerItemOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemovePlayerItemOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveSegment operation to a typed response wrapper.
+     */
     class RemoveSegmentOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveSegmentOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveTag operation to a typed response wrapper.
+     */
     class RemoveTagOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetAvatar operation to a typed response wrapper.
+     */
     class SetAvatarOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetAvatarOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetCountryCode operation to a typed response wrapper.
+     */
     class SetCountryCodeOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetCountryCodeOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetCustomData operation to a typed response wrapper.
+     */
     class SetCustomDataOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new SetCustomDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetDisplayName operation to a typed response wrapper.
+     */
     class SetDisplayNameOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetDisplayNameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetPlayerBan operation to a typed response wrapper.
+     */
     class SetPlayerBanOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetPlayerBanOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangePlayerCurrency operation to a typed response wrapper.
+     */
     class ChangePlayerCurrencyOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new ChangePlayerCurrencyOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetPlayerData operation to a typed response wrapper.
+     */
     class SetPlayerDataOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new SetPlayerDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ChangePlayerStatistics operation to a typed response wrapper.
+     */
     class ChangePlayerStatisticsOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GamePlayerResponseData> {
+        /**
+         * Creates a new ChangePlayerStatisticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetTag operation to a typed response wrapper.
+     */
     class SetTagOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.EmptyResponseData> {
+        /**
+         * Creates a new SetTagOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCurrencyLeaderboard operation to a typed response wrapper.
+     */
     class GetCurrencyLeaderboardOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetCurrencyLeaderboardResponseData> {
+        /**
+         * Creates a new GetCurrencyLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetLastLoginLeaderboard operation to a typed response wrapper.
+     */
     class GetLastLoginLeaderboardOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetLastLoginLeaderboardResponseData> {
+        /**
+         * Creates a new GetLastLoginLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCreateLeaderboard operation to a typed response wrapper.
+     */
     class GetCreateLeaderboardOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetCreateLeaderboardResponseData> {
+        /**
+         * Creates a new GetCreateLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetStatisticsLog operation to a typed response wrapper.
+     */
     class GetStatisticsLogOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetStatisticsLogResponseData> {
+        /**
+         * Creates a new GetStatisticsLogOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetCurrencyLog operation to a typed response wrapper.
+     */
     class GetCurrencyLogOperationResponse extends CustomOperationResponseAbstract<GamePlayerModels.GetCurrencyLogResponseData> {
+        /**
+         * Creates a new GetCurrencyLogOperationResponse instance.
+         */
         constructor();
     }
 }

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

@@ -1,59 +1,153 @@
+/**
+ * Cross-domain DTOs shared by every API namespace in the SDK.
+ *
+ * The classes in this namespace are deliberately agnostic of
+ * any single domain — they describe small, reusable building
+ * blocks (avatar entries, key-value pairs, currency entries,
+ * statistics entries, friend / group / member references,
+ * inventory references, ban entries, ...) that appear inside
+ * the larger request / response DTOs of the per-domain models.
+ *
+ * The lookup helpers on {@link GNUtils} consume the array
+ * forms directly:
+ * - `toFriendDictionary(friends)` → `Map<string, FriendItem>`
+ * - `toGroupDictionary(groups)` → `Map<string, GroupItem>`
+ * - `toCurrenciesDictionary(currencies)` →
+ *   `Map<string, CurrencyItem>`
+ * - `toStatisticsDictionary(stats)` →
+ *   `Map<string, StatisticsItem>`
+ * - and similar for tags / data items / inventory items.
+ *
+ * All field decorators here use canonical wire keys from
+ * {@link ParameterCode} so the same shape decodes consistently
+ * across every domain that embeds these items.
+ */
 export declare namespace GenericModels {
+    /**
+     * Represents a generic avatar payload.
+     */
     class AvatarItem {
+        /** Backend-defined avatar type identifier. The public SDK currently does not export a dedicated avatar enum. */
         type: number;
+        /** Avatar value, typically a URL, file id, or provider-specific string. */
         value: string;
     }
+    /**
+     * Represents a key-value tag entry.
+     */
     class TagItem {
+        /** Tag key used to identify the metadata entry. */
         key: string;
+        /** Tag value associated with `key`. */
         value: string;
     }
+    /**
+     * Represents a ban state entry returned by player-auth or player-profile flows.
+     */
     class BanItem {
+        /** Expiration timestamp of the current ban state. */
         tsExpire: number;
+        /** Human-readable ban reason when provided by the backend. */
         reason: string;
     }
+    /**
+     * Represents an arbitrary key-value data entry.
+     */
     class DataItem {
+        /** Data entry key used to identify the payload. */
         key: string;
+        /** Raw value returned by the backend. This may be a primitive, `GNHashtable`, `GNArray`, or plain object-like data. */
         value: any;
     }
+    /**
+     * Represents one currency entry.
+     */
     class CurrencyItem {
+        /** Currency key such as the configured currency code or logical name. */
         key: string;
+        /** Numeric balance of the currency identified by `key`. */
         value: number;
     }
+    /**
+     * Represents one statistics entry.
+     */
     class StatisticsItem {
+        /** Statistic key such as the configured metric name. */
         key: string;
+        /** Numeric value of the statistic identified by `key`. */
         value: number;
     }
+    /**
+     * Represents a lightweight relation item pointing to a character.
+     */
     class CharacterItem {
+        /** Character identifier of the related character entity. */
         characterId: string;
+        /** Catalog identifier associated with the related character. */
         catalogId: string;
     }
+    /**
+     * Represents the current owner of an entity such as an inventory item.
+     */
     class OwnerItem {
+        /** Owner type. Map this value with the public `OwnerType` enum. */
         type: number;
+        /** Owner id paired with `type`. */
         id: string;
     }
+    /**
+     * Represents soft-remove metadata for an entity.
+     */
     class RemoveStatusItem {
+        /** Removal timestamp when the entity was soft-removed. */
         tsRemove: number;
+        /** Removal reason when the backend provides one. */
         reason?: string;
     }
+    /**
+     * Represents a lightweight relation item pointing to an inventory item.
+     */
     class InventoryItem {
+        /** Inventory item identifier of the related item entity. */
         itemId: string;
+        /** Catalog identifier associated with the related inventory item. */
         catalogId: string;
+        /** Class identifier associated with the related inventory item. */
         classId: string;
     }
+    /**
+     * Represents a lightweight relation item pointing to a group.
+     */
     class GroupItem {
+        /** Group identifier of the related group entity. */
         groupId: string;
+        /** Catalog identifier associated with the related group. */
         catalogId: string;
+        /** Group relation status. Map this value with the public `GroupStatus` enum. */
         status: number;
+        /** Timestamp of the last group status change. */
         tsLastStatusUpdate: number;
     }
+    /**
+     * Represents a lightweight relation item pointing to a friend relation.
+     */
     class FriendItem {
+        /** Friend identifier of the related friend entity. */
         friendId: string;
+        /** Catalog identifier associated with the related friend entity. */
         catalogId: string;
+        /** Friend relation status. Map this value with the public `FriendStatus` enum. */
         status: number;
+        /** Timestamp of the last friend status change. */
         tsLastStatusUpdate: number;
     }
+    /**
+     * Represents a lightweight relation item pointing to a group member.
+     */
     class MemberItem {
+        /** Member identifier of the related group member. */
         memberId: string;
+        /** Member relation status. Map this value with the public member-status enum when available. */
         status: number;
     }
 }