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

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

@@ -1,8 +1,47 @@
 import { GenericModels } from "./GenericModels";
+/**
+ * Reusable request and response DTOs for the CharacterPlayer
+ * domain.
+ *
+ * CharacterPlayer operations target a **single in-game
+ * character** rather than the account-level player record.
+ * Because a single GearN account can own multiple characters,
+ * every public route — including the client-flavoured
+ * variants — requires an explicit `characterId` rather than
+ * inferring the target from the authenticated user.
+ *
+ * Three role variants per operation:
+ * - **Client** (no prefix): used by `GNNetwork.characterPlayer`,
+ *   targets a character owned by the authenticated user. The
+ *   backend cross-checks ownership.
+ * - **`Server*`**: used by `GNNetwork.characterPlayer.server`,
+ *   targets any character. Requires server `secretKey`.
+ * - **`Admin*`**: used by `GNNetwork.characterPlayer.admin`,
+ *   targets any character with admin privileges and
+ *   bypass-validation knobs.
+ *
+ * Validation rules declared on each `@*DataMember` decorator
+ * are enforced server-side; failures surface as
+ * {@link InvalidMember} entries with the matching
+ * {@link InvalidMemberType} code.
+ */
 export declare namespace CharacterPlayerModels {
+    /**
+     * Selects which optional character-player fields and lightweight relations should be returned.
+     * Boolean flags default to `false`; key arrays narrow list-style fields to specific keys only.
+     */
     class InfoRequestParam {
+        /**
+         * Includes the character catalog ID.
+         */
         catalogId?: boolean;
+        /**
+         * Includes the current owner descriptor.
+         */
         owner?: boolean;
+        /**
+         * Includes the remove-state descriptor.
+         */
         removeStatus?: boolean;
         segments?: boolean;
         customDatas?: boolean;
@@ -17,8 +56,17 @@ export declare namespace CharacterPlayerModels {
         ipAddressCreate?: boolean;
         countryCode?: boolean;
         tsLastLogin?: boolean;
+        /**
+         * Includes relation items for inventory owned by the character, optionally filtered by `itemCatalogIds`.
+         */
         playerInventories?: boolean;
+        /**
+         * Includes relation items for groups joined or owned by the character, optionally filtered by `groupCatalogIds`.
+         */
         playerGroups?: boolean;
+        /**
+         * Includes relation items for friends attached to the character, optionally filtered by `friendCatalogIds`.
+         */
         playerFriends?: boolean;
         playerDataKeys?: Array<string>;
         playerCurrencyKeys?: Array<string>;
@@ -26,82 +74,172 @@ export declare namespace CharacterPlayerModels {
         customDataKeys?: Array<string>;
         tagKeys?: Array<string>;
         characterCatalogIds?: Array<string>;
+        /**
+         * Restricts `playerInventories` to relation items whose catalog IDs match this list.
+         */
         itemCatalogIds?: Array<string>;
+        /**
+         * Restricts `playerGroups` to relation items whose catalog IDs match this list.
+         */
         groupCatalogIds?: Array<string>;
+        /**
+         * Restricts `playerFriends` to relation items whose catalog IDs match this list.
+         */
         friendCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the reusable parameter block PlayerStatisticsParam.
+     */
     class PlayerStatisticsParam {
         key: string;
         value: number;
     }
+    /**
+     * Defines the reusable parameter block PlayerDataParam.
+     */
     class PlayerDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Defines the reusable parameter block PlayerCurrencyParam.
+     */
     class PlayerCurrencyParam {
         key: string;
         amount: number;
     }
+    /**
+     * Defines the reusable parameter block CustomDataParam.
+     */
     class CustomDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Describes one game-player member included when creating a group from a character context.
+     */
     class GroupMemberParam {
-        userId: string;
+        characterId: string;
     }
+    /**
+     * Defines the request payload for AddPlayerFriend.
+     */
     class AddPlayerFriendRequestData {
         characterId: string;
         friendId: string;
         catalogId: string;
     }
+    /**
+     * Defines the request payload for ServerAddPlayerFriend.
+     */
     class ServerAddPlayerFriendRequestData extends AddPlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for AdminAddPlayerFriend.
+     */
     class AdminAddPlayerFriendRequestData extends ServerAddPlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for AddSegment.
+     */
     class AddSegmentRequestData {
         characterId: 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 GetAvatar.
+     */
     class GetAvatarRequestData {
         characterId: 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 {
         characterId: 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 GetCountryCode.
+     */
     class GetCountryCodeRequestData {
         characterId: string;
     }
+    /**
+     * Defines the request payload for ServerGetCountryCode.
+     */
     class ServerGetCountryCodeRequestData extends GetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCountryCode.
+     */
     class AdminGetCountryCodeRequestData extends ServerGetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for GetCustomData.
+     */
     class GetCustomDataRequestData {
         characterId: 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 {
         characterId: 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 GetFriendStatisticsLeaderboardAroundPlayer.
+     */
     class GetFriendStatisticsLeaderboardAroundPlayerRequestData {
         characterId: string;
         key: string;
@@ -110,10 +248,19 @@ export declare namespace CharacterPlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetFriendStatisticsLeaderboardAroundPlayer.
+     */
     class ServerGetFriendStatisticsLeaderboardAroundPlayerRequestData extends GetFriendStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetFriendStatisticsLeaderboardAroundPlayer.
+     */
     class AdminGetFriendStatisticsLeaderboardAroundPlayerRequestData extends ServerGetFriendStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for GetFriendStatisticsLeaderboard.
+     */
     class GetFriendStatisticsLeaderboardRequestData {
         characterId: string;
         key: string;
@@ -122,107 +269,230 @@ export declare namespace CharacterPlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetFriendStatisticsLeaderboard.
+     */
     class ServerGetFriendStatisticsLeaderboardRequestData extends GetFriendStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetFriendStatisticsLeaderboard.
+     */
     class AdminGetFriendStatisticsLeaderboardRequestData extends ServerGetFriendStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetIpAddressCreate.
+     */
     class GetIpAddressCreateRequestData {
         characterId: string;
     }
+    /**
+     * Defines the request payload for ServerGetIpAddressCreate.
+     */
     class ServerGetIpAddressCreateRequestData extends GetIpAddressCreateRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetIpAddressCreate.
+     */
     class AdminGetIpAddressCreateRequestData extends ServerGetIpAddressCreateRequestData {
     }
+    /**
+     * Defines the request payload for GetOwner.
+     */
     class GetOwnerRequestData {
         characterId: 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 GetPlayerBan.
+     */
     class GetPlayerBanRequestData {
         characterId: string;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerBan.
+     */
     class ServerGetPlayerBanRequestData extends GetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerBan.
+     */
     class AdminGetPlayerBanRequestData extends ServerGetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerCurrency.
+     */
     class GetPlayerCurrencyRequestData {
         characterId: string;
         playerCurrencyKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerCurrency.
+     */
     class ServerGetPlayerCurrencyRequestData extends GetPlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerCurrency.
+     */
     class AdminGetPlayerCurrencyRequestData extends ServerGetPlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerData.
+     */
     class GetPlayerDataRequestData {
         characterId: string;
         playerDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerData.
+     */
     class ServerGetPlayerDataRequestData extends GetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerData.
+     */
     class AdminGetPlayerDataRequestData extends ServerGetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerFriend.
+     */
     class GetPlayerFriendRequestData {
         characterId: string;
         friendCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerFriend.
+     */
     class ServerGetPlayerFriendRequestData extends GetPlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerFriend.
+     */
     class AdminGetPlayerFriendRequestData extends ServerGetPlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerGroup.
+     */
     class GetPlayerGroupRequestData {
         characterId: string;
         groupCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerGroup.
+     */
     class ServerGetPlayerGroupRequestData extends GetPlayerGroupRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerGroup.
+     */
     class AdminGetPlayerGroupRequestData extends ServerGetPlayerGroupRequestData {
     }
+    /**
+     * Reads one specific character-player profile using the requested projection.
+     */
     class GetPlayerInformationRequestData {
+        /**
+         * Character entity to inspect.
+         */
         characterId: string;
+        /**
+         * Required field projection that controls which optional data is returned.
+         */
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerInformation.
+     */
     class ServerGetPlayerInformationRequestData extends GetPlayerInformationRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerInformation.
+     */
     class AdminGetPlayerInformationRequestData extends ServerGetPlayerInformationRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerInventory.
+     */
     class GetPlayerInventoryRequestData {
         characterId: string;
         itemCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerInventory.
+     */
     class ServerGetPlayerInventoryRequestData extends GetPlayerInventoryRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerInventory.
+     */
     class AdminGetPlayerInventoryRequestData extends ServerGetPlayerInventoryRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerStatistics.
+     */
     class GetPlayerStatisticsRequestData {
         characterId: string;
         statisticsKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerStatistics.
+     */
     class ServerGetPlayerStatisticsRequestData extends GetPlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayerStatistics.
+     */
     class AdminGetPlayerStatisticsRequestData extends ServerGetPlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithDisplayName.
+     */
     class GetPlayersWithDisplayNameRequestData {
         keyword: string;
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithDisplayName.
+     */
     class ServerGetPlayersWithDisplayNameRequestData extends GetPlayersWithDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithDisplayName.
+     */
     class AdminGetPlayersWithDisplayNameRequestData extends ServerGetPlayersWithDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithSegment.
+     */
     class GetPlayersWithSegmentRequestData {
         value: string;
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithSegment.
+     */
     class ServerGetPlayersWithSegmentRequestData extends GetPlayersWithSegmentRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithSegment.
+     */
     class AdminGetPlayersWithSegmentRequestData extends ServerGetPlayersWithSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayersWithTag.
+     */
     class GetPlayersWithTagRequestData {
         key: string;
         value: string;
@@ -230,24 +500,51 @@ export declare namespace CharacterPlayerModels {
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetPlayersWithTag.
+     */
     class ServerGetPlayersWithTagRequestData extends GetPlayersWithTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetPlayersWithTag.
+     */
     class AdminGetPlayersWithTagRequestData extends ServerGetPlayersWithTagRequestData {
     }
+    /**
+     * Defines the request payload for GetRemoveStatus.
+     */
     class GetRemoveStatusRequestData {
         characterId: 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 {
         characterId: 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 GetStatisticsLeaderboardAroundPlayer.
+     */
     class GetStatisticsLeaderboardAroundPlayerRequestData {
         characterId: string;
         key: string;
@@ -257,10 +554,19 @@ export declare namespace CharacterPlayerModels {
         loadFromCache?: boolean;
         catalogId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboardAroundPlayer.
+     */
     class ServerGetStatisticsLeaderboardAroundPlayerRequestData extends GetStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboardAroundPlayer.
+     */
     class AdminGetStatisticsLeaderboardAroundPlayerRequestData extends ServerGetStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for GetCurrencyLeaderboard.
+     */
     class GetCurrencyLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -269,10 +575,19 @@ export declare namespace CharacterPlayerModels {
         loadFromCache?: boolean;
         catalogId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetCurrencyLeaderboard.
+     */
     class ServerGetCurrencyLeaderboardRequestData extends GetCurrencyLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCurrencyLeaderboard.
+     */
     class AdminGetCurrencyLeaderboardRequestData extends ServerGetCurrencyLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -282,62 +597,128 @@ export declare namespace CharacterPlayerModels {
         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 GetLastLoginLeaderboard.
+     */
     class GetLastLoginLeaderboardRequestData {
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetLastLoginLeaderboard.
+     */
     class ServerGetLastLoginLeaderboardRequestData extends GetLastLoginLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetLastLoginLeaderboard.
+     */
     class AdminGetLastLoginLeaderboardRequestData extends ServerGetLastLoginLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetTag.
+     */
     class GetTagRequestData {
         characterId: 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 {
         characterId: 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 GetTsLastLogin.
+     */
     class GetTsLastLoginRequestData {
         characterId: string;
     }
+    /**
+     * Defines the request payload for ServerGetTsLastLogin.
+     */
     class ServerGetTsLastLoginRequestData extends GetTsLastLoginRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetTsLastLogin.
+     */
     class AdminGetTsLastLoginRequestData extends ServerGetTsLastLoginRequestData {
     }
+    /**
+     * Creates a group from a character-player context.
+     */
     class CreateGroupRequestData {
         characterId: string;
         catalogId: string;
+        /**
+         * Additional group members expressed as game-player user IDs, not character IDs.
+         */
         groupMembers?: Array<GroupMemberParam>;
         displayName?: string;
     }
+    /**
+     * Defines the request payload for ServerCreateGroup.
+     */
     class ServerCreateGroupRequestData extends CreateGroupRequestData {
     }
+    /**
+     * Defines the request payload for AdminCreateGroup.
+     */
     class AdminCreateGroupRequestData extends ServerCreateGroupRequestData {
     }
+    /**
+     * Defines the request payload for CreatePlayerItem.
+     */
     class CreatePlayerItemRequestData {
         characterId: string;
         catalogId: string;
@@ -345,172 +726,361 @@ export declare namespace CharacterPlayerModels {
         displayName?: string;
         amount?: number;
     }
+    /**
+     * Defines the request payload for ServerCreatePlayerItem.
+     */
     class ServerCreatePlayerItemRequestData extends CreatePlayerItemRequestData {
     }
+    /**
+     * Defines the request payload for AdminCreatePlayerItem.
+     */
     class AdminCreatePlayerItemRequestData extends ServerCreatePlayerItemRequestData {
     }
+    /**
+     * Defines the request payload for JoinGroup.
+     */
     class JoinGroupRequestData {
         characterId: string;
         groupId: string;
     }
+    /**
+     * Defines the request payload for ServerJoinGroup.
+     */
     class ServerJoinGroupRequestData extends JoinGroupRequestData {
     }
+    /**
+     * Defines the request payload for AdminJoinGroup.
+     */
     class AdminJoinGroupRequestData extends ServerJoinGroupRequestData {
     }
+    /**
+     * Defines the request payload for LeaveGroup.
+     */
     class LeaveGroupRequestData {
         characterId: string;
         groupId: string;
     }
+    /**
+     * Defines the request payload for ServerLeaveGroup.
+     */
     class ServerLeaveGroupRequestData extends LeaveGroupRequestData {
     }
+    /**
+     * Defines the request payload for AdminLeaveGroup.
+     */
     class AdminLeaveGroupRequestData extends ServerLeaveGroupRequestData {
     }
+    /**
+     * Defines the request payload for RemovePlayerFriend.
+     */
     class RemovePlayerFriendRequestData {
         characterId: string;
         friendId: string;
     }
+    /**
+     * Defines the request payload for ServerRemovePlayerFriend.
+     */
     class ServerRemovePlayerFriendRequestData extends RemovePlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemovePlayerFriend.
+     */
     class AdminRemovePlayerFriendRequestData extends ServerRemovePlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for RemovePlayerItem.
+     */
     class RemovePlayerItemRequestData {
         characterId: string;
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerRemovePlayerItem.
+     */
     class ServerRemovePlayerItemRequestData extends RemovePlayerItemRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemovePlayerItem.
+     */
     class AdminRemovePlayerItemRequestData extends ServerRemovePlayerItemRequestData {
     }
+    /**
+     * Defines the request payload for RemoveSegment.
+     */
     class RemoveSegmentRequestData {
         characterId: 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 {
         characterId: string;
         key: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveTag.
+     */
     class ServerRemoveTagRequestData extends RemoveTagRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemoveTag.
+     */
     class AdminRemoveTagRequestData extends ServerRemoveTagRequestData {
     }
+    /**
+     * Defines the request payload for SetAvatar.
+     */
     class SetAvatarRequestData {
         characterId: 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 SetCountryCode.
+     */
     class SetCountryCodeRequestData {
         characterId: string;
         countryCode: string;
     }
+    /**
+     * Defines the request payload for ServerSetCountryCode.
+     */
     class ServerSetCountryCodeRequestData extends SetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetCountryCode.
+     */
     class AdminSetCountryCodeRequestData extends ServerSetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for SetCustomData.
+     */
     class SetCustomDataRequestData {
         characterId: 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 {
         characterId: string;
         displayName: string;
         uniqueDisplayName?: boolean;
     }
+    /**
+     * Defines the request payload for ServerSetDisplayName.
+     */
     class ServerSetDisplayNameRequestData extends SetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetDisplayName.
+     */
     class AdminSetDisplayNameRequestData extends ServerSetDisplayNameRequestData {
     }
+    /**
+     * Transfers ownership of the character to another game player.
+     * The public contract currently exposes only the new owner ID, not an owner-type override.
+     */
     class SetOwnerRequestData {
         characterId: string;
         newOwnerId: string;
     }
+    /**
+     * 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 SetPlayerBan.
+     */
     class SetPlayerBanRequestData {
         characterId: string;
         tsExpire: number;
         reason: string;
     }
+    /**
+     * Defines the request payload for ServerSetPlayerBan.
+     */
     class ServerSetPlayerBanRequestData extends SetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetPlayerBan.
+     */
     class AdminSetPlayerBanRequestData extends ServerSetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for ChangePlayerCurrency.
+     */
     class ChangePlayerCurrencyRequestData {
         characterId: string;
         playerCurrencies: Array<PlayerCurrencyParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangePlayerCurrency.
+     */
     class ServerChangePlayerCurrencyRequestData extends ChangePlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for AdminChangePlayerCurrency.
+     */
     class AdminChangePlayerCurrencyRequestData extends ServerChangePlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for SetPlayerData.
+     */
     class SetPlayerDataRequestData {
         characterId: string;
         playerDatas: Array<PlayerDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetPlayerData.
+     */
     class ServerSetPlayerDataRequestData extends SetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetPlayerData.
+     */
     class AdminSetPlayerDataRequestData extends ServerSetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for ChangePlayerStatistics.
+     */
     class ChangePlayerStatisticsRequestData {
         characterId: string;
         playerStatistics: Array<PlayerStatisticsParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangePlayerStatistics.
+     */
     class ServerChangePlayerStatisticsRequestData extends ChangePlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for AdminChangePlayerStatistics.
+     */
     class AdminChangePlayerStatisticsRequestData extends ServerChangePlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for SetRemoveStatus.
+     */
     class SetRemoveStatusRequestData {
         characterId: 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 {
         characterId: 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 currency change logs for one character player.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetCurrencyLogRequestData {
         keys?: Array<string>;
         characterId?: string;
         limit?: number;
+        /**
+         * Continuation token returned by the previous page.
+         */
         token?: string;
     }
+    /**
+     * Defines the request payload for ServerGetCurrencyLog.
+     */
     class ServerGetCurrencyLogRequestData extends GetCurrencyLogRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCurrencyLog.
+     */
     class AdminGetCurrencyLogRequestData extends ServerGetCurrencyLogRequestData {
     }
+    /**
+     * Reads statistic change logs for one character player.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetStatisticsLogRequestData {
         keys?: Array<string>;
         characterId?: 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;
         owner?: GenericModels.OwnerItem;
@@ -525,23 +1095,47 @@ export declare namespace CharacterPlayerModels {
         playerDatas?: Array<GenericModels.DataItem>;
         playerCurrencies?: Array<GenericModels.CurrencyItem>;
         playerStatistics?: Array<GenericModels.StatisticsItem>;
+        /**
+         * Lightweight relation items for inventory owned by the character.
+         */
         playerInventories?: Array<GenericModels.InventoryItem>;
+        /**
+         * Lightweight relation items for groups attached to the character.
+         */
         playerGroups?: Array<GenericModels.GroupItem>;
+        /**
+         * Lightweight relation items for friends attached to the character.
+         */
         playerFriends?: Array<GenericModels.FriendItem>;
         tsLastLogin?: number;
         ipAddressCreate?: string;
         countryCode?: string;
     }
+    /**
+     * Base character-player response envelope.
+     */
     class CharacterPlayerResponseData {
+        /**
+         * Optional field bag controlled by the corresponding `InfoRequestParam`.
+         */
         infoResponseParameters: InfoResponseParameters;
     }
+    /**
+     * Character-player envelope that also exposes the resolved character ID.
+     */
     class CharacterPlayerWithCharacterIdResponseData extends CharacterPlayerResponseData {
         characterId: string;
     }
+    /**
+     * Defines the response payload for CharacterPlayerLeaderboard.
+     */
     class CharacterPlayerLeaderboardResponseData extends CharacterPlayerWithCharacterIdResponseData {
         position: number;
         backupValue?: number;
     }
+    /**
+     * Defines the response payload for CharacterPlayerLog.
+     */
     class CharacterPlayerLogResponseData {
         characterId: string;
         tsCreate: number;
@@ -551,30 +1145,60 @@ export declare namespace CharacterPlayerModels {
         startValue: number;
         finalValue: number;
     }
+    /**
+     * Defines the response payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardResponseData {
         results: Array<CharacterPlayerLeaderboardResponseData>;
         tsCreate: number;
     }
+    /**
+     * Defines the response payload for CharacterPlayersWithCharacterId.
+     */
     class CharacterPlayersWithCharacterIdResponseData {
         results: Array<CharacterPlayerWithCharacterIdResponseData>;
     }
+    /**
+     * Defines the response payload for GetCurrencyLeaderboard.
+     */
     class GetCurrencyLeaderboardResponseData {
         results: Array<CharacterPlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardResponseData {
         results: Array<CharacterPlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GetLastLoginLeaderboard.
+     */
     class GetLastLoginLeaderboardResponseData {
         results: Array<CharacterPlayerLeaderboardResponseData>;
     }
+    /**
+     * Returns one page of statistics logs.
+     */
     class GetStatisticsLogResponseData {
         results: Array<CharacterPlayerLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Returns one page of currency logs.
+     */
     class GetCurrencyLogResponseData {
         results: Array<CharacterPlayerLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }