@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

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

@@ -2,113 +2,244 @@ import { RequestRole } from "./../../constant/enumType/RequestRole";
 import { RequestType } from "./../../constant/enumType/RequestType";
 import { CustomOperationRequestAbstract } from "./../request/CustomOperationRequest";
 import { AuthenticateModels } from "./AuthenticateModels";
+/**
+ * Typed request wrappers for the Authenticate domain.
+ *
+ * Each class in this namespace extends
+ * {@link CustomOperationRequestAbstract} and binds a typed
+ * `*RequestData` DTO from {@link AuthenticateModels} to the
+ * matching {@link OperationCode}, plus the
+ * {@link RequestType.Authenticate} domain and
+ * {@link RequestRole.Client} permission scope.
+ *
+ * Application code rarely instantiates these directly — the
+ * `GNNetwork.authenticate.*` helpers in
+ * {@link AuthenticateApi} build them under the hood. Reach for
+ * the raw wrapper only when issuing a request through the
+ * low-level helpers such as
+ * {@link GNNetwork.sendViaHttpTRequestTResponse}.
+ *
+ * Wire-format conversion happens in
+ * {@link CustomOperationRequestAbstract.build} which serialises
+ * the DTO via {@link ConverterService.serializeObject}.
+ */
 export declare namespace AuthenticateRequestModels {
+    /**
+     * Maps the LoginByAccount operation to a typed request wrapper.
+     */
     class LoginByAccountOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByAccountOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByAndroidDeviceId operation to a typed request wrapper.
+     */
     class LoginByAndroidDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByAndroidDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByAndroidDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByAndroidDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByApple operation to a typed request wrapper.
+     */
     class LoginByAppleOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByAppleRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByAppleOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByAppleRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByCustomDeviceId operation to a typed request wrapper.
+     */
     class LoginByCustomDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByCustomDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByCustomDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByCustomDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByCustomId operation to a typed request wrapper.
+     */
     class LoginByCustomIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByCustomIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByCustomIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByCustomIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByEditorDeviceId operation to a typed request wrapper.
+     */
     class LoginByEditorDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByEditorDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByEditorDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByEditorDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByFacebook operation to a typed request wrapper.
+     */
     class LoginByFacebookOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByFacebookRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByFacebookOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByFacebookRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByGenericService operation to a typed request wrapper.
+     */
     class LoginByGenericServiceOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByGenericServiceRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByGenericServiceOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByGenericServiceRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByGoogle operation to a typed request wrapper.
+     */
     class LoginByGoogleOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByGoogleRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByGoogleOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByGoogleRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByGooglePlayGameService operation to a typed request wrapper.
+     */
     class LoginByGooglePlayGameServiceOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByGooglePlayGameServiceRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByGooglePlayGameServiceOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByGooglePlayGameServiceRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByGameCenter operation to a typed request wrapper.
+     */
     class LoginByGameCenterOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByGameCenterRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByGameCenterOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByGameCenterRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByiOSDeviceId operation to a typed request wrapper.
+     */
     class LoginByiOSDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByiOSDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByiOSDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByiOSDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByLinuxDeviceId operation to a typed request wrapper.
+     */
     class LoginByLinuxDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByLinuxDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByLinuxDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByLinuxDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByMacOSDeviceId operation to a typed request wrapper.
+     */
     class LoginByMacOSDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByMacOSDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByMacOSDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByMacOSDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByWindowsDeviceId operation to a typed request wrapper.
+     */
     class LoginByWindowsDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByWindowsDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByWindowsDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByWindowsDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the LoginByWindowsPhoneDeviceId operation to a typed request wrapper.
+     */
     class LoginByWindowsPhoneDeviceIdOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.LoginByWindowsPhoneDeviceIdRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new LoginByWindowsPhoneDeviceIdOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.LoginByWindowsPhoneDeviceIdRequestData, timeout: number);
     }
+    /**
+     * Maps the RegisterAccount operation to a typed request wrapper.
+     */
     class RegisterAccountOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.RegisterAccountRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new RegisterAccountOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.RegisterAccountRequestData, timeout: number);
     }
+    /**
+     * Maps the `RefreshAuthToken` operation to a typed request wrapper.
+     *
+     * The wrapped request body is intentionally empty; auth context still comes from the current token.
+     */
     class RefreshAuthTokenOperationRequest extends CustomOperationRequestAbstract<AuthenticateModels.RefreshAuthTokenRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new RefreshAuthTokenOperationRequest instance.
+         */
         constructor(requestData: AuthenticateModels.RefreshAuthTokenRequestData, timeout: number);
     }
 }

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

@@ -1,58 +1,189 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { AuthenticateModels } from "./AuthenticateModels";
+/**
+ * Typed response wrappers for the Authenticate domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract} and
+ * binds the corresponding response DTO from
+ * {@link AuthenticateModels}. Most login flows resolve to the
+ * shared {@link AuthenticateModels.AuthenticateResponseData},
+ * which carries the auth token plus the optional profile fields
+ * requested via `infoRequestParam`.
+ *
+ * Exceptions:
+ * - `loginByGenericService` resolves to
+ *   {@link AuthenticateModels.GenericServiceAuthenticateResponseData}
+ *   so the provider-specific `errorMessage` field is preserved.
+ * - `refreshAuthToken` resolves to
+ *   {@link AuthenticateModels.RefreshAuthTokenResponseData},
+ *   which only carries the new token plus optional ban state.
+ *
+ * Application code reads the typed payload through
+ * `response.responseData` after confirming
+ * `response.hasReturnCodeError() === false` and
+ * `response.errorCode === ErrorCode.Ok`.
+ */
 export declare namespace AuthenticateResponseModels {
+    /**
+     * Maps the LoginByAccount operation to a typed response wrapper.
+     */
     class LoginByAccountOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByAndroidDeviceId operation to a typed response wrapper.
+     */
     class LoginByAndroidDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByAndroidDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByApple operation to a typed response wrapper.
+     */
     class LoginByAppleOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByAppleOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByCustomDeviceId operation to a typed response wrapper.
+     */
     class LoginByCustomDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByCustomDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByCustomId operation to a typed response wrapper.
+     */
     class LoginByCustomIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByCustomIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByEditorDeviceId operation to a typed response wrapper.
+     */
     class LoginByEditorDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByEditorDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByFacebook operation to a typed response wrapper.
+     */
     class LoginByFacebookOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByFacebookOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByGenericService operation to a typed response wrapper.
+     */
     class LoginByGenericServiceOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.GenericServiceAuthenticateResponseData> {
+        /**
+         * Creates a new LoginByGenericServiceOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByGoogle operation to a typed response wrapper.
+     */
     class LoginByGoogleOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByGoogleOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByGooglePlayGameService operation to a typed response wrapper.
+     */
     class LoginByGooglePlayGameServiceOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByGooglePlayGameServiceOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByGameCenter operation to a typed response wrapper.
+     */
     class LoginByGameCenterOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByGameCenterOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByiOSDeviceId operation to a typed response wrapper.
+     */
     class LoginByiOSDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByiOSDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByLinuxDeviceId operation to a typed response wrapper.
+     */
     class LoginByLinuxDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByLinuxDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByMacOSDeviceId operation to a typed response wrapper.
+     */
     class LoginByMacOSDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByMacOSDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByWindowsDeviceId operation to a typed response wrapper.
+     */
     class LoginByWindowsDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByWindowsDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the LoginByWindowsPhoneDeviceId operation to a typed response wrapper.
+     */
     class LoginByWindowsPhoneDeviceIdOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new LoginByWindowsPhoneDeviceIdOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RegisterAccount operation to a typed response wrapper.
+     */
     class RegisterAccountOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.AuthenticateResponseData> {
+        /**
+         * Creates a new RegisterAccountOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the RefreshAuthToken operation to a typed response wrapper.
+     */
     class RefreshAuthTokenOperationResponse extends CustomOperationResponseAbstract<AuthenticateModels.RefreshAuthTokenResponseData> {
+        /**
+         * Creates a new RefreshAuthTokenOperationResponse instance.
+         */
         constructor();
     }
 }