@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -2,161 +2,333 @@ import { RequestRole } from "./../../constant/enumType/RequestRole";
 import { RequestType } from "./../../constant/enumType/RequestType";
 import { CustomOperationRequestAbstract } from "./../request/CustomOperationRequest";
 import { DashboardModels } from "./DashboardModels";
+/**
+ * Typed request wrappers for the Dashboard domain.
+ *
+ * Each class extends {@link CustomOperationRequestAbstract} and
+ * binds a typed `*RequestData` DTO from
+ * {@link DashboardModels} to:
+ * - the matching {@link OperationCode};
+ * - the {@link RequestType.Dashboard} domain;
+ * - {@link RequestRole.Client} (the wire role is always
+ *   `Client`; admin privilege is resolved by the backend from
+ *   the auth token issued by `loginByAdminAccount`).
+ *
+ * Application code rarely instantiates these directly — the
+ * `GNNetwork.dashboard.*` helpers in {@link DashboardApi} build
+ * them under the hood.
+ */
 export declare namespace DashboardRequestModels {
+    /**
+     * Maps the ChangePasswordAdminAccount operation to a typed request wrapper.
+     */
     class ChangePasswordAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.ChangePasswordAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new ChangePasswordAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.ChangePasswordAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the GetAdminAccountList operation to a typed request wrapper.
+     */
     class GetAdminAccountListOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetAdminAccountListRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetAdminAccountListOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetAdminAccountListRequestData, timeout: number);
     }
+    /**
+     * Maps the GetGameInformation operation to a typed request wrapper.
+     */
     class GetGameInformationOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetGameInformationRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetGameInformationOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetGameInformationRequestData, timeout: number);
     }
+    /**
+     * Maps the GetGameList operation to a typed request wrapper.
+     */
     class GetGameListOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetGameListRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetGameListOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetGameListRequestData, timeout: number);
     }
+    /**
+     * Maps the GetMasterGameSettings operation to a typed request wrapper.
+     */
     class GetMasterGameSettingsOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetMasterGameSettingsRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetMasterGameSettingsOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetMasterGameSettingsRequestData, timeout: number);
     }
+    /**
+     * Maps the GetSecretInfoInformation operation to a typed request wrapper.
+     */
     class GetSecretInfoInformationOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetSecretInfoInformationRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetSecretInfoInformationOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetSecretInfoInformationRequestData, timeout: number);
     }
+    /**
+     * Maps the GetSecretInfoList operation to a typed request wrapper.
+     */
     class GetSecretInfoListOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetSecretInfoListRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetSecretInfoListOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetSecretInfoListRequestData, timeout: number);
     }
+    /**
+     * Maps the GetServerLog operation to a typed request wrapper.
+     */
     class GetServerLogOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetServerLogRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetServerLogOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetServerLogRequestData, timeout: number);
     }
+    /**
+     * Maps the CreateAdminAccount operation to a typed request wrapper.
+     */
     class CreateAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.CreateAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new CreateAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.CreateAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the CreateGame operation to a typed request wrapper.
+     */
     class CreateGameOperationRequest extends CustomOperationRequestAbstract<DashboardModels.CreateGameRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new CreateGameOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.CreateGameRequestData, timeout: number);
     }
+    /**
+     * Maps the CreateSecretInfo operation to a typed request wrapper.
+     */
     class CreateSecretInfoOperationRequest extends CustomOperationRequestAbstract<DashboardModels.CreateSecretInfoRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new CreateSecretInfoOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.CreateSecretInfoRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByAdminAccount operation to a typed request wrapper.
+     */
     class LoginByAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.LoginByAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.LoginByAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the RemoveAdminAccount operation to a typed request wrapper.
+     */
     class RemoveAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.RemoveAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new RemoveAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.RemoveAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the SetGameInformation operation to a typed request wrapper.
+     */
     class SetGameInformationOperationRequest extends CustomOperationRequestAbstract<DashboardModels.SetGameInformationRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetGameInformationOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.SetGameInformationRequestData, timeout: number);
     }
+    /**
+     * Maps the SetMasterGameSettings operation to a typed request wrapper.
+     */
     class SetMasterGameSettingsOperationRequest extends CustomOperationRequestAbstract<DashboardModels.SetMasterGameSettingsRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetMasterGameSettingsOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.SetMasterGameSettingsRequestData, timeout: number);
     }
