/** * 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; } /** * 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; maximumValue?: number; minimumValue?: number; initialValue: number; 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; getSegment?: PermissionRulesParam; setTag?: PermissionRulesParam; removeTag?: PermissionRulesParam; getTag?: PermissionRulesParam; getDisplayName?: PermissionRulesParam; setDisplayName?: PermissionRulesParam; getTsCreate?: PermissionRulesParam; getIpAddressCreate?: PermissionRulesParam; getTsLastLogin?: PermissionRulesParam; setPlayerBan?: PermissionRulesParam; getPlayerBan?: PermissionRulesParam; setCountryCode?: PermissionRulesParam; getCountryCode?: PermissionRulesParam; setAvatar?: PermissionRulesParam; getAvatar?: PermissionRulesParam; changePlayerCurrency?: PermissionRulesParam; getPlayerCurrency?: PermissionRulesParam; changePlayerStatistics?: PermissionRulesParam; getPlayerStatistics?: PermissionRulesParam; getStatisticsLeaderboard?: PermissionRulesParam; getStatisticsLeaderboardAroundPlayer?: PermissionRulesParam; getCustomData?: PermissionRulesParam; setCustomData?: PermissionRulesParam; setPlayerData?: PermissionRulesParam; getPlayerData?: PermissionRulesParam; getPlayerInformation?: PermissionRulesParam; getPlayersWithSegment?: PermissionRulesParam; getPlayersWithTag?: PermissionRulesParam; getCatalogId?: PermissionRulesParam; getOwner?: PermissionRulesParam; getRemoveStatus?: PermissionRulesParam; getPlayerFriend?: PermissionRulesParam; getPlayerGroup?: PermissionRulesParam; getPlayerInventory?: PermissionRulesParam; removePlayerItem?: PermissionRulesParam; createPlayerItem?: PermissionRulesParam; createGroup?: PermissionRulesParam; joinGroup?: PermissionRulesParam; leaveGroup?: PermissionRulesParam; setOwner?: PermissionRulesParam; addPlayerFriend?: PermissionRulesParam; removePlayerFriend?: PermissionRulesParam; getPlayersWithDisplayName?: PermissionRulesParam; setRemoveStatus?: PermissionRulesParam; getFriendStatisticsLeaderboardAroundPlayer?: PermissionRulesParam; getFriendStatisticsLeaderboard?: PermissionRulesParam; getCurrencyLeaderboard?: PermissionRulesParam; getCreateLeaderboard?: PermissionRulesParam; getLastLoginLeaderboard?: PermissionRulesParam; getStatisticsLog?: PermissionRulesParam; getCurrencyLog?: PermissionRulesParam; } /** * Defines the reusable parameter block CharacterPlayerSettingsParam. */ class CharacterPlayerSettingsParam { playerCurrenciesSettings?: Array; playerStatisticsSettings?: Array; playerDatasSettings?: Array; customDatasSettings?: Array; tagsSettings?: Array; playerGroupCatalogSettings?: Array; playerItemCatalogSettings?: Array; playerFriendCatalogSettings?: Array; } /** * Defines the reusable parameter block ContentPermissionRulesParam. */ class ContentPermissionRulesParam { getContentData?: PermissionRulesParam; setContentData?: PermissionRulesParam; createNewFileUploadInfo?: PermissionRulesParam; getFileUploadInfoList?: PermissionRulesParam; getFileUploadInfo?: PermissionRulesParam; removeFileUploadInfo?: PermissionRulesParam; requestDownloadFileUploadInfo?: PermissionRulesParam; } /** * Defines the reusable parameter block ThirtPartyAppleSettingsParam. */ class ThirtPartyAppleSettingsParam { appleClientId: string; sandboxEnable: boolean; issuerId: string; 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; appleSettings?: ThirtPartyAppleSettingsParam; googlePlayGameSettings?: ThirtPartyGooglePlayGameSettingsParam; gameCenterSettings?: ThirtPartyGameCenterSettingsParam; } /** * Defines the reusable parameter block EmailSettingsParam. */ class EmailSettingsParam { sendFrom: string; secure: boolean; host: string; port: number; 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; getSegment?: PermissionRulesParam; setTag?: PermissionRulesParam; removeTag?: PermissionRulesParam; getTag?: PermissionRulesParam; getDisplayName?: PermissionRulesParam; setDisplayName?: PermissionRulesParam; getTsCreate?: PermissionRulesParam; getIpAddressCreate?: PermissionRulesParam; getTsLastLogin?: PermissionRulesParam; setPlayerBan?: PermissionRulesParam; getPlayerBan?: PermissionRulesParam; setCountryCode?: PermissionRulesParam; getCountryCode?: PermissionRulesParam; setAvatar?: PermissionRulesParam; getAvatar?: PermissionRulesParam; changePlayerCurrency?: PermissionRulesParam; getPlayerCurrency?: PermissionRulesParam; changePlayerStatistics?: PermissionRulesParam; getPlayerStatistics?: PermissionRulesParam; getStatisticsLeaderboard?: PermissionRulesParam; getStatisticsLeaderboardAroundPlayer?: PermissionRulesParam; getCustomData?: PermissionRulesParam; setCustomData?: PermissionRulesParam; setPlayerData?: PermissionRulesParam; getPlayerData?: PermissionRulesParam; getPlayerInformation?: PermissionRulesParam; getPlayersWithSegment?: PermissionRulesParam; getPlayersWithTag?: PermissionRulesParam; getPlayerCharacter?: PermissionRulesParam; getPlayerInventory?: PermissionRulesParam; getPlayerGroup?: PermissionRulesParam; getPlayerFriend?: PermissionRulesParam; removePlayerItem?: PermissionRulesParam; getOnlineStatus?: PermissionRulesParam; createGroup?: PermissionRulesParam; createPlayerItem?: PermissionRulesParam; createPlayerCharacter?: PermissionRulesParam; addPlayerFriend?: PermissionRulesParam; removePlayerFriend?: PermissionRulesParam; removePlayerCharacter?: PermissionRulesParam; joinGroup?: PermissionRulesParam; leaveGroup?: PermissionRulesParam; getPlayersWithDisplayName?: PermissionRulesParam; getFriendStatisticsLeaderboardAroundPlayer?: PermissionRulesParam; getFriendStatisticsLeaderboard?: PermissionRulesParam; getCurrencyLeaderboard?: PermissionRulesParam; getCreateLeaderboard?: PermissionRulesParam; getLastLoginLeaderboard?: PermissionRulesParam; getStatisticsLog?: PermissionRulesParam; getCurrencyLog?: PermissionRulesParam; } /** * Defines the reusable parameter block GamePlayerSettingsParam. */ class GamePlayerSettingsParam { playerCurrenciesSettings?: Array; playerStatisticsSettings?: Array; playerDatasSettings?: Array; customDatasSettings?: Array; tagsSettings?: Array; playerCharacterCatalogSettings?: Array; playerGroupCatalogSettings?: Array; playerItemCatalogSettings?: Array; playerFriendCatalogSettings?: Array; } /** * Defines the reusable parameter block GroupSettingsParam. */ class GroupSettingsParam { groupCurrenciesSettings?: Array; groupStatisticsSettings?: Array; groupDatasSettings?: Array; customDatasSettings?: Array; tagsSettings?: Array; groupItemCatalogSettings?: Array; } /** * Defines the reusable parameter block InventorySettingsParam. */ class InventorySettingsParam { itemStatisticsSettings?: Array; itemDatasSettings?: Array; customDatasSettings?: Array; tagsSettings?: Array; } /** * 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; getSegment?: PermissionRulesParam; setTag?: PermissionRulesParam; removeTag?: PermissionRulesParam; getTag?: PermissionRulesParam; getDisplayName?: PermissionRulesParam; setDisplayName?: PermissionRulesParam; getTsCreate?: PermissionRulesParam; setAvatar?: PermissionRulesParam; getAvatar?: PermissionRulesParam; changeGroupCurrency?: PermissionRulesParam; getGroupCurrency?: PermissionRulesParam; changeGroupStatistics?: PermissionRulesParam; getGroupStatistics?: PermissionRulesParam; getStatisticsLeaderboard?: PermissionRulesParam; getStatisticsLeaderboardAroundGroup?: PermissionRulesParam; getCustomData?: PermissionRulesParam; setCustomData?: PermissionRulesParam; setGroupData?: PermissionRulesParam; getGroupData?: PermissionRulesParam; getGroupInformation?: PermissionRulesParam; getGroupsWithSegment?: PermissionRulesParam; getGroupsWithTag?: PermissionRulesParam; getCatalogId?: PermissionRulesParam; getRemoveStatus?: PermissionRulesParam; getGroupInventory?: PermissionRulesParam; removeGroupItem?: PermissionRulesParam; createGroupItem?: PermissionRulesParam; getMembers?: PermissionRulesParam; addMember?: PermissionRulesParam; removeMember?: PermissionRulesParam; sendGroupMessage?: PermissionRulesParam; getGroupMessage?: PermissionRulesParam; setRemoveStatus?: PermissionRulesParam; getGroupsWithDisplayName?: PermissionRulesParam; getCurrencyLeaderboard?: PermissionRulesParam; getCreateLeaderboard?: PermissionRulesParam; getStatisticsLog?: PermissionRulesParam; getCurrencyLog?: PermissionRulesParam; } /** * Defines the reusable parameter block InventoryPermissionRulesParam. */ class InventoryPermissionRulesParam { addSegment?: PermissionRulesParam; removeSegment?: PermissionRulesParam; getSegment?: PermissionRulesParam; setTag?: PermissionRulesParam; removeTag?: PermissionRulesParam; getTag?: PermissionRulesParam; getDisplayName?: PermissionRulesParam; setDisplayName?: PermissionRulesParam; getTsCreate?: PermissionRulesParam; setAvatar?: PermissionRulesParam; getAvatar?: PermissionRulesParam; changeItemStatistics?: PermissionRulesParam; getItemStatistics?: PermissionRulesParam; getStatisticsLeaderboard?: PermissionRulesParam; getStatisticsLeaderboardAroundItem?: PermissionRulesParam; getCustomData?: PermissionRulesParam; setCustomData?: PermissionRulesParam; setItemData?: PermissionRulesParam; getItemData?: PermissionRulesParam; getItemInformation?: PermissionRulesParam; getItemsWithSegment?: PermissionRulesParam; getItemsWithTag?: PermissionRulesParam; getCatalogId?: PermissionRulesParam; getClassId?: PermissionRulesParam; getItemType?: PermissionRulesParam; getAmount?: PermissionRulesParam; getOwner?: PermissionRulesParam; getRemoveStatus?: PermissionRulesParam; setAmount?: PermissionRulesParam; setOwner?: PermissionRulesParam; setRemoveStatus?: PermissionRulesParam; getItemsWithDisplayName?: PermissionRulesParam; getCreateLeaderboard?: PermissionRulesParam; getStatisticsLog?: PermissionRulesParam; } /** * Defines the reusable parameter block DashboardPermissionRulesParam. */ class DashboardPermissionRulesParam { setMasterGameSettings?: PermissionRulesParam; createAdminAccount?: PermissionRulesParam; removeAdminAccount?: PermissionRulesParam; setPasswordAdminAccount?: PermissionRulesParam; setSecretKeyAdminAccount?: PermissionRulesParam; setGameInformation?: PermissionRulesParam; createGame?: PermissionRulesParam; changePasswordAdminAccount?: PermissionRulesParam; getAdminAccountList?: PermissionRulesParam; getGameInformation?: PermissionRulesParam; getGameList?: PermissionRulesParam; getMasterGameSettings?: PermissionRulesParam; getServerLog?: PermissionRulesParam; getSecretInfoInformation?: PermissionRulesParam; getSecretInfoList?: PermissionRulesParam; createSecretInfo?: PermissionRulesParam; setSecretInfoInformation?: PermissionRulesParam; getUsernameAdminAccount?: PermissionRulesParam; getAnalytics?: PermissionRulesParam; getEventCallbackCloudScript?: PermissionRulesParam; setEventCallbackCloudScript?: PermissionRulesParam; resetStatisticsLeaderboard?: PermissionRulesParam; getBackupStatisticsLeaderboardVersion?: PermissionRulesParam; getServerGameData?: PermissionRulesParam; deleteInDatabase?: PermissionRulesParam; } /** * Defines the reusable parameter block MultiplayerPermissionRulesParam. */ class MultiplayerPermissionRulesParam { cancelAllMatchmakingTicket?: PermissionRulesParam; cancelMatchmakingTicket?: PermissionRulesParam; createMatchmakingTicket?: PermissionRulesParam; getMatchmakingTicket?: PermissionRulesParam; getMatch?: PermissionRulesParam; getQueueStatistics?: PermissionRulesParam; joinMatchmakingTicket?: PermissionRulesParam; listMatchmakingTicketsForPlayer?: PermissionRulesParam; getAllMatchmakingTicket?: PermissionRulesParam; getAllMatch?: PermissionRulesParam; } /** * Defines the reusable parameter block MasterPlayerPermissionRulesParam. */ class MasterPlayerPermissionRulesParam { linkAccount?: PermissionRulesParam; linkAndroidDeviceId?: PermissionRulesParam; linkApple?: PermissionRulesParam; linkCustomDeviceId?: PermissionRulesParam; linkCustomId?: PermissionRulesParam; linkEditorDeviceId?: PermissionRulesParam; linkFacebook?: PermissionRulesParam; linkGenericService?: PermissionRulesParam; linkGoogle?: PermissionRulesParam; linkGooglePlayGameService?: PermissionRulesParam; linkGameCenter?: PermissionRulesParam; linkiOSDeviceId?: PermissionRulesParam; linkLinuxDeviceId?: PermissionRulesParam; linkMacOSDeviceId?: PermissionRulesParam; linkWindowsDeviceId?: PermissionRulesParam; linkWindowsPhoneDeviceId?: PermissionRulesParam; unlinkAccount?: PermissionRulesParam; unlinkAndroidDeviceId?: PermissionRulesParam; unlinkApple?: PermissionRulesParam; unlinkCustomDeviceId?: PermissionRulesParam; unlinkCustomId?: PermissionRulesParam; unlinkEditorDeviceId?: PermissionRulesParam; unlinkFacebook?: PermissionRulesParam; unlinkGenericService?: PermissionRulesParam; unlinkGoogle?: PermissionRulesParam; unlinkGooglePlayGameService?: PermissionRulesParam; unlinkGameCenter?: PermissionRulesParam; unlinkiOSDeviceId?: PermissionRulesParam; unlinkLinuxDeviceId?: PermissionRulesParam; unlinkMacOSDeviceId?: PermissionRulesParam; unlinkWindowsDeviceId?: PermissionRulesParam; unlinkWindowsPhoneDeviceId?: PermissionRulesParam; addSegment?: PermissionRulesParam; removeSegment?: PermissionRulesParam; getSegment?: PermissionRulesParam; setTag?: PermissionRulesParam; removeTag?: PermissionRulesParam; getTag?: PermissionRulesParam; getDisplayName?: PermissionRulesParam; setDisplayName?: PermissionRulesParam; getTsCreate?: PermissionRulesParam; getIpAddressCreate?: PermissionRulesParam; updateTsLastLogin?: PermissionRulesParam; getTsLastLogin?: PermissionRulesParam; setPlayerBan?: PermissionRulesParam; getPlayerBan?: PermissionRulesParam; setCountryCode?: PermissionRulesParam; getCountryCode?: PermissionRulesParam; changeAccountPassword?: PermissionRulesParam; resetAccountPassword?: PermissionRulesParam; setAvatar?: PermissionRulesParam; getAvatar?: PermissionRulesParam; changePlayerCurrency?: PermissionRulesParam; getPlayerCurrency?: PermissionRulesParam; changePlayerStatistics?: PermissionRulesParam; getPlayerStatistics?: PermissionRulesParam; getStatisticsLeaderboard?: PermissionRulesParam; getStatisticsLeaderboardAroundPlayer?: PermissionRulesParam; getCustomData?: PermissionRulesParam; setCustomData?: PermissionRulesParam; setPlayerData?: PermissionRulesParam; getPlayerData?: PermissionRulesParam; getPlayerInformation?: PermissionRulesParam; getPlayersWithApple?: PermissionRulesParam; getPlayersWithFacebook?: PermissionRulesParam; getPlayersWithGoogle?: PermissionRulesParam; getPlayersWithGenericService?: PermissionRulesParam; getPlayersWithSegment?: PermissionRulesParam; getPlayersWithTag?: PermissionRulesParam; getPlayersWithGooglePlayGameService?: PermissionRulesParam; getPlayersWithGameCenter?: PermissionRulesParam; getExternal?: PermissionRulesParam; getPlayersWithDisplayName?: PermissionRulesParam; getEmail?: PermissionRulesParam; setEmail?: PermissionRulesParam; getCurrencyLeaderboard?: PermissionRulesParam; getLastLoginLeaderboard?: PermissionRulesParam; getCreateLeaderboard?: PermissionRulesParam; getStatisticsLog?: PermissionRulesParam; getCurrencyLog?: PermissionRulesParam; sendSocketOperationEvent?: PermissionRulesParam; sendEmail?: PermissionRulesParam; sendPushNotification?: PermissionRulesParam; addPushNotification?: PermissionRulesParam; removePushNotification?: PermissionRulesParam; getPushNotification?: PermissionRulesParam; } /** * Defines the reusable parameter block MasterPlayerSettingsParam. */ class MasterPlayerSettingsParam { genericServiceSettings?: Array; playerCurrenciesSettings?: Array; playerStatisticsSettings?: Array; playerDatasSettings?: Array; customDatasSettings?: Array; tagsSettings?: Array; } /** * 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; overrideMin?: Array; overrideMax?: Array; } /** * 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; attributeSource?: number; attributePath?: string; defaultValue?: any; compairType?: number; allowedDifference?: number; min?: number; 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; ticketSize: SizeParam; serverAllocation: ServerAllocationParam; teams?: Array; rules?: Array; remove?: boolean; } /** * Defines the reusable parameter block AuthenticatePermissionRulesParam. */ class AuthenticatePermissionRulesParam { loginByAccount?: PermissionRulesParam; loginByAndroidDeviceId?: PermissionRulesParam; loginByApple?: PermissionRulesParam; loginByCustomDeviceId?: PermissionRulesParam; loginByCustomId?: PermissionRulesParam; loginByFacebook?: PermissionRulesParam; loginByGenericService?: PermissionRulesParam; loginByGoogle?: PermissionRulesParam; loginByGooglePlayGameService?: PermissionRulesParam; loginByGameCenter?: PermissionRulesParam; loginByiOSDeviceId?: PermissionRulesParam; loginByWindowsPhoneDeviceId?: PermissionRulesParam; registerAccount?: PermissionRulesParam; loginByEditorDeviceId?: PermissionRulesParam; loginByLinuxDeviceId?: PermissionRulesParam; loginByMacOSDeviceId?: PermissionRulesParam; loginByWindowsDeviceId?: PermissionRulesParam; refreshAuthToken?: PermissionRulesParam; } /** * Defines the reusable parameter block StoreInventoryPermissionRulesParam. */ class StoreInventoryPermissionRulesParam { buyStoreItem?: PermissionRulesParam; getStoreItemInformation?: PermissionRulesParam; getStoreItemsWithTag?: PermissionRulesParam; createStoreItem?: PermissionRulesParam; setRemoveStatus?: PermissionRulesParam; setStoreItemInformation?: PermissionRulesParam; validateAppleAppStoreReceipt?: PermissionRulesParam; validateGooglePlayStoreReceipt?: PermissionRulesParam; validateFacebookStoreReceipt?: PermissionRulesParam; getCreateLeaderboard?: PermissionRulesParam; presentStoreItem?: PermissionRulesParam; getStoreLog?: PermissionRulesParam; getStoreUsed?: PermissionRulesParam; removeStoreUsed?: PermissionRulesParam; } /** * Defines the reusable parameter block CloudScriptPermissionRulesParam. */ class CloudScriptPermissionRulesParam { executeFunction?: PermissionRulesParam; addFunction?: PermissionRulesParam; getFunctions?: PermissionRulesParam; 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; gamePlayer?: GamePlayerPermissionRulesParam; characterPlayer?: CharacterPlayerPermissionRulesParam; content?: ContentPermissionRulesParam; group?: GroupPermissionRulesParam; inventory?: InventoryPermissionRulesParam; storeInventory?: StoreInventoryPermissionRulesParam; 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; /** 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; gameDescription?: string; gameIconUrl?: string; gameSettings?: GameSettingsParam; matchmakingQueueSettings?: Array; } /** * 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; tsExpire?: number; 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; country?: boolean; requestComplete?: boolean; operationSystem?: boolean; databaseSystem?: boolean; logDatabaseSystem?: boolean; 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; version: string; gameId: string; 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; gamePlayerCount?: boolean; characterPlayerCount?: boolean; inventoryCount?: boolean; storeInventoryCount?: boolean; groupCount?: boolean; 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; } /** * Defines the response payload for GetGameInformation. */ class GetGameInformationResponseData { gameId: string; tsCreate: number; gameName: string; creatorId: string; gameDescription: string; gameIconUrl: string; gameSettings: GameSettingsParam; matchmakingQueueSettings: Array; } /** * Defines the response payload for GameWithGameId. */ class GameWithGameIdResponseData { gameId: string; } /** * Defines the response payload for GetGameList. */ class GetGameListResponseData { results: Array; } /** * 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; 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 { /** Secret keys whose role is admin. */ secretKeys: Array; } /** * Defines the response payload for AdminAccountWithUserId. */ class AdminAccountWithUserIdResponseData { userId: string; } /** * Defines the response payload for CreateAdminAccount. */ class CreateAdminAccountResponseData { results: Array; } /** * 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; } /** * Defines the response payload for CountryRegion. */ class CountryRegionResponseData { regionCode: string; regionName: string; ccu: number; latitude: number; longitude: number; } /** * Defines the response payload for Country. */ class CountryResponseData { countryCode: string; regions: Array; } /** * Defines the response payload for AnalyticsItem. */ class AnalyticsItemResponseData { ccu: number; dau: number; dauSince0h: number; dnu: number; dnuSince0h: number; drt: number; drtSince0h: number; mau: number; mauSince0h1: number; mnu: number; mnuSince0h1: number; mrt: number; 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; totalSizeInBytes: number; collections: number; objects: number; indexes: number; } /** * Defines the response payload for OperationSystem. */ class OperationSystemResponseData { cpuUsage: number; memoryUsage: MemoryUsageResponseData; storageUsage: Array; } /** * Defines the response payload for RequestCompleteErrorCode. */ class RequestCompleteErrorCodeResponseData { errorCode: number; count: number; } /** * Defines the response payload for RequestComplete. */ class RequestCompleteResponseData { eventName: string; results: Array; } /** * Defines the response payload for Cost. */ class CostResponseData { requestCount: number; matchmakingRequestCount: number; cloudScriptGBs: number; storageSizeInBytes: number; dataTransferSizeInBytes: number; } /** * Defines the response payload for GetAnalytics. */ class GetAnalyticsResponseData { analyticsItem?: AnalyticsItemResponseData; country?: Array; operationSystem?: OperationSystemResponseData; requestComplete?: Array; databaseSystem?: DatabaseSystemResponseData; logDatabaseSystem?: DatabaseSystemResponseData; 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; } /** * Defines the response payload for `getEventCallbackCloudScript`. * * Each result links one event callback registration to a CloudScript target. */ class GetEventCallbackCloudScriptResponseData { results: Array; } /** * 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; } /** * 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; characterPlayerCount?: number; inventoryCount?: number; storeInventoryCount?: number; groupCount?: number; /** Optional country-level breakdown returned by the backend. */ country?: Array; /** Optional server or game-data version string reported by the backend. */ version?: string; } /** * Defines an intentionally empty response payload. */ class EmptyResponseData { } }