cidaas-javascript-sdk 4.3.3 → 5.0.0

package/dist/login-service/LoginService.js

@@ -1,247 +1,238 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.actionGuestLogin = exports.loginAfterRegister = exports.progressiveRegistration = exports.firstTimeChangePassword = exports.mfaContinue = exports.consentContinue = exports.passwordlessLogin = exports.registerWithSocial = exports.loginWithSocial = exports.loginWithCredentials = void 0;
+exports.LoginService = void 0;
 const Helper_1 = require("../common/Helper");
-/**
- * To login with your credentials, call **loginWithCredentials()**. After successful login, this will redirect you to the redirect_url that you mentioned earlier while initialising the sdk.
- * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/5gphdk6vapp56-classic-login#call-login-api for more details.
- * @example
- * ```js
- * cidaas.loginWithCredentials({
- *   username: 'xxxx@gmail.com',
- *   username_type: 'email',
- *   password: '123456',
- *   requestId: 'your requestId',
- * });
- * ```
- */
-function loginWithCredentials(options) {
-    try {
-        const url = window.webAuthSettings.authority + "/login-srv/login";
-        const form = Helper_1.Helper.createForm(url, options);
-        document.body.appendChild(form);
-        form.submit();
-    }
-    catch (ex) {
-        throw new Helper_1.CustomException(String(ex), 417);
-    }
-}
-exports.loginWithCredentials = loginWithCredentials;
-/**
- * To login with social providers, call **loginWithSocial()**. This will redirect you to the facebook login page.
- * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9mi5uqxhqlsm5-social-login#call-social-login-api for more details
- * @example
- * ```js
- * cidaas.loginWithSocial({
- *   provider: 'facebook',
- *   requestId: 'your requestId',
- * });
- * ```
- */
-function loginWithSocial(options, queryParams) {
-    try {
-        let _serviceURL = window.webAuthSettings.authority + "/login-srv/social/login/" + options.provider.toLowerCase() + "/" + options.requestId;
-        if (queryParams && queryParams.dc && queryParams.device_fp) {
-            _serviceURL = _serviceURL + "?dc=" + queryParams.dc + "&device_fp=" + queryParams.device_fp;
-        }
-        window.location.href = _serviceURL;
-    }
-    catch (ex) {
-        console.log(ex);
-    }
-}
-exports.loginWithSocial = loginWithSocial;
-/**
- * To register with social providers, call **registerWithSocial()**. This will redirect you to the facebook login page.
- * @example
- * Note: giving the queryParams is not required.
- * ```js
- * queryParams = {
- *   dc: 'dc',
- *   device_fp: 'device_fp'
- * }
- * cidaas.registerWithSocial({
- *   provider: 'facebook',
- *   requestId: 'your requestId',
- * }, queryParams);
- * ```
- */
-function registerWithSocial(options, queryParams) {
-    try {
-        let _serviceURL = window.webAuthSettings.authority + "/login-srv/social/register/" + options.provider.toLowerCase() + "/" + options.requestId;
-        if (queryParams && queryParams.dc && queryParams.device_fp) {
-            _serviceURL = _serviceURL + "?dc=" + queryParams.dc + "&device_fp=" + queryParams.device_fp;
-        }
-        window.location.href = _serviceURL;
-    }
-    catch (ex) {
-        console.log(ex);
-    }
-}
-exports.registerWithSocial = registerWithSocial;
-/**
-* To authenticate without using password, call **passwordlessLogin()**.
-* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/k1lwsraxk0rjc-login-passwordless-request for more details.
-* @example
-* ```js
-* cidaas.passwordlessLogin({
-*   requestId: 'your requestId',
-*   sub: 'your user sub',
-*   statusId: 'status id from authenticateMFA()'
-*   verificationType: 'your verificationType. e.g. VerificationType.EMAIL'
-* });
-* ```
-*/
-function passwordlessLogin(options) {
-    try {
-        const url = window.webAuthSettings.authority + "/login-srv/verification/login";
-        const form = Helper_1.Helper.createForm(url, options);
-        document.body.appendChild(form);
-        form.submit();
-    }
-    catch (ex) {
-        throw new Helper_1.CustomException(String(ex), 417);
+class LoginService {
+    constructor(configUserProvider) {
+        this.config = configUserProvider.getConfig();
+    }
+    /**
+     * To login with your credentials, call **loginWithCredentials()**. After successful login, this will redirect you to the redirect_url that you mentioned earlier while initialising the sdk.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/5gphdk6vapp56-classic-login#call-login-api for more details.
+     * @example
+     * ```js
+     * cidaasLoginService.loginWithCredentials({
+     *   username: 'xxxx@gmail.com',
+     *   username_type: 'email',
+     *   password: '123456',
+     *   requestId: 'your requestId',
+     * });
+     * ```
+     */
+    loginWithCredentials(options) {
+        try {
+            const url = this.config.authority + "/login-srv/login";
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        catch (ex) {
+            throw new Helper_1.CustomException(String(ex), 417);
+        }
     }
-}
-exports.passwordlessLogin = passwordlessLogin;
-/**
-* To continue after Consent acceptance, call **consentContinue()**.
-* @example
-* ```js
-* cidaas.consentContinue({
-*   track_id: 'your track id'
-* });
-* ```
-*/
-function consentContinue(options) {
-    try {
-        const url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.track_id;
-        const form = Helper_1.Helper.createForm(url, options);
-        document.body.appendChild(form);
-        form.submit();
+    /**
+     * To login with social providers, call **loginWithSocial()**. This will redirect you to the facebook login page.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9mi5uqxhqlsm5-social-login#call-social-login-api for more details
+     * @example
+     * ```js
+     * cidaasLoginService.loginWithSocial({
+     *   provider: 'facebook',
+     *   requestId: 'your requestId',
+     * });
+     * ```
+     */
+    loginWithSocial(options, queryParams) {
+        try {
+            let _serviceURL = this.config.authority + "/login-srv/social/login/" + options.provider.toLowerCase() + "/" + options.requestId;
+            if (queryParams && queryParams.dc && queryParams.device_fp) {
+                _serviceURL = _serviceURL + "?dc=" + queryParams.dc + "&device_fp=" + queryParams.device_fp;
+            }
+            window.location.href = _serviceURL;
+        }
+        catch (ex) {
+            console.log(ex);
+        }
     }
-    catch (ex) {
-        throw new Helper_1.CustomException(String(ex), 417);
+    /**
+     * To register with social providers, call **registerWithSocial()**. This will redirect you to the facebook login page.
+     * @example
+     * Note: giving the queryParams is not required.
+     * ```js
+     * queryParams = {
+     *   dc: 'dc',
+     *   device_fp: 'device_fp'
+     * }
+     * cidaasLoginService.registerWithSocial({
+     *   provider: 'facebook',
+     *   requestId: 'your requestId',
+     * }, queryParams);
+     * ```
+     */
+    registerWithSocial(options, queryParams) {
+        try {
+            let _serviceURL = this.config.authority + "/login-srv/social/register/" + options.provider.toLowerCase() + "/" + options.requestId;
+            if (queryParams && queryParams.dc && queryParams.device_fp) {
+                _serviceURL = _serviceURL + "?dc=" + queryParams.dc + "&device_fp=" + queryParams.device_fp;
+            }
+            window.location.href = _serviceURL;
+        }
+        catch (ex) {
+            console.log(ex);
+        }
     }
-}
-exports.consentContinue = consentContinue;
-/**
- * To continue after MFA completion, call **mfaContinue()**.
- * options: PhysicalVerificationLoginRequest is not needed anymore. It is now DEPRECATED and will be removed in the next major release
- *
- * @example
- * ```js
- * cidaas.mfaContinue({
- *   track_id: 'your track id'
- * });
- * ```
- */
-function mfaContinue(options) {
-    try {
-        const url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.track_id;
-        const form = Helper_1.Helper.createForm(url, options);
-        document.body.appendChild(form);
-        form.submit();
+    /**
+    * To authenticate without using password, call **passwordlessLogin()**.
+    * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/k1lwsraxk0rjc-login-passwordless-request for more details.
+    * @example
+    * ```js
+    * cidaasLoginService.passwordlessLogin({
+    *   requestId: 'your requestId',
+    *   sub: 'your user sub',
+    *   statusId: 'status id from authenticateMFA()'
+    *   verificationType: 'your verificationType. e.g. VerificationType.Email'
+    * });
+    * ```
+    */
+    passwordlessLogin(options) {
+        try {
+            const url = this.config.authority + "/login-srv/verification/login";
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        catch (ex) {
+            throw new Helper_1.CustomException(String(ex), 417);
+        }
     }
-    catch (ex) {
-        throw new Helper_1.CustomException(String(ex), 417);
+    /**
+    * To continue after Consent acceptance, call **consentContinue()**.
+    * @example
+    * ```js
+    * cidaasLoginService.consentContinue({
+    *   track_id: 'your track id'
+    * });
+    * ```
+    */
+    consentContinue(options) {
+        try {
+            const url = this.config.authority + "/login-srv/precheck/continue/" + options.track_id;
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        catch (ex) {
+            throw new Helper_1.CustomException(String(ex), 417);
+        }
     }
-}
-exports.mfaContinue = mfaContinue;
-/**
- * to handle changing password by first login attempt after registration, call **firstTimeChangePassword()**.
- * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/fd8f478d96f58-continue-authentication-flow-after-prechecks for more details.
- * @example
- * ```js
- * cidaas.firstTimeChangePassword({
- *   sub: 'your sub',
- *   old_password: 'your old password',
- *   new_password: 'your new password',
- *   confirm_password: 'your new password',
- *   loginSettingsId: 'loginSettingsId'
- * });
- * ```
- */
-// BREAKING TODO: separate path parameter trackId (from LoginPrecheckRequest) from payload FirstTimeChangePasswordRequest in model
-function firstTimeChangePassword(options) {
-    try {
-        // BREAKING TODO: use trackId instead of loginSettingsId for precheck
-        const url = window.webAuthSettings.authority + "/login-srv/precheck/continue/" + options.loginSettingsId;
-        const form = Helper_1.Helper.createForm(url, options);
-        document.body.appendChild(form);
-        form.submit();
+    /**
+     * To continue after MFA completion, call **mfaContinue()**.
+     *
+     * @example
+     * ```js
+     * cidaasLoginService.mfaContinue({
+     *   track_id: 'your track id'
+     * });
+     * ```
+     */
+    mfaContinue(options) {
+        try {
+            const url = this.config.authority + "/login-srv/precheck/continue/" + options.track_id;
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        catch (ex) {
+            throw new Helper_1.CustomException(String(ex), 417);
+        }
     }
-    catch (ex) {
-        throw new Helper_1.CustomException(String(ex), 417);
+    /**
+     * to handle changing password by first login attempt after registration, call **firstTimeChangePassword()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/fd8f478d96f58-continue-authentication-flow-after-prechecks for more details.
+     * @example
+     * ```js
+     * cidaasLoginService.firstTimeChangePassword({
+     *   old_password: 'your old password',
+     *   new_password: 'your new password',
+     *   confirm_password: 'your new password'
+     * }, 'your track id');
+     * ```
+     */
+    firstTimeChangePassword(options, trackId) {
+        try {
+            const url = this.config.authority + "/login-srv/precheck/continue/" + trackId;
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        catch (ex) {
+            throw new Helper_1.CustomException(String(ex), 417);
+        }
     }
-}
-exports.firstTimeChangePassword = firstTimeChangePassword;
-/**
- * For progressive registration, call **progressiveRegistration()**. While logging in If the API returns 417 with the error message MissingRequiredFields, call the **getMissingFields** to get the list of missing fileds and proceed with progressive registration. In the sample request only the required fields are added, however you must provide the missing fields along with the required fields.
- * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/l7sknp2pytryr-progressive-registration for more details.
- * @example
- * ```js
- * const options = {
- *   sub: 'your sub',
- * }
- * const headers = {
- *   trackId: 'the track id received while logging in',
- *   requestId: 'request id of the session',
- *   acceptlanguage: 'your locale/browser locale (OPTIONAL)',
- * }
- * cidaas.progressiveRegistration(options, headers)
- * .then(function(response) {
- *   // type your code here
- * })
- * .catch(function (ex) {
- *   // your failure code here
- * });
- * ```
- */
-function progressiveRegistration(options, headers) {
-    const serviceURL = window.webAuthSettings.authority + "/login-srv/progressive/update/user";
-    return Helper_1.Helper.createHttpPromise(options, serviceURL, undefined, "POST", undefined, headers);
-}
-exports.progressiveRegistration = progressiveRegistration;
-/**
- * To automatically do user login after successful registration, call **loginAfterRegister()**. Make sure to turn on  "auto login after register" switch on the admin ui to activate loginAfterRegister flow.
- * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qwwamc2f378wi-auto-login-after-register for more details.
- * @example
- * ```js
- * cidaas.loginAfterRegister({
- *   device_id: 'your device id',
- *   dc: 'device capacity'
- *   rememberMe: false,
- *   trackId: 'your track id',
- *   device_fp: 'device fingerprint'
- * });
- * ```
- */
-function loginAfterRegister(options) {
-    try {
-        const url = window.webAuthSettings.authority + "/login-srv/login/handle/afterregister/" + options.trackId;
-        const form = Helper_1.Helper.createForm(url, options);
-        document.body.appendChild(form);
-        form.submit();
+    /**
+     * For progressive registration, call **progressiveRegistration()**. While logging in If the API returns 417 with the error message MissingRequiredFields, call the **getMissingFields** to get the list of missing fileds and proceed with progressive registration. In the sample request only the required fields are added, however you must provide the missing fields along with the required fields.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/l7sknp2pytryr-progressive-registration for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   sub: 'your sub',
+     * }
+     * const headers = {
+     *   trackId: 'the track id received while logging in',
+     *   requestId: 'request id of the session',
+     *   acceptlanguage: 'your locale/browser locale (OPTIONAL)',
+     * }
+     * cidaasLoginService.progressiveRegistration(options, headers)
+     * .then(function(response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    progressiveRegistration(options, headers) {
+        const serviceURL = this.config.authority + "/login-srv/progressive/update/user";
+        return Helper_1.Helper.createHttpPromise(options, serviceURL, undefined, "POST", undefined, headers);
+    }
+    /**
+     * To automatically do user login after successful registration, call **loginAfterRegister()**. Make sure to turn on  "auto login after register" switch on the admin ui to activate loginAfterRegister flow.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/qwwamc2f378wi-auto-login-after-register for more details.
+     * @example
+     * ```js
+     * cidaasLoginService.loginAfterRegister({
+     *   device_id: 'your device id',
+     *   dc: 'device capacity'
+     *   rememberMe: false,
+     *   trackId: 'your track id',
+     *   device_fp: 'device fingerprint'
+     * });
+     * ```
+     */
+    loginAfterRegister(options) {
+        try {
+            const url = this.config.authority + "/login-srv/login/handle/afterregister/" + options.trackId;
+            const form = Helper_1.Helper.createForm(url, options);
+            document.body.appendChild(form);
+            form.submit();
+        }
+        catch (ex) {
+            throw new Helper_1.CustomException(String(ex), 417);
+        }
     }
-    catch (ex) {
-        throw new Helper_1.CustomException(String(ex), 417);
+    /**
+     * To do guest login after activating the feature from admin ui, call **actionGuestLogin()**
+     * Please refer to https://docs.cidaas.com/docs/cidaas-iam/95fd8492a64fe-guest-login for more details
+     * @example
+     * ```js
+     * cidaasLoginService.actionGuestLogin('your request id');
+     * ```
+     */
+    actionGuestLogin(requestId) {
+        const url = this.config.authority + '/login-srv/login/guest/' + requestId;
+        const loginFormElement = document.getElementsByName('guestLoginForm')[0];
+        loginFormElement.action = url;
+        loginFormElement.method = 'post';
+        loginFormElement.submit();
     }
 }
-exports.loginAfterRegister = loginAfterRegister;
-/**
- * To do guest login after activating the feature from admin ui, call **actionGuestLogin()**
- * Please refer to https://docs.cidaas.com/docs/cidaas-iam/95fd8492a64fe-guest-login for more details
- * @example
- * ```js
- * cidaas.actionGuestLogin('your request id');
- * ```
- */
-function actionGuestLogin(requestId) {
-    const url = window.webAuthSettings.authority + '/login-srv/login/guest/' + requestId;
-    const loginFormElement = document.getElementsByName('guestLoginForm')[0];
-    loginFormElement.action = url;
-    loginFormElement.method = 'post';
-    loginFormElement.submit();
-}
-exports.actionGuestLogin = actionGuestLogin;
+exports.LoginService = LoginService;

package/dist/login-service/LoginService.model.d.ts

@@ -1,4 +1,4 @@
-import { LoginPrecheckRequest, VerificationType } from "../common/Common.model";
+import { VerificationType } from "../common/Common.model";
 export interface LoginWithCredentialsRequest {
     /** User identifier used to login e.g. username, email or mobile number */
     username: string;
@@ -8,19 +8,12 @@ export interface LoginWithCredentialsRequest {
     requestId: string;
     /**
      * Type of username used in login
-     * BREAKING TODO: change type to UsernameType only in next major version
-     * */
-    username_type?: UsernameType | string;
+     */
+    username_type?: UsernameType;
     /** Field identifier to tell service, where to look for in case of custom username type */
     field_key?: string;
     /** Login provider configured in cidaas admin ui */
     provider?: string;
-    /** DEPRECATED: Captcha string for captcha check */
-    captcha?: string;
-    /** DEPRECATED: Needed in case bot captcha check is activated */
-    bot_captcha_response?: string;
-    /** DEPRECATED: Token for validating csrf */
-    csrf_token?: string;
     /** Device capacity */
     dc?: string;
     /** Device finger print */
@@ -29,8 +22,6 @@ export interface LoginWithCredentialsRequest {
     captcha_ref?: string;
     /** Response language, which is configured in cidaas admin ui */
     locale?: string;
-    /** DEPRECATED: Duplicate parameter, will be removed in next major release version */
-    rememberMe?: boolean;
     /** Remember me flag to keep user signed in */
     remember_me?: boolean;
 }
@@ -62,59 +53,26 @@ export interface PasswordlessLoginRequest {
     status_id: string;
     /**
      * Type of verification to be used to authenticate user
-     * BREAKING TODO: change type to VerificationType only in next major version
-     * */
-    verificationType: VerificationType | string;
+     */
+    verificationType: VerificationType;
     /**
      * Masked sub (id of user)
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
+     */
     sub?: string;
     /**
      * Masked sub (id of user)
      * Either sub or q have to be provided, depends on what is given from the query parameter.
-     * */
-    q?: string;
-}
-/** DEPRECATED: MfaContinue should only need LoginPrecheckRequest. The change will be implemented in the next major version */
-export interface MfaContinueRequest extends LoginPrecheckRequest {
+     */
     q?: string;
-    sub?: string;
-    requestId?: string;
-    status_id?: string;
-    verificationType?: string;
-    deviceInfo?: DeviceInfo;
-    device_fp?: string;
-}
-/** DEPRECATED: DeviceInfo is only used in MfaContinueRequest, which will be removed in the next major version */
-export interface DeviceInfo {
-    userAgent?: string;
-    ipAddress?: string;
-    lat?: string;
-    lon?: string;
-    deviceId?: string;
-    usedTime?: Date;
-    purpose?: string;
-    requestId?: string;
-    sub?: string;
-    pushNotificationId?: string;
-    deviceMake?: string;
-    deviceModel?: string;
-    deviceType?: string;
 }
 export interface FirstTimeChangePasswordRequest {
-    /** Id of "force change password setting" returned from the login call, which redirect to change password page */
-    loginSettingsId: string;
     /** Old password to be changed */
     old_password: string;
     /** New password to replaced old password */
     new_password: string;
     /** Needed to confirm new password */
     confirm_password: string;
-    sub?: string;
-    identityId?: string;
-    accessToken?: string;
-    client_id?: string;
 }
 export interface ProgressiveRegistrationHeader {
     /** Request id returned from the authorization call */
@@ -129,8 +87,6 @@ export interface ProgressiveRegistrationHeader {
     lon?: string;
 }
 export interface LoginAfterRegisterRequest {
-    /** Deprecated: will be removed in the next major release */
-    device_id?: string;
     /** Device capacity */
     dc?: string;
     /** If true, will keep user logged in */

package/dist/login-service/LoginService.model.js

@@ -10,4 +10,4 @@ var UsernameType;
     UsernameType["Sub"] = "sub";
     UsernameType["IdentityId"] = "identityid";
     UsernameType["Custom"] = "custom";
-})(UsernameType = exports.UsernameType || (exports.UsernameType = {}));
+})(UsernameType || (exports.UsernameType = UsernameType = {}));

package/dist/public-service/PublicService.d.ts

@@ -0,0 +1,57 @@
+import ConfigUserProvider from "../common/ConfigUserProvider";
+import { GetRequestIdRequest, GetClientInfoRequest } from "./PublicService.model";
+export declare class PublicService {
+    private config;
+    constructor(configUserProvider: ConfigUserProvider);
+    /**
+     * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
+     * @example
+     * ```js
+     * // To get requestId using default configured settings, run the function without parameter
+     * cidaasPublicService.getRequestId().then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     *
+     * // To get requestId using custom settings, run the function with custom setting(s) inside option parameter. Example below will only override client_id & redirect_uri
+     * const option: GetRequestIdRequest = {
+     *   'client_id': 'your client id',
+     *   'redirect_uri': 'your redirect url',
+     * }
+     * cidaasPublicService.getRequestId(option).then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getRequestId(option?: GetRequestIdRequest): Promise<any>;
+    /**
+     * To get the tenant basic information, call **getTenantInfo()**. This will return the basic tenant details such as tenant name and allowed login with types (Email, Mobile, Username).
+     * @example
+     * ```js
+     * cidaasPublicService.getTenantInfo().then(function (response) {
+     *   // the response will give you tenant details
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getTenantInfo(): Promise<any>;
+    /**
+     * To get the client basic information, call **getClientInfo()**. This will return the basic client details such as client name and its details.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/dc8a6cfb28abb-public-page-information for more details.
+     * @example
+     * ```js
+     * cidaasPublicService.getClientInfo({
+     *   requestId: 'your requestId',
+     * }).then(function (resp) {
+     *   // the response will give you client info.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getClientInfo(options: GetClientInfoRequest): Promise<any>;
+}