+    /**
+     * Maps the SetPasswordAdminAccount operation to a typed request wrapper.
+     */
     class SetPasswordAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.SetPasswordAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetPasswordAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.SetPasswordAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the SetSecretInfoInformation operation to a typed request wrapper.
+     */
     class SetSecretInfoInformationOperationRequest extends CustomOperationRequestAbstract<DashboardModels.SetSecretInfoInformationRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetSecretInfoInformationOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.SetSecretInfoInformationRequestData, timeout: number);
     }
+    /**
+     * Maps the SetSecretKeyAdminAccount operation to a typed request wrapper.
+     */
     class SetSecretKeyAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.SetSecretKeyAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetSecretKeyAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.SetSecretKeyAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the GetUsernameAdminAccount operation to a typed request wrapper.
+     */
     class GetUsernameAdminAccountOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetUsernameAdminAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetUsernameAdminAccountOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetUsernameAdminAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the GetAnalytics operation to a typed request wrapper.
+     */
     class GetAnalyticsOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetAnalyticsRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetAnalyticsOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetAnalyticsRequestData, timeout: number);
     }
+    /**
+     * Maps the GetEventCallbackCloudScript operation to a typed request wrapper.
+     */
     class GetEventCallbackCloudScriptOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetEventCallbackCloudScriptRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetEventCallbackCloudScriptOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetEventCallbackCloudScriptRequestData, timeout: number);
     }
+    /**
+     * Maps the SetEventCallbackCloudScript operation to a typed request wrapper.
+     */
     class SetEventCallbackCloudScriptOperationRequest extends CustomOperationRequestAbstract<DashboardModels.SetEventCallbackCloudScriptRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new SetEventCallbackCloudScriptOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.SetEventCallbackCloudScriptRequestData, timeout: number);
     }
+    /**
+     * Maps the ResetStatisticsLeaderboard operation to a typed request wrapper.
+     */
     class ResetStatisticsLeaderboardOperationRequest extends CustomOperationRequestAbstract<DashboardModels.ResetStatisticsLeaderboardRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new ResetStatisticsLeaderboardOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.ResetStatisticsLeaderboardRequestData, timeout: number);
     }
+    /**
+     * Maps the GetBackupStatisticsLeaderboardVersion operation to a typed request wrapper.
+     */
     class GetBackupStatisticsLeaderboardVersionOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetBackupStatisticsLeaderboardVersionRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetBackupStatisticsLeaderboardVersionOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetBackupStatisticsLeaderboardVersionRequestData, timeout: number);
     }
+    /**
+     * Maps the GetServerGameData operation to a typed request wrapper.
+     */
     class GetServerGameDataOperationRequest extends CustomOperationRequestAbstract<DashboardModels.GetServerGameDataRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetServerGameDataOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.GetServerGameDataRequestData, timeout: number);
     }
+    /**
+     * Maps the DeleteInDatabase operation to a typed request wrapper.
+     */
     class DeleteInDatabaseOperationRequest extends CustomOperationRequestAbstract<DashboardModels.DeleteInDatabaseRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new DeleteInDatabaseOperationRequest instance.
+         */
         constructor(requestData: DashboardModels.DeleteInDatabaseRequestData, timeout: number);
     }
 }

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

