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

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

@@ -1,39 +1,90 @@
+/**
+ * Reusable request and response DTOs for the Dashboard
+ * domain.
+ *
+ * Dashboard operations cover game / account / secret
+ * management, server analytics, server logs, leaderboard
+ * maintenance and CloudScript event-callback wiring. They are
+ * sent over HTTP with {@link RequestType.Dashboard} and
+ * {@link RequestRole.Client} — the backend resolves admin
+ * privilege from the auth token (`loginByAdminAccount`)
+ * rather than from the wire role.
+ *
+ * Most DTOs accept an explicit `gameId` so multi-game
+ * dashboards can switch between games on the same admin
+ * session. Some destructive maintenance DTOs
+ * (`DeleteInDatabaseRequestData`,
+ * `RemoveAdminAccountRequestData`,
+ * `ResetStatisticsLeaderboardRequestData`) require additional
+ * confirmation fields server-side; consult the backend
+ * documentation before use.
+ */
 export declare namespace DashboardModels {
+    /**
+     * Defines the reusable permission-rule block used by secret-info and master settings payloads.
+     *
+     * These flags map directly to the GearN Server permission checks described in the public docs.
+     */
     class PermissionRulesParam {
+        /** Allows the operation on resources that belong to the authenticated user context. */
         selfEnable?: boolean;
+        /** Allows the operation on resources that do not belong to the authenticated user context. */
         otherSelfEnable?: boolean;
+        /** Allows the operation through admin-scoped execution context. */
         adminSelfEnable?: boolean;
+        /** Allows the operation through server-scoped execution context. */
         serverSelfEnable?: boolean;
     }
+    /**
+     * Defines the reusable parameter block FriendCatalogSettingsParam.
+     */
     class FriendCatalogSettingsParam {
         catalogId: string;
         description: string;
         forceAcceptFriend: boolean;
     }
+    /**
+     * Defines the reusable parameter block ItemClassSettingsParam.
+     */
     class ItemClassSettingsParam {
         classId: string;
         description: string;
     }
+    /**
+     * Defines the reusable parameter block ItemCatalogSettingsParam.
+     */
     class ItemCatalogSettingsParam {
         catalogId: string;
         itemType: number;
         itemClassSettings: Array<ItemClassSettingsParam>;
     }
+    /**
+     * Defines the reusable parameter block GroupCatalogSettingsParam.
+     */
     class GroupCatalogSettingsParam {
         catalogId: string;
         description: string;
         forceAcceptMember: boolean;
     }
+    /**
+     * Defines the reusable parameter block TagSettingsParam.
+     */
     class TagSettingsParam {
         key: string;
         description: string;
         index: boolean;
     }
+    /**
+     * Defines the reusable parameter block DataSettingsParam.
+     */
     class DataSettingsParam {
         key: string;
         description: string;
         permission: number;
     }
+    /**
+     * Defines the reusable parameter block StatisticsSettingsParam.
+     */
     class StatisticsSettingsParam {
         key: string;
         statisticsAggregationMethod: number;
@@ -43,16 +94,25 @@ export declare namespace DashboardModels {
         description: string;
         index: boolean;
     }
+    /**
+     * Defines the reusable parameter block CurrencySettingsParam.
+     */
     class CurrencySettingsParam {
         key: string;
         initialValue: number;
         description: string;
         index: boolean;
     }
+    /**
+     * Defines the reusable parameter block CharacterCatalogSettingsParam.
+     */
     class CharacterCatalogSettingsParam {
         catalogId: string;
         description: string;
     }
+    /**
+     * Defines the reusable parameter block CharacterPlayerPermissionRulesParam.
+     */
     class CharacterPlayerPermissionRulesParam {
         addSegment?: PermissionRulesParam;
         removeSegment?: PermissionRulesParam;
@@ -108,6 +168,9 @@ export declare namespace DashboardModels {
         getStatisticsLog?: PermissionRulesParam;
         getCurrencyLog?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block CharacterPlayerSettingsParam.
+     */
     class CharacterPlayerSettingsParam {
         playerCurrenciesSettings?: Array<CurrencySettingsParam>;
         playerStatisticsSettings?: Array<StatisticsSettingsParam>;
@@ -118,6 +181,9 @@ export declare namespace DashboardModels {
         playerItemCatalogSettings?: Array<ItemCatalogSettingsParam>;
         playerFriendCatalogSettings?: Array<FriendCatalogSettingsParam>;
     }
+    /**
+     * Defines the reusable parameter block ContentPermissionRulesParam.
+     */
     class ContentPermissionRulesParam {
         getContentData?: PermissionRulesParam;
         setContentData?: PermissionRulesParam;
@@ -127,6 +193,9 @@ export declare namespace DashboardModels {
         removeFileUploadInfo?: PermissionRulesParam;
         requestDownloadFileUploadInfo?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block ThirtPartyAppleSettingsParam.
+     */
     class ThirtPartyAppleSettingsParam {
         appleClientId: string;
         sandboxEnable: boolean;
@@ -134,25 +203,40 @@ export declare namespace DashboardModels {
         keyId: string;
         p8Content: string;
     }
+    /**
+     * Defines the reusable parameter block ThirtPartyFacebookSettingsParam.
+     */
     class ThirtPartyFacebookSettingsParam {
         facebookAppId: string;
         facebookAppToken: string;
         facebookInappSecret: string;
     }
+    /**
+     * Defines the reusable parameter block ThirtPartyGoogleSettingsParam.
+     */
     class ThirtPartyGoogleSettingsParam {
         googleClientId: string;
         packageId: string;
         publicRSAKey: string;
     }
+    /**
+     * Defines the reusable parameter block ThirtPartyGameCenterSettingsParam.
+     */
     class ThirtPartyGameCenterSettingsParam {
         packageId: string;
     }
+    /**
+     * Defines the reusable parameter block ThirtPartyGooglePlayGameSettingsParam.
+     */
     class ThirtPartyGooglePlayGameSettingsParam {
         redirectUri: string;
         clientId: string;
         clientSecret: string;
         applicationId: string;
     }
+    /**
+     * Defines the reusable parameter block ThirtPartyParam.
+     */
     class ThirtPartyParam {
         googleSettings?: ThirtPartyGoogleSettingsParam;
         facebookSettings?: ThirtPartyFacebookSettingsParam;
@@ -160,6 +244,9 @@ export declare namespace DashboardModels {
         googlePlayGameSettings?: ThirtPartyGooglePlayGameSettingsParam;
         gameCenterSettings?: ThirtPartyGameCenterSettingsParam;
     }
+    /**
+     * Defines the reusable parameter block EmailSettingsParam.
+     */
     class EmailSettingsParam {
         sendFrom: string;
         secure: boolean;
@@ -168,11 +255,17 @@ export declare namespace DashboardModels {
         username: string;
         password: string;
     }
+    /**
+     * Defines the reusable parameter block PushNotificationSettingsParam.
+     */
     class PushNotificationSettingsParam {
         projectId: string;
         clientEmail: string;
         privateKey: string;
     }
+    /**
+     * Defines the reusable parameter block GamePlayerPermissionRulesParam.
+     */
     class GamePlayerPermissionRulesParam {
         addSegment?: PermissionRulesParam;
         removeSegment?: PermissionRulesParam;
@@ -227,6 +320,9 @@ export declare namespace DashboardModels {
         getStatisticsLog?: PermissionRulesParam;
         getCurrencyLog?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block GamePlayerSettingsParam.
+     */
     class GamePlayerSettingsParam {
         playerCurrenciesSettings?: Array<CurrencySettingsParam>;
         playerStatisticsSettings?: Array<StatisticsSettingsParam>;
@@ -238,6 +334,9 @@ export declare namespace DashboardModels {
         playerItemCatalogSettings?: Array<ItemCatalogSettingsParam>;
         playerFriendCatalogSettings?: Array<FriendCatalogSettingsParam>;
     }
+    /**
+     * Defines the reusable parameter block GroupSettingsParam.
+     */
     class GroupSettingsParam {
         groupCurrenciesSettings?: Array<CurrencySettingsParam>;
         groupStatisticsSettings?: Array<StatisticsSettingsParam>;
@@ -246,21 +345,33 @@ export declare namespace DashboardModels {
         tagsSettings?: Array<TagSettingsParam>;
         groupItemCatalogSettings?: Array<ItemCatalogSettingsParam>;
     }
+    /**
+     * Defines the reusable parameter block InventorySettingsParam.
+     */
     class InventorySettingsParam {
         itemStatisticsSettings?: Array<StatisticsSettingsParam>;
         itemDatasSettings?: Array<DataSettingsParam>;
         customDatasSettings?: Array<DataSettingsParam>;
         tagsSettings?: Array<TagSettingsParam>;
     }
+    /**
+     * Defines the reusable parameter block GameSettingsParam.
+     */
     class GameSettingsParam {
         gamePlayerSettings?: GamePlayerSettingsParam;
         characterPlayerSettings?: CharacterPlayerSettingsParam;
         groupSettings?: GroupSettingsParam;
         inventorySettings?: InventorySettingsParam;
     }
+    /**
+     * Defines the reusable parameter block GenericServiceSettingsParam.
+     */
     class GenericServiceSettingsParam {
         serviceName: string;
     }
+    /**
+     * Defines the reusable parameter block GroupPermissionRulesParam.
+     */
     class GroupPermissionRulesParam {
         addSegment?: PermissionRulesParam;
         removeSegment?: PermissionRulesParam;
@@ -303,6 +414,9 @@ export declare namespace DashboardModels {
         getStatisticsLog?: PermissionRulesParam;
         getCurrencyLog?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block InventoryPermissionRulesParam.
+     */
     class InventoryPermissionRulesParam {
         addSegment?: PermissionRulesParam;
         removeSegment?: PermissionRulesParam;
@@ -339,7 +453,10 @@ export declare namespace DashboardModels {
         getCreateLeaderboard?: PermissionRulesParam;
         getStatisticsLog?: PermissionRulesParam;
     }
-    class MasterAdminPermissionRulesParam {
+    /**
+     * Defines the reusable parameter block DashboardPermissionRulesParam.
+     */
+    class DashboardPermissionRulesParam {
         setMasterGameSettings?: PermissionRulesParam;
         createAdminAccount?: PermissionRulesParam;
         removeAdminAccount?: PermissionRulesParam;
@@ -366,6 +483,9 @@ export declare namespace DashboardModels {
         getServerGameData?: PermissionRulesParam;
         deleteInDatabase?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block MultiplayerPermissionRulesParam.
+     */
     class MultiplayerPermissionRulesParam {
         cancelAllMatchmakingTicket?: PermissionRulesParam;
         cancelMatchmakingTicket?: PermissionRulesParam;
@@ -378,6 +498,9 @@ export declare namespace DashboardModels {
         getAllMatchmakingTicket?: PermissionRulesParam;
         getAllMatch?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block MasterPlayerPermissionRulesParam.
+     */
     class MasterPlayerPermissionRulesParam {
         linkAccount?: PermissionRulesParam;
         linkAndroidDeviceId?: PermissionRulesParam;
@@ -421,7 +544,7 @@ export declare namespace DashboardModels {
         setDisplayName?: PermissionRulesParam;
         getTsCreate?: PermissionRulesParam;
         getIpAddressCreate?: PermissionRulesParam;
-        setTsLastLogin?: PermissionRulesParam;
+        updateTsLastLogin?: PermissionRulesParam;
         getTsLastLogin?: PermissionRulesParam;
         setPlayerBan?: PermissionRulesParam;
         getPlayerBan?: PermissionRulesParam;
@@ -466,6 +589,9 @@ export declare namespace DashboardModels {
         removePushNotification?: PermissionRulesParam;
         getPushNotification?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block MasterPlayerSettingsParam.
+     */
     class MasterPlayerSettingsParam {
         genericServiceSettings?: Array<GenericServiceSettingsParam>;
         playerCurrenciesSettings?: Array<CurrencySettingsParam>;
@@ -474,31 +600,49 @@ export declare namespace DashboardModels {
         customDatasSettings?: Array<DataSettingsParam>;
         tagsSettings?: Array<TagSettingsParam>;
     }
+    /**
+     * Defines the reusable parameter block SizeParam.
+     */
     class SizeParam {
         min: number;
         max: number;
     }
+    /**
+     * Defines the reusable parameter block TeamParam.
+     */
     class TeamParam {
         teamId: string;
         teamSize: SizeParam;
     }
+    /**
+     * Defines the reusable parameter block LinearExpansionsParam.
+     */
     class LinearExpansionsParam {
         secondsBetweenExpansions: number;
         delta?: number;
         limit?: number;
     }
+    /**
+     * Defines the reusable parameter block CustomExpansionsParam.
+     */
     class CustomExpansionsParam {
         secondsBetweenExpansions: number;
         overrideValue?: Array<any>;
         overrideMin?: Array<any>;
         overrideMax?: Array<any>;
     }
+    /**
+     * Defines the reusable parameter block AdvancedSettingsParam.
+     */
     class AdvancedSettingsParam {
         secondsUntilOptional: number;
         expansionType?: number;
         linearExpansions?: LinearExpansionsParam;
         customExpansions?: CustomExpansionsParam;
     }
+    /**
+     * Defines the reusable parameter block RuleParam.
+     */
     class RuleParam {
         name: string;
         type: number;
@@ -511,9 +655,15 @@ export declare namespace DashboardModels {
         max?: number;
         advancedSettings?: AdvancedSettingsParam;
     }
+    /**
+     * Defines the reusable parameter block ServerAllocationParam.
+     */
     class ServerAllocationParam {
         enable: boolean;
     }
+    /**
+     * Defines the reusable parameter block MatchmakingQueueSettingsParam.
+     */
     class MatchmakingQueueSettingsParam {
         queueName: string;
         matchSize: SizeParam;
@@ -523,6 +673,9 @@ export declare namespace DashboardModels {
         rules?: Array<RuleParam>;
         remove?: boolean;
     }
+    /**
+     * Defines the reusable parameter block AuthenticatePermissionRulesParam.
+     */
     class AuthenticatePermissionRulesParam {
         loginByAccount?: PermissionRulesParam;
         loginByAndroidDeviceId?: PermissionRulesParam;
@@ -543,6 +696,9 @@ export declare namespace DashboardModels {
         loginByWindowsDeviceId?: PermissionRulesParam;
         refreshAuthToken?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block StoreInventoryPermissionRulesParam.
+     */
     class StoreInventoryPermissionRulesParam {
         buyStoreItem?: PermissionRulesParam;
         getStoreItemInformation?: PermissionRulesParam;
@@ -559,6 +715,9 @@ export declare namespace DashboardModels {
         getStoreUsed?: PermissionRulesParam;
         removeStoreUsed?: PermissionRulesParam;
     }
+    /**
+     * Defines the reusable parameter block CloudScriptPermissionRulesParam.
+     */
     class CloudScriptPermissionRulesParam {
         executeFunction?: PermissionRulesParam;
         addFunction?: PermissionRulesParam;
@@ -566,6 +725,11 @@ export declare namespace DashboardModels {
         getFunction?: PermissionRulesParam;
         editFunction?: PermissionRulesParam;
     }
+    /**
+     * Defines the top-level permission tree assigned to one secret info entry.
+     *
+     * Each optional property groups permission rules by API domain.
+     */
     class PermissionParam {
         authenticate?: AuthenticatePermissionRulesParam;
         masterPlayer?: MasterPlayerPermissionRulesParam;
@@ -575,53 +739,102 @@ export declare namespace DashboardModels {
         group?: GroupPermissionRulesParam;
         inventory?: InventoryPermissionRulesParam;
         storeInventory?: StoreInventoryPermissionRulesParam;
-        masterAdmin?: MasterAdminPermissionRulesParam;
+        dashboard?: DashboardPermissionRulesParam;
         multiplayer?: MultiplayerPermissionRulesParam;
         cloudScript?: CloudScriptPermissionRulesParam;
     }
+    /**
+     * Defines the request payload for ChangePasswordAdminAccount.
+     */
     class ChangePasswordAdminAccountRequestData {
         currentPassword: string;
         password: string;
     }
+    /**
+     * Defines the request payload for GetAdminAccountList.
+     */
     class GetAdminAccountListRequestData {
     }
+    /**
+     * Defines the request payload for GetGameInformation.
+     */
     class GetGameInformationRequestData {
         gameId: string;
     }
+    /**
+     * Defines the request payload for GetGameList.
+     */
     class GetGameListRequestData {
     }
+    /**
+     * Defines the request payload for GetMasterGameSettings.
+     */
     class GetMasterGameSettingsRequestData {
     }
+    /**
+     * Defines the request payload for GetSecretInfoInformation.
+     */
     class GetSecretInfoInformationRequestData {
         secretKey: string;
     }
+    /**
+     * Defines the request payload for GetSecretInfoList.
+     */
     class GetSecretInfoListRequestData {
     }
+    /**
+     * Defines the request payload for GetServerLog.
+     */
     class GetServerLogRequestData {
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for CreateAdminAccount.
+     */
     class CreateAdminAccountRequestData {
         username: string;
         password: string;
         secretKey: string;
     }
+    /**
+     * Defines the request payload for CreateGame.
+     */
     class CreateGameRequestData {
         gameId: string;
     }
+    /**
+     * Defines the request payload for `createSecretInfo`.
+     *
+     * `permissionParam` is the authoritative permission tree that controls which operations
+     * the created secret key may execute on the GearN Server.
+     */
     class CreateSecretInfoRequestData {
+        /** Optional custom secret key. If omitted, the backend may generate one. */
         secretKey?: string;
+        /** Optional target game id when creating a secret for a specific game. */
         gameId?: string;
-        role: number;
+        /** Optional permission tree granted to the new secret key. */
         permissionParam?: PermissionParam;
     }
+    /**
+     * Defines the request payload for `loginByAdminAccount`.
+     *
+     * A successful response returns an auth token that later dashboard calls reuse so backend middleware can resolve admin context.
+     */
     class LoginByAdminAccountRequestData {
         username: string;
         password: string;
     }
+    /**
+     * Defines the request payload for RemoveAdminAccount.
+     */
     class RemoveAdminAccountRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for SetGameInformation.
+     */
     class SetGameInformationRequestData {
         gameId: string;
         gameName?: string;
@@ -630,16 +843,25 @@ export declare namespace DashboardModels {
         gameSettings?: GameSettingsParam;
         matchmakingQueueSettings?: Array<MatchmakingQueueSettingsParam>;
     }
+    /**
+     * Defines the request payload for SetMasterGameSettings.
+     */
     class SetMasterGameSettingsRequestData {
         thirtPartySettings?: ThirtPartyParam;
         masterPlayerSettings?: MasterPlayerSettingsParam;
         emailSettings?: EmailSettingsParam;
         pushNotificationSettings?: PushNotificationSettingsParam;
     }
+    /**
+     * Defines the request payload for SetPasswordAdminAccount.
+     */
     class SetPasswordAdminAccountRequestData {
         userId: string;
         password: string;
     }
+    /**
+     * Defines the request payload for SetSecretInfoInformation.
+     */
     class SetSecretInfoInformationRequestData {
         secretKey: string;
         remove?: boolean;
@@ -647,10 +869,16 @@ export declare namespace DashboardModels {
         description?: string;
         permissionParam?: PermissionParam;
     }
+    /**
+     * Defines the request payload for SetSecretKeyAdminAccount.
+     */
     class SetSecretKeyAdminAccountRequestData {
         userId: string;
         secretKey: string;
     }
+    /**
+     * Defines the request payload for GetAnalytics.
+     */
     class GetAnalyticsRequestData {
         timestamp?: number;
         analyticsItem?: boolean;
@@ -662,15 +890,27 @@ export declare namespace DashboardModels {
         cost?: boolean;
         monthlyCost?: boolean;
     }
+    /**
+     * Defines the request payload for GetUsernameAdminAccount.
+     */
     class GetUsernameAdminAccountRequestData {
         userId: string;
     }
+    /**
+     * Defines the request payload for GetEventCallbackCloudScript.
+     */
     class GetEventCallbackCloudScriptRequestData {
     }
+    /**
+     * Defines the request payload for SetEventCallbackCloudScript.
+     */
     class SetEventCallbackCloudScriptRequestData {
         eventName: string;
         script: string;
     }
+    /**
+     * Defines the request payload for ResetStatisticsLeaderboard.
+     */
     class ResetStatisticsLeaderboardRequestData {
         type: number;
         key: string;
@@ -679,17 +919,26 @@ export declare namespace DashboardModels {
         log?: string;
         catalogId?: string;
     }
+    /**
+     * Defines the request payload for DeleteInDatabase.
+     */
     class DeleteInDatabaseRequestData {
         type: number;
         id: string;
         gameId: string;
         log?: string;
     }
+    /**
+     * Defines the request payload for GetBackupStatisticsLeaderboardVersion.
+     */
     class GetBackupStatisticsLeaderboardVersionRequestData {
         gameId: string;
         type: number;
         key: string;
     }
+    /**
+     * Defines the request payload for GetServerGameData.
+     */
     class GetServerGameDataRequestData {
         gameId: string;
         masterPlayerCount?: boolean;
@@ -701,14 +950,23 @@ export declare namespace DashboardModels {
         country?: boolean;
         version?: boolean;
     }
+    /**
+     * Defines the response payload for AdminAccount.
+     */
     class AdminAccountResponseData {
         userId: string;
         username: string;
         secretKey: string;
     }
+    /**
+     * Defines the response payload for GetAdminAccountList.
+     */
     class GetAdminAccountListResponseData {
         results: Array<AdminAccountResponseData>;
     }
+    /**
+     * Defines the response payload for GetGameInformation.
+     */
     class GetGameInformationResponseData {
         gameId: string;
         tsCreate: number;
@@ -719,49 +977,91 @@ export declare namespace DashboardModels {
         gameSettings: GameSettingsParam;
         matchmakingQueueSettings: Array<MatchmakingQueueSettingsParam>;
     }
+    /**
+     * Defines the response payload for GameWithGameId.
+     */
     class GameWithGameIdResponseData {
         gameId: string;
     }
+    /**
+     * Defines the response payload for GetGameList.
+     */
     class GetGameListResponseData {
         results: Array<GameWithGameIdResponseData>;
     }
+    /**
+     * Defines the response payload for `getMasterGameSettings`.
+     *
+     * This payload contains the full top-level dashboard configuration snapshot used to provision a game.
+     */
     class GetMasterGameSettingsResponseData {
         thirtPartySettings: ThirtPartyParam;
         masterPlayerSettings: MasterPlayerSettingsParam;
         emailSettings: EmailSettingsParam;
         pushNotificationSettings: PushNotificationSettingsParam;
     }
+    /**
+     * Defines the response payload for `getSecretInfoInformation`.
+     *
+     * This is the detailed secret-info record, including role, lifecycle flags, and permission tree.
+     */
     class GetSecretInfoInformationResponseData {
+        /** Secret key whose detailed configuration was requested. */
         secretKey: string;
         gameId: string;
-        role: number;
         tsCreate: number;
         creatorId: string;
         remove: boolean;
         tsExpire: number;
         description: string;
+        /** Permission tree granted to this secret key. */
         permissionParam: PermissionParam;
     }
+    /**
+     * Defines a lightweight secret-info item returned by secret-list queries.
+     */
     class SecretInfoWithSecretKeyResponseData {
         secretKey: string;
     }
+    /**
+     * Defines the response payload for `getSecretInfoList`.
+     *
+     * Results are grouped by secret role instead of being returned as one flat array.
+     */
     class GetSecretInfoListResponseData {
-        adminSecretKeys: Array<SecretInfoWithSecretKeyResponseData>;
-        serverSecretKeys: Array<SecretInfoWithSecretKeyResponseData>;
-        playerSecretKeys: Array<SecretInfoWithSecretKeyResponseData>;
+        /** Secret keys whose role is admin. */
+        secretKeys: Array<SecretInfoWithSecretKeyResponseData>;
     }
+    /**
+     * Defines the response payload for AdminAccountWithUserId.
+     */
     class AdminAccountWithUserIdResponseData {
         userId: string;
     }
+    /**
+     * Defines the response payload for CreateAdminAccount.
+     */
     class CreateAdminAccountResponseData {
         results: Array<AdminAccountWithUserIdResponseData>;
     }
+    /**
+     * Defines the response payload for `loginByAdminAccount`.
+     *
+     * The returned auth token should be cached and reused for subsequent dashboard requests.
+     */
     class LoginByAdminAccountResponseData {
+        /** Auth token representing the authenticated admin account. */
         authToken: string;
     }
+    /**
+     * Defines the response payload for GetServerLog.
+     */
     class GetServerLogResponseData {
         results: Array<string>;
     }
+    /**
+     * Defines the response payload for CountryRegion.
+     */
     class CountryRegionResponseData {
         regionCode: string;
         regionName: string;
@@ -769,10 +1069,16 @@ export declare namespace DashboardModels {
         latitude: number;
         longitude: number;
     }
+    /**
+     * Defines the response payload for Country.
+     */
     class CountryResponseData {
         countryCode: string;
         regions: Array<CountryRegionResponseData>;
     }
+    /**
+     * Defines the response payload for AnalyticsItem.
+     */
     class AnalyticsItemResponseData {
         ccu: number;
         dau: number;
@@ -789,15 +1095,24 @@ export declare namespace DashboardModels {
         mrtSince0h1: number;
         analyticsPrice: number;
     }
+    /**
+     * Defines the response payload for MemoryUsage.
+     */
     class MemoryUsageResponseData {
         freeMemoryInBytes: number;
         totalMemoryInBytes: number;
     }
+    /**
+     * Defines the response payload for StorageUsage.
+     */
     class StorageUsageResponseData {
         name: string;
         fsTotalSizeInBytes: number;
         fsUsedSizeInBytes: number;
     }
+    /**
+     * Defines the response payload for DatabaseSystem.
+     */
     class DatabaseSystemResponseData {
         fsTotalSizeInBytes: number;
         fsUsedSizeInBytes: number;
@@ -806,19 +1121,31 @@ export declare namespace DashboardModels {
         objects: number;
         indexes: number;
     }
+    /**
+     * Defines the response payload for OperationSystem.
+     */
     class OperationSystemResponseData {
         cpuUsage: number;
         memoryUsage: MemoryUsageResponseData;
         storageUsage: Array<StorageUsageResponseData>;
     }
+    /**
+     * Defines the response payload for RequestCompleteErrorCode.
+     */
     class RequestCompleteErrorCodeResponseData {
         errorCode: number;
         count: number;
     }
+    /**
+     * Defines the response payload for RequestComplete.
+     */
     class RequestCompleteResponseData {
         eventName: string;
         results: Array<RequestCompleteErrorCodeResponseData>;
     }
+    /**
+     * Defines the response payload for Cost.
+     */
     class CostResponseData {
         requestCount: number;
         matchmakingRequestCount: number;
@@ -826,6 +1153,9 @@ export declare namespace DashboardModels {
         storageSizeInBytes: number;
         dataTransferSizeInBytes: number;
     }
+    /**
+     * Defines the response payload for GetAnalytics.
+     */
     class GetAnalyticsResponseData {
         analyticsItem?: AnalyticsItemResponseData;
         country?: Array<CountryResponseData>;
@@ -836,34 +1166,62 @@ export declare namespace DashboardModels {
         cost?: CostResponseData;
         monthlyCost?: CostResponseData;
     }
+    /**
+     * Defines the response payload for GetUsernameAdminAccount.
+     */
     class GetUsernameAdminAccountResponseData {
         username: string;
     }
+    /**
+     * Defines the response payload for ChildScript.
+     */
     class ChildScriptResponseData {
         eventName: string;
         script: string;
         hasEdit: boolean;
     }
+    /**
+     * Defines the response payload for EventCallbackCloudScript.
+     */
     class EventCallbackCloudScriptResponseData {
         type: string;
         tsCreate: number;
         version: string;
         childScripts: Array<ChildScriptResponseData>;
     }
+    /**
+     * Defines the response payload for `getEventCallbackCloudScript`.
+     *
+     * Each result links one event callback registration to a CloudScript target.
+     */
     class GetEventCallbackCloudScriptResponseData {
         results: Array<EventCallbackCloudScriptResponseData>;
     }
+    /**
+     * Defines the response payload for SetEventCallbackCloudScript.
+     */
     class SetEventCallbackCloudScriptResponseData {
         errorMessage: string;
     }
+    /**
+     * Defines the response payload for BackupStatisticsLeaderboardVersion.
+     */
     class BackupStatisticsLeaderboardVersionResponseData {
         version: string;
         log: string;
         tsCreate: number;
     }
+    /**
+     * Defines the response payload for GetBackupStatisticsLeaderboardVersion.
+     */
     class GetBackupStatisticsLeaderboardVersionResponseData {
         results: Array<BackupStatisticsLeaderboardVersionResponseData>;
     }
+    /**
+     * Defines the response payload for `getServerGameData`.
+     *
+     * This is a high-level telemetry snapshot of entity counts, country breakdown, and server version data.
+     */
     class GetServerGameDataResponseData {
         masterPlayerCount?: number;
         gamePlayerCount?: number;
@@ -871,9 +1229,14 @@ export declare namespace DashboardModels {
         inventoryCount?: number;
         storeInventoryCount?: number;
         groupCount?: number;
+        /** Optional country-level breakdown returned by the backend. */
         country?: Array<CountryResponseData>;
+        /** Optional server or game-data version string reported by the backend. */
         version?: string;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }