@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -1,5 +1,37 @@
 import { GenericModels } from "./GenericModels";
+/**
+ * Reusable request and response DTOs for the GamePlayer domain.
+ *
+ * GamePlayer operations target the **account-level** player
+ * record — the per-game profile that sits between the master
+ * player and the per-character profiles. The DTOs here are
+ * organised into three role variants:
+ *
+ * - **Client variants** (no prefix): routed through
+ *   `GNNetwork.gamePlayer`, target the authenticated user. The
+ *   `userId` is implicit (taken from the cached
+ *   {@link AuthenticateStatus}) so most client-flavour DTOs
+ *   either omit it or expose only a small filtered slice.
+ * - **`Server*` variants**: routed through
+ *   `GNNetwork.gamePlayer.server`. Always require an explicit
+ *   `userId` so a trusted backend can act on behalf of an
+ *   arbitrary player.
+ * - **`Admin*` variants**: routed through
+ *   `GNNetwork.gamePlayer.admin`. Same shape as `Server*` plus
+ *   any extra knobs the backend exposes only to admin tokens
+ *   (forced overrides, bypass-validation flags, ...).
+ *
+ * Validation rules declared on each `@*DataMember` decorator
+ * (`mustNonNull`, `minLength`, `maxLength`, `minValue`,
+ * `maxValue`) are enforced server-side; failures surface as
+ * {@link InvalidMember} entries on the response with the
+ * matching {@link InvalidMemberType}.
+ */
 export declare namespace GamePlayerModels {
+    /**
+     * Selects which optional game-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 {
         segments?: boolean;
         customDatas?: boolean;
@@ -14,91 +46,200 @@ export declare namespace GamePlayerModels {
         ipAddressCreate?: boolean;
         countryCode?: boolean;
         tsLastLogin?: boolean;
+        /**
+         * Includes relation items for characters owned by the player, optionally filtered by `characterCatalogIds`.
+         */
         playerCharacters?: boolean;
+        /**
+         * Includes relation items for inventory owned by the player, optionally filtered by `itemCatalogIds`.
+         */
         playerInventories?: boolean;
+        /**
+         * Includes relation items for groups joined or owned by the player, optionally filtered by `groupCatalogIds`.
+         */
         playerGroups?: boolean;
+        /**
+         * Includes the player's online status, if supported by the connected game server
+         */
+        onlineStatus?: boolean;
+        /**
+         * Includes relation items for friends attached to the player, optionally filtered by `friendCatalogIds`.
+         */
         playerFriends?: boolean;
         playerDataKeys?: Array<string>;
         playerCurrencyKeys?: Array<string>;
         playerStatisticsKeys?: Array<string>;
         customDataKeys?: Array<string>;
         tagKeys?: Array<string>;
+        /**
+         * Restricts `playerCharacters` to relation items whose catalog IDs match this list.
+         */
         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 CustomDataParam.
+     */
     class CustomDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Describes one game-player member included when creating a group.
+     */
     class GroupMemberParam {
         userId: string;
     }
+    /**
+     * Defines the reusable parameter block PlayerCurrencyParam.
+     */
     class PlayerCurrencyParam {
         key: string;
         amount: number;
     }
+    /**
+     * Defines the reusable parameter block PlayerDataParam.
+     */
     class PlayerDataParam {
         key: string;
         value: any;
     }
+    /**
+     * Defines the reusable parameter block PlayerStatisticsParam.
+     */
     class PlayerStatisticsParam {
         key: string;
         value: number;
     }
+    /**
+     * Creates a friend relation between the current or target game player and another game player.
+     */
     class AddPlayerFriendRequestData {
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: string;
+        /**
+         * Target friend user ID.
+         */
         friendId: string;
+        /**
+         * Friend catalog used to create the relation record.
+         */
         catalogId: string;
     }
+    /**
+     * Defines the request payload for ServerAddPlayerFriend.
+     */
     class ServerAddPlayerFriendRequestData extends AddPlayerFriendRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminAddPlayerFriend.
+     */
     class AdminAddPlayerFriendRequestData extends ServerAddPlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for AddSegment.
+     */
     class AddSegmentRequestData {
         userId?: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerAddSegment.
+     */
     class ServerAddSegmentRequestData extends AddSegmentRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminAddSegment.
+     */
     class AdminAddSegmentRequestData extends ServerAddSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetAvatar.
+     */
     class GetAvatarRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetAvatar.
+     */
     class ServerGetAvatarRequestData extends GetAvatarRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetAvatar.
+     */
     class AdminGetAvatarRequestData extends ServerGetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for GetCountryCode.
+     */
     class GetCountryCodeRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetCountryCode.
+     */
     class ServerGetCountryCodeRequestData extends GetCountryCodeRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetCountryCode.
+     */
     class AdminGetCountryCodeRequestData extends ServerGetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for GetCustomData.
+     */
     class GetCustomDataRequestData {
         userId?: string;
         customDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetCustomData.
+     */
     class ServerGetCustomDataRequestData extends GetCustomDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetCustomData.
+     */
     class AdminGetCustomDataRequestData extends ServerGetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for GetDisplayName.
+     */
     class GetDisplayNameRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetDisplayName.
+     */
     class ServerGetDisplayNameRequestData extends GetDisplayNameRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetDisplayName.
+     */
     class AdminGetDisplayNameRequestData extends ServerGetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for GetFriendStatisticsLeaderboardAroundPlayer.
+     */
     class GetFriendStatisticsLeaderboardAroundPlayerRequestData {
         userId?: string;
         key: string;
@@ -107,11 +248,20 @@ export declare namespace GamePlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetFriendStatisticsLeaderboardAroundPlayer.
+     */
     class ServerGetFriendStatisticsLeaderboardAroundPlayerRequestData extends GetFriendStatisticsLeaderboardAroundPlayerRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetFriendStatisticsLeaderboardAroundPlayer.
+     */
     class AdminGetFriendStatisticsLeaderboardAroundPlayerRequestData extends ServerGetFriendStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for GetFriendStatisticsLeaderboard.
+     */
     class GetFriendStatisticsLeaderboardRequestData {
         userId?: string;
         key: string;
@@ -120,128 +270,264 @@ export declare namespace GamePlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetFriendStatisticsLeaderboard.
+     */
     class ServerGetFriendStatisticsLeaderboardRequestData extends GetFriendStatisticsLeaderboardRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetFriendStatisticsLeaderboard.
+     */
     class AdminGetFriendStatisticsLeaderboardRequestData extends ServerGetFriendStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetIpAddressCreate.
+     */
     class GetIpAddressCreateRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetIpAddressCreate.
+     */
     class ServerGetIpAddressCreateRequestData extends GetIpAddressCreateRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetIpAddressCreate.
+     */
     class AdminGetIpAddressCreateRequestData extends ServerGetIpAddressCreateRequestData {
     }
+    /**
+     * Defines the request payload for GetOnlineStatus.
+     */
     class GetOnlineStatusRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetOnlineStatus.
+     */
     class ServerGetOnlineStatusRequestData extends GetOnlineStatusRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetOnlineStatus.
+     */
     class AdminGetOnlineStatusRequestData extends ServerGetOnlineStatusRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerBan.
+     */
     class GetPlayerBanRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerBan.
+     */
     class ServerGetPlayerBanRequestData extends GetPlayerBanRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerBan.
+     */
     class AdminGetPlayerBanRequestData extends ServerGetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerCharacter.
+     */
     class GetPlayerCharacterRequestData {
         userId?: string;
         characterCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerCharacter.
+     */
     class ServerGetPlayerCharacterRequestData extends GetPlayerCharacterRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerCharacter.
+     */
     class AdminGetPlayerCharacterRequestData extends ServerGetPlayerCharacterRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerCurrency.
+     */
     class GetPlayerCurrencyRequestData {
         userId?: string;
         playerCurrencyKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerCurrency.
+     */
     class ServerGetPlayerCurrencyRequestData extends GetPlayerCurrencyRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerCurrency.
+     */
     class AdminGetPlayerCurrencyRequestData extends ServerGetPlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerData.
+     */
     class GetPlayerDataRequestData {
         userId?: string;
         playerDataKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerData.
+     */
     class ServerGetPlayerDataRequestData extends GetPlayerDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerData.
+     */
     class AdminGetPlayerDataRequestData extends ServerGetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerFriend.
+     */
     class GetPlayerFriendRequestData {
         userId?: string;
         friendCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerFriend.
+     */
     class ServerGetPlayerFriendRequestData extends GetPlayerFriendRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerFriend.
+     */
     class AdminGetPlayerFriendRequestData extends ServerGetPlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerGroup.
+     */
     class GetPlayerGroupRequestData {
         userId?: string;
         groupCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerGroup.
+     */
     class ServerGetPlayerGroupRequestData extends GetPlayerGroupRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerGroup.
+     */
     class AdminGetPlayerGroupRequestData extends ServerGetPlayerGroupRequestData {
     }
+    /**
+     * Reads the current or target game-player profile using the requested projection.
+     * On the client route, omit `userId` to target the authenticated player itself.
+     */
     class GetPlayerInformationRequestData {
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: string;
+        /**
+         * Required field projection that controls which optional data is returned.
+         */
         infoRequestParam: InfoRequestParam;
     }
+    /**
+     * Reads a specific target game player on a trusted route.
+     */
     class ServerGetPlayerInformationRequestData extends GetPlayerInformationRequestData {
         userId: string;
+        /**
+         * Allows the backend to create the missing game-player record before returning it.
+         */
         createPlayerIfNotExists?: boolean;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerInformation.
+     */
     class AdminGetPlayerInformationRequestData extends ServerGetPlayerInformationRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerInventory.
+     */
     class GetPlayerInventoryRequestData {
         userId?: string;
         itemCatalogIds?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerInventory.
+     */
     class ServerGetPlayerInventoryRequestData extends GetPlayerInventoryRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetPlayerInventory.
+     */
     class AdminGetPlayerInventoryRequestData extends ServerGetPlayerInventoryRequestData {
     }
+    /**
+     * Defines the request payload for GetPlayerStatistics.
+     */
     class GetPlayerStatisticsRequestData {
         userId?: string;
         statisticsKeys?: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetPlayerStatistics.
+     */
     class ServerGetPlayerStatisticsRequestData extends GetPlayerStatisticsRequestData {
         userId: string;
     }
+    /**
+     * 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;
@@ -249,18 +535,36 @@ export declare namespace GamePlayerModels {
         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 GetSegment.
+     */
     class GetSegmentRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetSegment.
+     */
     class ServerGetSegmentRequestData extends GetSegmentRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetSegment.
+     */
     class AdminGetSegmentRequestData extends ServerGetSegmentRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboardAroundPlayer.
+     */
     class GetStatisticsLeaderboardAroundPlayerRequestData {
         userId?: string;
         key: string;
@@ -269,11 +573,20 @@ export declare namespace GamePlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboardAroundPlayer.
+     */
     class ServerGetStatisticsLeaderboardAroundPlayerRequestData extends GetStatisticsLeaderboardAroundPlayerRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboardAroundPlayer.
+     */
     class AdminGetStatisticsLeaderboardAroundPlayerRequestData extends ServerGetStatisticsLeaderboardAroundPlayerRequestData {
     }
+    /**
+     * Defines the request payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -282,67 +595,133 @@ export declare namespace GamePlayerModels {
         loadFromCache?: boolean;
         version?: string;
     }
+    /**
+     * Defines the request payload for ServerGetStatisticsLeaderboard.
+     */
     class ServerGetStatisticsLeaderboardRequestData extends GetStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetStatisticsLeaderboard.
+     */
     class AdminGetStatisticsLeaderboardRequestData extends ServerGetStatisticsLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardRequestData {
         infoRequestParam: InfoRequestParam;
         skip?: number;
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * Defines the request payload for ServerGetCreateLeaderboard.
+     */
     class ServerGetCreateLeaderboardRequestData extends GetCreateLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetCreateLeaderboard.
+     */
     class AdminGetCreateLeaderboardRequestData extends ServerGetCreateLeaderboardRequestData {
     }
+    /**
+     * Defines the request payload for GetTag.
+     */
     class GetTagRequestData {
         userId?: string;
         tagKeys: Array<string>;
     }
+    /**
+     * Defines the request payload for ServerGetTag.
+     */
     class ServerGetTagRequestData extends GetTagRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetTag.
+     */
     class AdminGetTagRequestData extends ServerGetTagRequestData {
     }
+    /**
+     * Defines the request payload for GetTsCreate.
+     */
     class GetTsCreateRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetTsCreate.
+     */
     class ServerGetTsCreateRequestData extends GetTsCreateRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetTsCreate.
+     */
     class AdminGetTsCreateRequestData extends ServerGetTsCreateRequestData {
     }
+    /**
+     * Defines the request payload for GetTsLastLogin.
+     */
     class GetTsLastLoginRequestData {
         userId?: string;
     }
+    /**
+     * Defines the request payload for ServerGetTsLastLogin.
+     */
     class ServerGetTsLastLoginRequestData extends GetTsLastLoginRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminGetTsLastLogin.
+     */
     class AdminGetTsLastLoginRequestData extends ServerGetTsLastLoginRequestData {
     }
+    /**
+     * Creates a group owned by or attached to the current or target game player.
+     */
     class CreateGroupRequestData {
         userId?: string;
         catalogId: string;
+        /**
+         * Additional game-player members expressed as user IDs, not character IDs.
+         */
         groupMembers?: Array<GroupMemberParam>;
         displayName?: string;
     }
+    /**
+     * Defines the request payload for ServerCreateGroup.
+     */
     class ServerCreateGroupRequestData extends CreateGroupRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminCreateGroup.
+     */
     class AdminCreateGroupRequestData extends ServerCreateGroupRequestData {
     }
+    /**
+     * Defines the request payload for CreatePlayerCharacter.
+     */
     class CreatePlayerCharacterRequestData {
         userId?: string;
         catalogId: string;
         displayName?: string;
         uniqueDisplayName?: boolean;
     }
+    /**
+     * Defines the request payload for ServerCreatePlayerCharacter.
+     */
     class ServerCreatePlayerCharacterRequestData extends CreatePlayerCharacterRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminCreatePlayerCharacter.
+     */
     class AdminCreatePlayerCharacterRequestData extends ServerCreatePlayerCharacterRequestData {
     }
+    /**
+     * Defines the request payload for CreatePlayerItem.
+     */
     class CreatePlayerItemRequestData {
         userId?: string;
         catalogId: string;
@@ -350,181 +729,366 @@ export declare namespace GamePlayerModels {
         displayName?: string;
         amount?: number;
     }
+    /**
+     * Defines the request payload for ServerCreatePlayerItem.
+     */
     class ServerCreatePlayerItemRequestData extends CreatePlayerItemRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminCreatePlayerItem.
+     */
     class AdminCreatePlayerItemRequestData extends ServerCreatePlayerItemRequestData {
     }
+    /**
+     * Defines the request payload for JoinGroup.
+     */
     class JoinGroupRequestData {
         userId?: string;
         groupId: string;
     }
+    /**
+     * Defines the request payload for ServerJoinGroup.
+     */
     class ServerJoinGroupRequestData extends JoinGroupRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminJoinGroup.
+     */
     class AdminJoinGroupRequestData extends ServerJoinGroupRequestData {
     }
+    /**
+     * Defines the request payload for LeaveGroup.
+     */
     class LeaveGroupRequestData {
         userId?: string;
         groupId: string;
     }
+    /**
+     * Defines the request payload for ServerLeaveGroup.
+     */
     class ServerLeaveGroupRequestData extends LeaveGroupRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminLeaveGroup.
+     */
     class AdminLeaveGroupRequestData extends ServerLeaveGroupRequestData {
     }
+    /**
+     * Defines the request payload for RemovePlayerCharacter.
+     */
     class RemovePlayerCharacterRequestData {
         userId?: string;
         characterId: string;
     }
+    /**
+     * Defines the request payload for ServerRemovePlayerCharacter.
+     */
     class ServerRemovePlayerCharacterRequestData extends RemovePlayerCharacterRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemovePlayerCharacter.
+     */
     class AdminRemovePlayerCharacterRequestData extends ServerRemovePlayerCharacterRequestData {
     }
+    /**
+     * Defines the request payload for RemovePlayerFriend.
+     */
     class RemovePlayerFriendRequestData {
         userId?: string;
         friendId: string;
     }
+    /**
+     * Defines the request payload for ServerRemovePlayerFriend.
+     */
     class ServerRemovePlayerFriendRequestData extends RemovePlayerFriendRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemovePlayerFriend.
+     */
     class AdminRemovePlayerFriendRequestData extends ServerRemovePlayerFriendRequestData {
     }
+    /**
+     * Defines the request payload for RemovePlayerItem.
+     */
     class RemovePlayerItemRequestData {
         userId?: string;
         itemId: string;
     }
+    /**
+     * Defines the request payload for ServerRemovePlayerItem.
+     */
     class ServerRemovePlayerItemRequestData extends RemovePlayerItemRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemovePlayerItem.
+     */
     class AdminRemovePlayerItemRequestData extends ServerRemovePlayerItemRequestData {
     }
+    /**
+     * Defines the request payload for RemoveSegment.
+     */
     class RemoveSegmentRequestData {
         userId?: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveSegment.
+     */
     class ServerRemoveSegmentRequestData extends RemoveSegmentRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemoveSegment.
+     */
     class AdminRemoveSegmentRequestData extends ServerRemoveSegmentRequestData {
     }
+    /**
+     * Defines the request payload for RemoveTag.
+     */
     class RemoveTagRequestData {
         userId?: string;
         key: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveTag.
+     */
     class ServerRemoveTagRequestData extends RemoveTagRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminRemoveTag.
+     */
     class AdminRemoveTagRequestData extends ServerRemoveTagRequestData {
     }
+    /**
+     * Defines the request payload for SetAvatar.
+     */
     class SetAvatarRequestData {
         userId?: string;
         type: number;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerSetAvatar.
+     */
     class ServerSetAvatarRequestData extends SetAvatarRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetAvatar.
+     */
     class AdminSetAvatarRequestData extends ServerSetAvatarRequestData {
     }
+    /**
+     * Defines the request payload for SetCountryCode.
+     */
     class SetCountryCodeRequestData {
         userId?: string;
         countryCode: string;
     }
+    /**
+     * Defines the request payload for ServerSetCountryCode.
+     */
     class ServerSetCountryCodeRequestData extends SetCountryCodeRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetCountryCode.
+     */
     class AdminSetCountryCodeRequestData extends ServerSetCountryCodeRequestData {
     }
+    /**
+     * Defines the request payload for SetCustomData.
+     */
     class SetCustomDataRequestData {
         userId?: string;
         customDatas: Array<CustomDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetCustomData.
+     */
     class ServerSetCustomDataRequestData extends SetCustomDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetCustomData.
+     */
     class AdminSetCustomDataRequestData extends ServerSetCustomDataRequestData {
     }
+    /**
+     * Defines the request payload for SetDisplayName.
+     */
     class SetDisplayNameRequestData {
         userId?: string;
         displayName: string;
         uniqueDisplayName?: boolean;
     }
+    /**
+     * Defines the request payload for ServerSetDisplayName.
+     */
     class ServerSetDisplayNameRequestData extends SetDisplayNameRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetDisplayName.
+     */
     class AdminSetDisplayNameRequestData extends ServerSetDisplayNameRequestData {
     }
+    /**
+     * Defines the request payload for SetPlayerBan.
+     */
     class SetPlayerBanRequestData {
         userId?: string;
         tsExpire: number;
         reason: string;
     }
+    /**
+     * Defines the request payload for ServerSetPlayerBan.
+     */
     class ServerSetPlayerBanRequestData extends SetPlayerBanRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetPlayerBan.
+     */
     class AdminSetPlayerBanRequestData extends ServerSetPlayerBanRequestData {
     }
+    /**
+     * Defines the request payload for ChangePlayerCurrency.
+     */
     class ChangePlayerCurrencyRequestData {
         userId?: string;
         playerCurrencies: Array<PlayerCurrencyParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangePlayerCurrency.
+     */
     class ServerChangePlayerCurrencyRequestData extends ChangePlayerCurrencyRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminChangePlayerCurrency.
+     */
     class AdminChangePlayerCurrencyRequestData extends ServerChangePlayerCurrencyRequestData {
     }
+    /**
+     * Defines the request payload for SetPlayerData.
+     */
     class SetPlayerDataRequestData {
         userId?: string;
         playerDatas: Array<PlayerDataParam>;
     }
+    /**
+     * Defines the request payload for ServerSetPlayerData.
+     */
     class ServerSetPlayerDataRequestData extends SetPlayerDataRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetPlayerData.
+     */
     class AdminSetPlayerDataRequestData extends ServerSetPlayerDataRequestData {
     }
+    /**
+     * Defines the request payload for ChangePlayerStatistics.
+     */
     class ChangePlayerStatisticsRequestData {
         userId?: string;
         playerStatistics: Array<PlayerStatisticsParam>;
         log?: string;
     }
+    /**
+     * Defines the request payload for ServerChangePlayerStatistics.
+     */
     class ServerChangePlayerStatisticsRequestData extends ChangePlayerStatisticsRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminChangePlayerStatistics.
+     */
     class AdminChangePlayerStatisticsRequestData extends ServerChangePlayerStatisticsRequestData {
     }
+    /**
+     * Defines the request payload for SetTag.
+     */
     class SetTagRequestData {
         userId?: string;
         key: string;
         value: string;
     }
+    /**
+     * Defines the request payload for ServerSetTag.
+     */
     class ServerSetTagRequestData extends SetTagRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for AdminSetTag.
+     */
     class AdminSetTagRequestData extends ServerSetTagRequestData {
     }
+    /**
+     * Reads currency change logs for the current or target game player.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetCurrencyLogRequestData {
         keys?: Array<string>;
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: 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 the current or target game player.
+     * Pagination is token-based rather than skip-based.
+     */
     class GetStatisticsLogRequestData {
         keys?: Array<string>;
+        /**
+         * Optional self-target shortcut on the client route.
+         */
         userId?: 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 {
         segments?: Array<string>;
         customDatas?: Array<GenericModels.DataItem>;
@@ -536,24 +1100,52 @@ export declare namespace GamePlayerModels {
         playerDatas?: Array<GenericModels.DataItem>;
         playerCurrencies?: Array<GenericModels.CurrencyItem>;
         playerStatistics?: Array<GenericModels.StatisticsItem>;
+        onlineStatus?: OnlineStatusItem;
+        /**
+         * Lightweight relation items for owned character players, not full character snapshots.
+         */
         playerCharacters?: Array<GenericModels.CharacterItem>;
+        /**
+         * Lightweight relation items for inventory owned by the player.
+         */
         playerInventories?: Array<GenericModels.InventoryItem>;
+        /**
+         * Lightweight relation items for groups attached to the player.
+         */
         playerGroups?: Array<GenericModels.GroupItem>;
+        /**
+         * Lightweight relation items for friends attached to the player.
+         */
         playerFriends?: Array<GenericModels.FriendItem>;
         tsLastLogin?: number;
         ipAddressCreate?: string;
         countryCode?: string;
     }
+    /**
+     * Base game-player response envelope.
+     */
     class GamePlayerResponseData {
+        /**
+         * Optional field bag controlled by the corresponding `InfoRequestParam`.
+         */
         infoResponseParameters: InfoResponseParameters;
     }
+    /**
+     * Game-player envelope that also exposes the resolved game-player user ID.
+     */
     class GamePlayerWithUserIdResponseData extends GamePlayerResponseData {
         userId: string;
     }
+    /**
+     * Defines the response payload for GamePlayerLeaderboard.
+     */
     class GamePlayerLeaderboardResponseData extends GamePlayerWithUserIdResponseData {
         position: number;
         backupValue?: number;
     }
+    /**
+     * Defines the response payload for GamePlayerLog.
+     */
     class GamePlayerLogResponseData {
         userId: string;
         tsCreate: number;
@@ -563,26 +1155,47 @@ export declare namespace GamePlayerModels {
         startValue: number;
         finalValue: number;
     }
+    /**
+     * Defines the response payload for GetStatisticsLeaderboard.
+     */
     class GetStatisticsLeaderboardResponseData {
         results: Array<GamePlayerLeaderboardResponseData>;
         tsCreate: number;
     }
+    /**
+     * Defines the response payload for GetCurrencyLeaderboard.
+     */
     class GetCurrencyLeaderboardResponseData {
         results: Array<GamePlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GetLastLoginLeaderboard.
+     */
     class GetLastLoginLeaderboardResponseData {
         results: Array<GamePlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GetCreateLeaderboard.
+     */
     class GetCreateLeaderboardResponseData {
         results: Array<GamePlayerLeaderboardResponseData>;
     }
+    /**
+     * Defines the response payload for GamePlayersWithUserId.
+     */
     class GamePlayersWithUserIdResponseData {
         results: Array<GamePlayerWithUserIdResponseData>;
     }
-    class OnlineStatusResponseData {
+    /**
+     * Reports the latest known login timestamp and active socket identity for a player.
+     */
+    class OnlineStatusItem {
         tsLastLogin: number;
         socketId: string;
     }
+    /**
+     * Defines the request payload for GetCurrencyLeaderboard.
+     */
     class GetCurrencyLeaderboardRequestData {
         key: string;
         infoRequestParam: InfoRequestParam;
@@ -590,28 +1203,58 @@ export declare namespace GamePlayerModels {
         limit?: number;
         loadFromCache?: boolean;
     }
+    /**
+     * 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 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 {
     }
+    /**
+     * Returns one page of statistics logs.
+     */
     class GetStatisticsLogResponseData {
         results: Array<GamePlayerLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Returns one page of currency logs.
+     */
     class GetCurrencyLogResponseData {
         results: Array<GamePlayerLogResponseData>;
+        /**
+         * Continuation token for the next page, or `undefined` when pagination is exhausted.
+         */
         token?: string;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }