@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/dist/runtime/GNNetworkDashboardApi.d.ts

@@ -2,63 +2,284 @@ import { Action1 } from "./common/Action1";
 import { GNHashtable } from "./common/GNData";
 import { DashboardModels } from "./entity/models/DashboardModels";
 import { DashboardResponseModels } from "./entity/models/DashboardResponseModels";
+/**
+ * Public dashboard / admin-facing namespace.
+ *
+ * Reachable through {@link GNNetwork.dashboard} after
+ * {@link GNNetwork.init}. Provides the operations that backend
+ * tooling (admin dashboards, ops scripts, internal CLIs) calls
+ * to manage games, accounts, secrets, analytics, server logs
+ * and CloudScript event-callback wiring.
+ *
+ * **Permission model**: methods on this class still route
+ * through {@link RequestRole.Client} on the wire; the backend
+ * resolves dashboard permission from the **auth token itself**
+ * — typically a token issued by `loginByAdminAccount`. Calling
+ * these methods with a regular player auth token will fail with
+ * `ReturnCode.OperationNotAuthorized`.
+ *
+ * Functional groupings:
+ *
+ * 1. **Admin auth & accounts** —
+ *    `loginByAdminAccount`, `changePasswordAdminAccount`,
+ *    `setPasswordAdminAccount`,
+ *    `setSecretKeyAdminAccount`, `createAdminAccount`,
+ *    `removeAdminAccount`, `getAdminAccountList`,
+ *    `getUsernameAdminAccount`.
+ * 2. **Game & game settings** — `getGameList`,
+ *    `createGame`, `getGameInformation`,
+ *    `setGameInformation`, `getMasterGameSettings`,
+ *    `setMasterGameSettings`.
+ * 3. **Secrets** — `getSecretInfoList`,
+ *    `getSecretInfoInformation`, `createSecretInfo`,
+ *    `setSecretInfoInformation`.
+ * 4. **Server diagnostics & analytics** — `getServerLog`,
+ *    `getServerGameData`, `getAnalytics`.
+ * 5. **CloudScript glue** —
+ *    `getEventCallbackCloudScript`,
+ *    `setEventCallbackCloudScript` (binds named events to
+ *    CloudScript functions).
+ * 6. **Leaderboards & data ops** —
+ *    `resetStatisticsLeaderboard`,
+ *    `getBackupStatisticsLeaderboardVersion`,
+ *    `deleteInDatabase`. Use the latter with extreme care; it
+ *    is a destructive maintenance operation.
+ *
+ * Common contract: HTTP / {@link RequestType.Dashboard} /
+ * {@link RequestRole.Client}, plus admin auth-token
+ * authorisation. Companion {@link ServerDashboardApi} and
+ * {@link AdminDashboardApi} are placeholders today.
+ */
 export declare class DashboardApi {
+    /** Exposed for namespace symmetry only. Dashboard currently has no public server-scoped methods. */
     server: ServerDashboardApi;
+    /** Exposed for namespace symmetry only. Dashboard currently has no public admin-scoped methods. */
     admin: AdminDashboardApi;
+    /**
+     * Sends the changePasswordAdminAccount operation and returns the typed response via callback.
+     */
     changePasswordAdminAccount(requestData: DashboardModels.ChangePasswordAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.ChangePasswordAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the changePasswordAdminAccount operation and resolves with the typed response.
+     */
     changePasswordAdminAccountAsync(requestData: DashboardModels.ChangePasswordAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.ChangePasswordAdminAccountOperationResponse>;
+    /**
+     * Sends the getAdminAccountList operation and returns the typed response via callback.
+     */
     getAdminAccountList(requestData: DashboardModels.GetAdminAccountListRequestData, onResponse?: Action1<DashboardResponseModels.GetAdminAccountListOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getAdminAccountList operation and resolves with the typed response.
+     */
     getAdminAccountListAsync(requestData: DashboardModels.GetAdminAccountListRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetAdminAccountListOperationResponse>;
+    /**
+     * Sends the getGameInformation operation and returns the typed response via callback.
+     */
     getGameInformation(requestData: DashboardModels.GetGameInformationRequestData, onResponse?: Action1<DashboardResponseModels.GetGameInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getGameInformation operation and resolves with the typed response.
+     */
     getGameInformationAsync(requestData: DashboardModels.GetGameInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetGameInformationOperationResponse>;
+    /**
+     * Sends the getGameList operation and returns the typed response via callback.
+     */
     getGameList(requestData: DashboardModels.GetGameListRequestData, onResponse?: Action1<DashboardResponseModels.GetGameListOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getGameList operation and resolves with the typed response.
+     */
     getGameListAsync(requestData: DashboardModels.GetGameListRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetGameListOperationResponse>;
+    /**
+     * Sends the getMasterGameSettings operation and returns the typed response via callback.
+     */
     getMasterGameSettings(requestData: DashboardModels.GetMasterGameSettingsRequestData, onResponse?: Action1<DashboardResponseModels.GetMasterGameSettingsOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getMasterGameSettings operation and resolves with the typed response.
+     */
     getMasterGameSettingsAsync(requestData: DashboardModels.GetMasterGameSettingsRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetMasterGameSettingsOperationResponse>;
+    /**
+     * Sends the getSecretInfoInformation operation and returns the typed response via callback.
+     */
     getSecretInfoInformation(requestData: DashboardModels.GetSecretInfoInformationRequestData, onResponse?: Action1<DashboardResponseModels.GetSecretInfoInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getSecretInfoInformation operation and resolves with the typed response.
+     */
     getSecretInfoInformationAsync(requestData: DashboardModels.GetSecretInfoInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetSecretInfoInformationOperationResponse>;
+    /**
+     * Sends the getSecretInfoList operation and returns the typed response via callback.
+     */
     getSecretInfoList(requestData: DashboardModels.GetSecretInfoListRequestData, onResponse?: Action1<DashboardResponseModels.GetSecretInfoListOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getSecretInfoList operation and resolves with the typed response.
+     */
     getSecretInfoListAsync(requestData: DashboardModels.GetSecretInfoListRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetSecretInfoListOperationResponse>;
+    /**
+     * Sends the getServerLog operation and returns the typed response via callback.
+     */
     getServerLog(requestData: DashboardModels.GetServerLogRequestData, onResponse?: Action1<DashboardResponseModels.GetServerLogOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getServerLog operation and resolves with the typed response.
+     */
     getServerLogAsync(requestData: DashboardModels.GetServerLogRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetServerLogOperationResponse>;
+    /**
+     * Sends the createAdminAccount operation and returns the typed response via callback.
+     */
     createAdminAccount(requestData: DashboardModels.CreateAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.CreateAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the createAdminAccount operation and resolves with the typed response.
+     */
     createAdminAccountAsync(requestData: DashboardModels.CreateAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.CreateAdminAccountOperationResponse>;
+    /**
+     * Sends the createGame operation and returns the typed response via callback.
+     */
     createGame(requestData: DashboardModels.CreateGameRequestData, onResponse?: Action1<DashboardResponseModels.CreateGameOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the createGame operation and resolves with the typed response.
+     */
     createGameAsync(requestData: DashboardModels.CreateGameRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.CreateGameOperationResponse>;
+    /**
+     * Sends the createSecretInfo operation and returns the typed response via callback.
+     */
     createSecretInfo(requestData: DashboardModels.CreateSecretInfoRequestData, onResponse?: Action1<DashboardResponseModels.CreateSecretInfoOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the createSecretInfo operation and resolves with the typed response.
+     */
     createSecretInfoAsync(requestData: DashboardModels.CreateSecretInfoRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.CreateSecretInfoOperationResponse>;
+    /**
+     * Sends the loginByAdminAccount operation and returns the typed response via callback.
+     */
     loginByAdminAccount(requestData: DashboardModels.LoginByAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.LoginByAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the loginByAdminAccount operation and resolves with the typed response.
+     */
     loginByAdminAccountAsync(requestData: DashboardModels.LoginByAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.LoginByAdminAccountOperationResponse>;
+    /**
+     * Sends the removeAdminAccount operation and returns the typed response via callback.
+     */
     removeAdminAccount(requestData: DashboardModels.RemoveAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.RemoveAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the removeAdminAccount operation and resolves with the typed response.
+     */
     removeAdminAccountAsync(requestData: DashboardModels.RemoveAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.RemoveAdminAccountOperationResponse>;
+    /**
+     * Sends the setGameInformation operation and returns the typed response via callback.
+     */
     setGameInformation(requestData: DashboardModels.SetGameInformationRequestData, onResponse?: Action1<DashboardResponseModels.SetGameInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setGameInformation operation and resolves with the typed response.
+     */
     setGameInformationAsync(requestData: DashboardModels.SetGameInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.SetGameInformationOperationResponse>;
+    /**
+     * Sends the setMasterGameSettings operation and returns the typed response via callback.
+     */
     setMasterGameSettings(requestData: DashboardModels.SetMasterGameSettingsRequestData, onResponse?: Action1<DashboardResponseModels.SetMasterGameSettingsOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setMasterGameSettings operation and resolves with the typed response.
+     */
     setMasterGameSettingsAsync(requestData: DashboardModels.SetMasterGameSettingsRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.SetMasterGameSettingsOperationResponse>;
+    /**
+     * Sends the setPasswordAdminAccount operation and returns the typed response via callback.
+     */
     setPasswordAdminAccount(requestData: DashboardModels.SetPasswordAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.SetPasswordAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setPasswordAdminAccount operation and resolves with the typed response.
+     */
     setPasswordAdminAccountAsync(requestData: DashboardModels.SetPasswordAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.SetPasswordAdminAccountOperationResponse>;
+    /**
+     * Sends the setSecretInfoInformation operation and returns the typed response via callback.
+     */
     setSecretInfoInformation(requestData: DashboardModels.SetSecretInfoInformationRequestData, onResponse?: Action1<DashboardResponseModels.SetSecretInfoInformationOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setSecretInfoInformation operation and resolves with the typed response.
+     */
     setSecretInfoInformationAsync(requestData: DashboardModels.SetSecretInfoInformationRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.SetSecretInfoInformationOperationResponse>;
+    /**
+     * Sends the setSecretKeyAdminAccount operation and returns the typed response via callback.
+     */
     setSecretKeyAdminAccount(requestData: DashboardModels.SetSecretKeyAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.SetSecretKeyAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setSecretKeyAdminAccount operation and resolves with the typed response.
+     */
     setSecretKeyAdminAccountAsync(requestData: DashboardModels.SetSecretKeyAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.SetSecretKeyAdminAccountOperationResponse>;
+    /**
+     * Sends the getUsernameAdminAccount operation and returns the typed response via callback.
+     */
     getUsernameAdminAccount(requestData: DashboardModels.GetUsernameAdminAccountRequestData, onResponse?: Action1<DashboardResponseModels.GetUsernameAdminAccountOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getUsernameAdminAccount operation and resolves with the typed response.
+     */
     getUsernameAdminAccountAsync(requestData: DashboardModels.GetUsernameAdminAccountRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetUsernameAdminAccountOperationResponse>;
+    /**
+     * Sends the getAnalytics operation and returns the typed response via callback.
+     */
     getAnalytics(requestData: DashboardModels.GetAnalyticsRequestData, onResponse?: Action1<DashboardResponseModels.GetAnalyticsOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getAnalytics operation and resolves with the typed response.
+     */
     getAnalyticsAsync(requestData: DashboardModels.GetAnalyticsRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetAnalyticsOperationResponse>;
+    /**
+     * Sends the getEventCallbackCloudScript operation and returns the typed response via callback.
+     */
     getEventCallbackCloudScript(requestData: DashboardModels.GetEventCallbackCloudScriptRequestData, onResponse?: Action1<DashboardResponseModels.GetEventCallbackCloudScriptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getEventCallbackCloudScript operation and resolves with the typed response.
+     */
     getEventCallbackCloudScriptAsync(requestData: DashboardModels.GetEventCallbackCloudScriptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetEventCallbackCloudScriptOperationResponse>;
+    /**
+     * Sends the setEventCallbackCloudScript operation and returns the typed response via callback.
+     */
     setEventCallbackCloudScript(requestData: DashboardModels.SetEventCallbackCloudScriptRequestData, onResponse?: Action1<DashboardResponseModels.SetEventCallbackCloudScriptOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the setEventCallbackCloudScript operation and resolves with the typed response.
+     */
     setEventCallbackCloudScriptAsync(requestData: DashboardModels.SetEventCallbackCloudScriptRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.SetEventCallbackCloudScriptOperationResponse>;
+    /**
+     * Sends the resetStatisticsLeaderboard operation and returns the typed response via callback.
+     */
     resetStatisticsLeaderboard(requestData: DashboardModels.ResetStatisticsLeaderboardRequestData, onResponse?: Action1<DashboardResponseModels.ResetStatisticsLeaderboardOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the resetStatisticsLeaderboard operation and resolves with the typed response.
+     */
     resetStatisticsLeaderboardAsync(requestData: DashboardModels.ResetStatisticsLeaderboardRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.ResetStatisticsLeaderboardOperationResponse>;
+    /**
+     * Sends the getBackupStatisticsLeaderboardVersion operation and returns the typed response via callback.
+     */
     getBackupStatisticsLeaderboardVersion(requestData: DashboardModels.GetBackupStatisticsLeaderboardVersionRequestData, onResponse?: Action1<DashboardResponseModels.GetBackupStatisticsLeaderboardVersionOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getBackupStatisticsLeaderboardVersion operation and resolves with the typed response.
+     */
     getBackupStatisticsLeaderboardVersionAsync(requestData: DashboardModels.GetBackupStatisticsLeaderboardVersionRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetBackupStatisticsLeaderboardVersionOperationResponse>;
+    /**
+     * Sends the getServerGameData operation and returns the typed response via callback.
+     */
     getServerGameData(requestData: DashboardModels.GetServerGameDataRequestData, onResponse?: Action1<DashboardResponseModels.GetServerGameDataOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the getServerGameData operation and resolves with the typed response.
+     */
     getServerGameDataAsync(requestData: DashboardModels.GetServerGameDataRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.GetServerGameDataOperationResponse>;
+    /**
+     * Sends the deleteInDatabase operation and returns the typed response via callback.
+     */
     deleteInDatabase(requestData: DashboardModels.DeleteInDatabaseRequestData, onResponse?: Action1<DashboardResponseModels.DeleteInDatabaseOperationResponse>, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): void;
+    /**
+     * Sends the deleteInDatabase operation and resolves with the typed response.
+     */
     deleteInDatabaseAsync(requestData: DashboardModels.DeleteInDatabaseRequestData, overrideAuthToken?: string, overrideSecretKey?: string, customTags?: GNHashtable, timeout?: number): Promise<DashboardResponseModels.DeleteInDatabaseOperationResponse>;
 }
+/**
+ * Server-scoped Dashboard sub-namespace — placeholder.
+ *
+ * Reserved for future server-only dashboard operations.
+ * Allocated by {@link DashboardApi} so the `.server` property
+ * name is always defined, even though no methods are exposed
+ * yet.
+ */
 export declare class ServerDashboardApi {
 }
+/**
+ * Admin-scoped Dashboard sub-namespace — placeholder.
+ *
+ * Reserved for future admin-only dashboard operations.
+ * Allocated for the same symmetry reason as
+ * {@link ServerDashboardApi}.
+ */
 export declare class AdminDashboardApi {
 }