@@ -1,82 +1,252 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { DashboardModels } from "./DashboardModels";
+/**
+ * Typed response wrappers for the Dashboard domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link DashboardModels}.
+ *
+ * Many mutation operations (create / set / remove) resolve to
+ * an `EmptyResponseData` because the only useful signal is
+ * the transport return code + domain `errorCode`. Read /
+ * listing operations resolve to richer dashboard-specific DTOs
+ * such as `GameInformationResponseData`,
+ * `AdminAccountListResponseData`, `AnalyticsResponseData`,
+ * etc.
+ */
 export declare namespace DashboardResponseModels {
+    /**
+     * Maps the ChangePasswordAdminAccount operation to a typed response wrapper.
+     */
     class ChangePasswordAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new ChangePasswordAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAdminAccountList operation to a typed response wrapper.
+     */
     class GetAdminAccountListOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetAdminAccountListResponseData> {
+        /**
+         * Creates a new GetAdminAccountListOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGameInformation operation to a typed response wrapper.
+     */
     class GetGameInformationOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetGameInformationResponseData> {
+        /**
+         * Creates a new GetGameInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetGameList operation to a typed response wrapper.
+     */
     class GetGameListOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetGameListResponseData> {
+        /**
+         * Creates a new GetGameListOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetMasterGameSettings operation to a typed response wrapper.
+     */
     class GetMasterGameSettingsOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetMasterGameSettingsResponseData> {
+        /**
+         * Creates a new GetMasterGameSettingsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetSecretInfoInformation operation to a typed response wrapper.
+     */
     class GetSecretInfoInformationOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetSecretInfoInformationResponseData> {
+        /**
+         * Creates a new GetSecretInfoInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetSecretInfoList operation to a typed response wrapper.
+     */
     class GetSecretInfoListOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetSecretInfoListResponseData> {
+        /**
+         * Creates a new GetSecretInfoListOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetServerLog operation to a typed response wrapper.
+     */
     class GetServerLogOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetServerLogResponseData> {
+        /**
+         * Creates a new GetServerLogOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateAdminAccount operation to a typed response wrapper.
+     */
     class CreateAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.CreateAdminAccountResponseData> {
+        /**
+         * Creates a new CreateAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateGame operation to a typed response wrapper.
+     */
     class CreateGameOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GameWithGameIdResponseData> {
+        /**
+         * Creates a new CreateGameOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the CreateSecretInfo operation to a typed response wrapper.
+     */
     class CreateSecretInfoOperationResponse extends CustomOperationResponseAbstract<DashboardModels.SecretInfoWithSecretKeyResponseData> {
+        /**
+         * Creates a new CreateSecretInfoOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByAdminAccount operation to a typed response wrapper.
+     */
     class LoginByAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.LoginByAdminAccountResponseData> {
+        /**
+         * Creates a new LoginByAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RemoveAdminAccount operation to a typed response wrapper.
+     */
     class RemoveAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new RemoveAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetGameInformation operation to a typed response wrapper.
+     */
     class SetGameInformationOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new SetGameInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetMasterGameSettings operation to a typed response wrapper.
+     */
     class SetMasterGameSettingsOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new SetMasterGameSettingsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetPasswordAdminAccount operation to a typed response wrapper.
+     */
     class SetPasswordAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new SetPasswordAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetSecretInfoInformation operation to a typed response wrapper.
+     */
     class SetSecretInfoInformationOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new SetSecretInfoInformationOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetSecretKeyAdminAccount operation to a typed response wrapper.
+     */
     class SetSecretKeyAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new SetSecretKeyAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetUsernameAdminAccount operation to a typed response wrapper.
+     */
     class GetUsernameAdminAccountOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetUsernameAdminAccountResponseData> {
+        /**
+         * Creates a new GetUsernameAdminAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetAnalytics operation to a typed response wrapper.
+     */
     class GetAnalyticsOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetAnalyticsResponseData> {
+        /**
+         * Creates a new GetAnalyticsOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetEventCallbackCloudScript operation to a typed response wrapper.
+     */
     class GetEventCallbackCloudScriptOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetEventCallbackCloudScriptResponseData> {
+        /**
+         * Creates a new GetEventCallbackCloudScriptOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the SetEventCallbackCloudScript operation to a typed response wrapper.
+     */
     class SetEventCallbackCloudScriptOperationResponse extends CustomOperationResponseAbstract<DashboardModels.SetEventCallbackCloudScriptResponseData> {
+        /**
+         * Creates a new SetEventCallbackCloudScriptOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ResetStatisticsLeaderboard operation to a typed response wrapper.
+     */
     class ResetStatisticsLeaderboardOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new ResetStatisticsLeaderboardOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetBackupStatisticsLeaderboardVersion operation to a typed response wrapper.
+     */
     class GetBackupStatisticsLeaderboardVersionOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetBackupStatisticsLeaderboardVersionResponseData> {
+        /**
+         * Creates a new GetBackupStatisticsLeaderboardVersionOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetServerGameData operation to a typed response wrapper.
+     */
     class GetServerGameDataOperationResponse extends CustomOperationResponseAbstract<DashboardModels.GetServerGameDataResponseData> {
+        /**
+         * Creates a new GetServerGameDataOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the DeleteInDatabase operation to a typed response wrapper.
+     */
     class DeleteInDatabaseOperationResponse extends CustomOperationResponseAbstract<DashboardModels.EmptyResponseData> {
+        /**
+         * Creates a new DeleteInDatabaseOperationResponse instance.
+         */
         constructor();
     }
 }