cidaas-javascript-sdk 3.1.4 → 4.0.0

package/dist/web-auth/WebAuth.d.ts

@@ -1,15 +1,19 @@
-import { AccessTokenRequest, TokenIntrospectionEntity, UserEntity, ResetPasswordEntity, IConfiguredListRequestEntity, IInitVerificationAuthenticationRequestEntity, FindUserEntity, IUserEntity, FidoSetupEntity, IEnrollVerificationSetupRequestEntity, ISuggestedMFAActionConfig, IUserLinkEntity, UpdateReviewDeviceEntity, UserActivityEntity, ChangePasswordEntity, IConsentAcceptEntity, IAuthVerificationAuthenticationRequestEntity, FaceVerificationAuthenticationRequestEntity, LoginFormRequestEntity, AccountVerificationRequestEntity, ValidateResetPasswordEntity, AcceptResetPasswordEntity, LoginFormRequestAsyncEntity, PhysicalVerificationLoginRequest, IChangePasswordEntity, ICidaasSDKSettings } from "./Entities";
+import { SigninState, UserManagerSettings } from "oidc-client-ts";
+import { AccessTokenRequest, TokenIntrospectionEntity, UserEntity, ResetPasswordEntity, IConfiguredListRequestEntity, IInitVerificationAuthenticationRequestEntity, FindUserEntity, IUserEntity, IEnrollVerificationSetupRequestEntity, IUserLinkEntity, ChangePasswordEntity, IConsentAcceptEntity, IAuthVerificationAuthenticationRequestEntity, LoginFormRequestEntity, AccountVerificationRequestEntity, ValidateResetPasswordEntity, AcceptResetPasswordEntity, PhysicalVerificationLoginRequest, IChangePasswordEntity, IUserActivityPayloadEntity } from "./Entities";
 export declare class WebAuth {
-    constructor(settings: ICidaasSDKSettings);
-    /**
-   * @param string
-   * @returns
-   */
-    private base64URL;
+    constructor(settings: UserManagerSettings);
     /**
      * login
      */
     loginWithBrowser(): void;
+    /**
+     * popupSignIn
+     */
+    popupSignIn(): void;
+    /**
+     * silentSignIn
+     */
+    silentSignIn(): Promise<unknown>;
     /**
      * register
      */
@@ -20,114 +24,185 @@ export declare class WebAuth {
      */
     loginCallback(): Promise<unknown>;
     /**
-     * get user info
+     * popup signin callback
      * @returns
      */
+    popupSignInCallback(): Promise<unknown>;
+    /**
+     * silent signin callback
+     * @returns
+     */
+    silentSignInCallback(): Promise<unknown>;
+    /**
+     * To get the user profile information by using oidc-client-ts library, call **getUserInfo()**. This will return the basic user profile details along with groups, roles and whatever scopes you mentioned in the options.
+     * @example
+     * ```js
+     * cidaas.getUserInfo().then(function (response) {
+     *   // the response will give you profile details.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });;
+     * ```
+     */
     getUserInfo(): Promise<any>;
     /**
-     * logout
+     * logout by using oidc-client-ts library
      * @returns
      */
     logout(): Promise<unknown>;
+    /**
+     * popup signout
+     * @returns
+     */
+    popupSignOut(): Promise<unknown>;
     /**
      * logout callback
      * @returns
      */
     logoutCallback(): Promise<unknown>;
     /**
-     * get login url
+     * popup signout callback
      * @returns
      */
-    getLoginURL(): string;
+    popupSignOutCallback(): Promise<unknown>;
     /**
-     * get request id
-     * @returns
+     * To get the generated login url, call **getLoginURL()**. This will call authz service and generate login url to be used.
+     * @example
+     * ```js
+     * cidaas.getLoginURL().then(function (response) {
+     *   // the response will give you login url.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });;
+     * ```
      */
-    getRequestId(): Promise<unknown>;
+    getLoginURL(state?: SigninState): Promise<unknown>;
     /**
-     * get missing fields
-     * @param options
-     * @returns
+     * Each and every proccesses starts with requestId, it is an entry point to login or register. For getting the requestId, call **getRequestId()**.
+     * @example
+     * ```js
+     * cidaas.getRequestId().then(function (response) {
+     *   // the response will give you request id.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });;
+     * ```
      */
-    getMissingFields(options: {
-        requestId: string;
-        trackId: string;
-    }): Promise<unknown>;
+    getRequestId(): Promise<unknown>;
     /**
-     * get Tenant info
-     * @returns
+     * 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
+     * cidaas.getTenantInfo().then(function (response) {
+     *   // the response will give you tenant details
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });;
+     * ```
      */
     getTenantInfo(): Promise<unknown>;
     /**
-     * logout api call
-     * @param options
+     * To logout the user by using cidaas internal api, call **logoutUser()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3b5ce6a54bf29-logout for more details.
+     * @example
+     * ```js
+     * cidaas.logoutUser({
+     *   access_token : 'your accessToken'
+     * });
+     * ```
      */
     logoutUser(options: {
         access_token: string;
     }): void;
     /**
-     * get Client Info
-     * @param options
-     * @returns
+     * 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
+     * cidaas.getClientInfo({
+     *   requestId: 'your requestId',
+     * }).then(function (resp) {
+     *   // the response will give you client info.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     getClientInfo(options: {
         requestId: string;
     }): Promise<unknown>;
     /**
-     * get all devices associated to the client
-     * @param options
-     * @returns
-     */
-    getDevicesInfo(options: any): Promise<unknown>;
-    /**
-     * delete a device
-     * @param options
-     * @returns
+     * To get all devices information associated to the client, call **getDevicesInfo()**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a2feed70303c-get-device-by-user for more details.
+     * @example
+     * ```js
+     * const options = {};
+     * const accessToken = 'your access token';
+     * cidaas.getDevicesInfo(options, accessToken).then(function (resp) {
+     *   // the response will give you devices informations.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getDevicesInfo(options: any, accessToken: string): Promise<unknown>;
+    /**
+     * To delete device associated to the client, call **deleteDevice()**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/3d44ad903d6e8-logout-the-user-for-a-device for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   device_id: 'id of device associated to the client.' // call **getDevicesInfo()** to get List of device ids and its details.
+     * };
+     * const accessToken = 'your access token';
+     * cidaas.deleteDevice(options, accessToken).then(function (resp) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code
+     * });
+     * ```
      */
     deleteDevice(options: {
         device_id: string;
         userAgent?: string;
-    }): Promise<unknown>;
-    /**
-     * get Registration setup
-     * @param options
-     * @returns
+    }, accessToken: string): Promise<unknown>;
+    /**
+     * To handle registration, first you need the registration fields. To get the registration fields, call **getRegistrationSetup()**. This will return the fields that has to be needed while registration.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/4eae72956f65a-registration-field-setup for more details.
+     * @example
+     * ```js
+     * cidaas.getRegistrationSetup({
+     *   requestId: 'your requestId',
+     *   acceptlanguage: 'your locale' // optional example: de-de, en-US
+     * }).then(function (resp) {
+     *   // the response will give you fields that are required.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     getRegistrationSetup(options: {
-        acceptlanguage: string;
+        acceptlanguage?: string;
         requestId: string;
     }): Promise<unknown>;
     /**
-   * get unreviewed devices
-   * @param access_token
-   * @param sub
-   * @returns
-   */
-    getUnreviewedDevices(access_token: string, sub: string): Promise<unknown>;
-    /**
-     * get reviewed devices
-     * @param access_token
-     * @param sub
-     * @returns
+     * to generate device info, call **createDeviceInfo()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9b5a892afaf0b-create-device-info for more details.
+     * @example
+     * ```js
+     * cidaas.createDeviceInfo().then(function (resp) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code
+     * });
+     * ```
      */
-    getReviewedDevices(access_token: string, sub: string): Promise<unknown>;
+    createDeviceInfo(): Promise<unknown>;
     /**
-     * review device
+     * get the user profile information
      * @param options
-     * @param access_token
-     * @returns
-     */
-    reviewDevice(options: UpdateReviewDeviceEntity, access_token: string): Promise<unknown>;
-    /**
-     * get device info
      * @returns
      */
-    getDeviceInfo(): Promise<unknown>;
-    /**
-    * get user info
-    * @param options
-    * @returns
-    */
     getUserProfile(options: {
         access_token: string;
     }): Promise<unknown>;
@@ -154,12 +229,6 @@ export declare class WebAuth {
      * @param options
      */
     loginWithCredentials(options: LoginFormRequestEntity): void;
-    /**
-     * login with username and password and return response
-     * @param options
-     * @returns
-     */
-    loginWithCredentialsAsynFn(options: LoginFormRequestAsyncEntity): Promise<void>;
     /**
      * login with social
      * @param options
@@ -212,6 +281,7 @@ export declare class WebAuth {
      */
     getCommunicationStatus(options: {
         sub: string;
+    }, headers: {
         requestId: string;
     }): Promise<unknown>;
     /**
@@ -220,12 +290,6 @@ export declare class WebAuth {
      * @returns
      */
     initiateAccountVerification(options: AccountVerificationRequestEntity): void;
-    /**
-     * initiate verification and return response
-     * @param options
-     * @returns
-     */
-    initiateAccountVerificationAsynFn(options: AccountVerificationRequestEntity): Promise<Response>;
     /**
      * verify account
      * @param options
@@ -252,17 +316,17 @@ export declare class WebAuth {
     */
     resetPassword(options: AcceptResetPasswordEntity): Promise<unknown>;
     /**
-     * get mfa list v2
+     * get mfa list
      * @param options
      * @returns
      */
-    getMFAListV2(options: IConfiguredListRequestEntity): Promise<unknown>;
+    getMFAList(options: IConfiguredListRequestEntity): Promise<unknown>;
     /**
-     * cancel mfa v2
+     * cancel mfa
      * @param options
      * @returns
      */
-    cancelMFAV2(options: {
+    cancelMFA(options: {
         exchange_id: string;
         reason: string;
         type: string;
@@ -277,23 +341,23 @@ export declare class WebAuth {
      * @param options
      * @returns
      */
-    getConsentDetailsV2(options: {
+    getConsentDetails(options: {
         consent_id: string;
         consent_version_id: string;
         sub: string;
     }): Promise<unknown>;
     /**
-     * accept consent v2
+     * accept consent
      * @param options
      * @returns
      */
-    acceptConsentV2(options: IConsentAcceptEntity): Promise<unknown>;
+    acceptConsent(options: IConsentAcceptEntity): Promise<unknown>;
     /**
      * get scope consent details
      * @param options
      * @returns
      */
-    getScopeConsentDetails(options: {
+    loginPrecheck(options: {
         track_id: string;
         locale: string;
     }): Promise<unknown>;
@@ -302,8 +366,8 @@ export declare class WebAuth {
      * @param options
      * @returns
      */
-    getScopeConsentVersionDetailsV2(options: {
-        scopeid: string;
+    getConsentVersionDetails(options: {
+        consentid: string;
         locale: string;
         access_token: string;
     }): Promise<unknown>;
@@ -317,13 +381,6 @@ export declare class WebAuth {
         sub: string;
         scopes: string[];
     }): Promise<unknown>;
-    /**
-     * scope consent continue login
-     * @param options
-     */
-    scopeConsentContinue(options: {
-        track_id: string;
-    }): void;
     /**
      * accept claim Consent
      * @param options
@@ -334,13 +391,6 @@ export declare class WebAuth {
         sub: string;
         accepted_claims: string[];
     }): Promise<unknown>;
-    /**
-     * claim consent continue login
-     * @param options
-     */
-    claimConsentContinue(options: {
-        track_id: string;
-    }): void;
     /**
      * revoke claim Consent
      * @param options
@@ -417,12 +467,26 @@ export declare class WebAuth {
      */
     updateProfile(options: UserEntity, access_token: string, sub: string): Promise<unknown>;
     /**
-     * get user activities
-     * @param options
-     * @param access_token
-     * @returns
-     */
-    getUserActivities(options: UserActivityEntity, access_token: string): Promise<unknown>;
+     * To get user activities, call **getUserActivities()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/346141453781e-get-user-activities for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   sub: 'your sub',
+     *   dateFilter: {
+     *     from_date: 'date in UTC format',
+     *     to:date: 'date in UTC format'
+     *   }
+     * };
+     * const accessToken = 'your access token';
+     * cidaas.getUserActivities(options, accessToken).then(function (resp) {
+     *   // your success code
+     * }).catch(function(ex) {
+     *   // your failure code
+     * });
+     * ```
+     */
+    getUserActivities(options: IUserActivityPayloadEntity, accessToken: string): Promise<unknown>;
     /**
      * @param access_token
      * @returns
@@ -460,45 +524,54 @@ export declare class WebAuth {
      */
     unlinkAccount(access_token: string, identityId: string): Promise<unknown>;
     /**
-     * image upload
-     * @param options
-     * @param access_token
-     * @returns
-     */
+    * To change profile image, call **updateProfileImage()**.
+    * @example
+    * ```js
+    * const options = {
+    *   image_key: 'id for your image e.g. user sub',
+    *   photo: yourImageFile,
+    *   filename: 'name of your image file'
+    * };
+    * const accessToken = 'your access token';
+    * cidaas.updateProfileImage(options, accessToken).then(function (resp) {
+    *   // your success code
+    * }).catch(function(ex) {
+    *   // your failure code
+    * });
+    * ```
+    */
     updateProfileImage(options: {
         image_key: string;
+        photo: any;
+        filename: string;
     }, access_token: string): Promise<unknown>;
-    /**
-     * updateSuggestMFA
-     * @param track_id
-     * @param options
-     * @returns
-     */
-    updateSuggestMFA(track_id: string, options: ISuggestedMFAActionConfig): Promise<unknown>;
     /**
      * enrollVerification
      * @param options
      * @returns
      */
-    enrollVerification(options: IEnrollVerificationSetupRequestEntity): Promise<unknown>;
-    /**
-     * @deprecated This function is no longer supported, instead use {this.updateStatus()}
-     * @param status_id
-     * @returns
-     */
-    updateSocket(status_id: string): Promise<unknown>;
+    initiateEnrollment(options: {
+        verification_type: string;
+        deviceInfo?: {
+            deviceId: string;
+            location: {
+                lat: string;
+                lon: string;
+            };
+        };
+    }, accessToken: string): Promise<unknown>;
     /**
      * update the status of notification
      * @param status_id
      * @returns
      */
-    updateStatus(status_id: string): Promise<unknown>;
+    getEnrollmentStatus(status_id: string, accessToken: string): Promise<unknown>;
     /**
-     * setupFidoVerification
+     * enrollVerification
      * @param options
      * @returns
      */
-    setupFidoVerification(options: FidoSetupEntity): Promise<unknown>;
+    enrollVerification(options: IEnrollVerificationSetupRequestEntity): Promise<unknown>;
     /**
      * checkVerificationTypeConfigured
      * @param options
@@ -515,11 +588,11 @@ export declare class WebAuth {
         sub: string;
     }): Promise<unknown>;
     /**
-     * getMissingFieldsLogin
+     * getMissingFields
      * @param trackId
      * @returns
      */
-    getMissingFieldsLogin(trackId: string): Promise<unknown>;
+    getMissingFields(trackId: string): Promise<unknown>;
     /**
      * progressiveRegistration
      * @param options
@@ -532,15 +605,9 @@ export declare class WebAuth {
         acceptlanguage: string;
     }): Promise<unknown>;
     /**
-     * loginAfterRegister
-     * @param options
+     * device code flow - initiate
      */
-    loginAfterRegister(options: {
-        device_id: string;
-        dc?: string;
-        rememberMe: boolean;
-        trackId: string;
-    }): void;
+    initiateDeviceCode(clientId?: string): Promise<unknown>;
     /**
      * device code flow - verify
      * @param code
@@ -558,325 +625,23 @@ export declare class WebAuth {
      */
     setAcceptLanguageHeader(acceptLanguage: string): void;
     /**
-     * initiate mfa v2
+     * initiate mfa
      * @param options
      * @returns
      */
-    initiateMFAV2(options: IInitVerificationAuthenticationRequestEntity): Promise<unknown>;
+    initiateMFA(options: IInitVerificationAuthenticationRequestEntity, accessToken: string): Promise<unknown>;
     /**
-     * initiateVerification
+     * authenticate mfa
      * @param options
-     */
-    initiateVerification(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate email v2
-     * @param options
-     */
-    initiateEmailV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate sms v2
-     * @param options
-     */
-    initiateSMSV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate ivr v2
-     * @param options
-     */
-    initiateIVRV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate backupcode v2
-     * @param options
-     */
-    initiateBackupcodeV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate totp v2
-     * @param options
-     */
-    initiateTOTPV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate pattern v2
-     * @param options
-     */
-    initiatePatternV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate touchid v2
-     * @param options
-     */
-    initiateTouchIdV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate smart push v2
-     * @param options
-     */
-    initiateSmartPushV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate face v2
-     * @param options
-     */
-    initiateFaceV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * initiate voice v2
-     * @param options
-     */
-    initiateVoiceV2(options: IInitVerificationAuthenticationRequestEntity): void;
-    /**
-     * @deprecated
-     * @param options
-     * @param verificationType
      * @returns
      */
-    initiateMfaV1(options: any, verificationType: string): Promise<unknown>;
-    /**
-    * @deprecated
-    * initiate email - v1
-    * @param options
-    */
-    initiateEmail(options: any): void;
+    authenticateMFA(options: IAuthVerificationAuthenticationRequestEntity): Promise<unknown>;
     /**
-    * @deprecated
-    * initiate SMS - v1
-    * @param options
-    */
-    initiateSMS(options: any): void;
-    /**
-    * @deprecated
-    * initiate IVR - v1
-    * @param options
-    */
-    initiateIVR(options: any): void;
-    /**
-    * @deprecated
-    * initiate backup code - v1
-    * @param options
-    */
-    initiateBackupcode(options: any): void;
-    /**
-     * @deprecated
-     * initiate TOTP - v1
-     * @param options
-     */
-    initiateTOTP(options: any): void;
-    /**
-    * @deprecated
-    * initiate pattern - v1
-    * @param options
-    */
-    initiatePattern(options: any): void;
-    /**
-    * @deprecated
-    * initiate touchid - v1
-    * @param options
-    */
-    initiateTouchId(options: any): void;
-    /**
-      * @deprecated
-      * initiate push - v1
-      * @param options
-      */ initiateSmartPush(options: any): void;
-    /**
-    * @deprecated
-    * initiate face - v1
-    * @param options
-    */
-    initiateFace(options: any): void;
-    /**
-     * @deprecated
-     * initiate Voice - v1
-     * @param options
-     */
-    initiateVoice(options: any): void;
-    /**
-     * authenticate mfa v2
-     * @param options
-     * @returns
-     */
-    authenticateMFAV2(options: IAuthVerificationAuthenticationRequestEntity): Promise<unknown>;
-    /**
-     * authenticateVerification
-     * @param options
-     */
-    authenticateVerification(options: IAuthVerificationAuthenticationRequestEntity): void;
-    /**
-     * authenticate email v2
-     * @param options
-     */
-    authenticateEmailV2(options: IAuthVerificationAuthenticationRequestEntity): void;
-    /**
-     * authenticate sms v2
-     * @param options
-     */
-    authenticateSMSV2(options: IAuthVerificationAuthenticationRequestEntity): void;
-    /**
-     * authenticate ivr v2
-     * @param options
-     */
-    authenticateIVRV2(options: IAuthVerificationAuthenticationRequestEntity): void;
-    /**
-     * authenticate backupcode v2
-     * @param options
-     */
-    authenticateBackupcodeV2(options: IAuthVerificationAuthenticationRequestEntity): void;
-    /**
-     * authenticate totp v2
-     * @param options
-     */
-    authenticateTOTPV2(options: IAuthVerificationAuthenticationRequestEntity): void;
-    /**
-     * authenticateVerification form type (for face)
-     * @param options
-     * @returns
-     */
-    authenticateFaceVerification(options: FaceVerificationAuthenticationRequestEntity): Promise<unknown>;
-    /**
-     * @deprecated
-     * setup verification - v1
-     * @param options
-     * @param access_token
-     * @param verificationType
-     * @returns
-     */
-    setupVerificationV1(options: any, access_token: string, verificationType: string): Promise<unknown>;
-    /**
-     * @deprecated
-     * setup email - v1
-     * @param options
-     * @param access_token
-     */
-    setupEmail(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup sms - v1
-     * @param options
-     * @param access_token
-     */
-    setupSMS(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup ivr - v1
-     * @param options
-     * @param access_token
-     */
-    setupIVR(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup backupcode - v1
-     * @param options
-     * @param access_token
-     */
-    setupBackupcode(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup totp - v1
-     * @param options
-     * @param access_token
-     */
-    setupTOTP(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup pattern - v1
-     * @param options
-     * @param access_token
-     */
-    setupPattern(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup touch - v1
-     * @param options
-     * @param access_token
-     */
-    setupTouchId(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup smart push - v1
-     * @param options
-     * @param access_token
-     */
-    setupSmartPush(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup face - v1
-     * @param options
-     * @param access_token
-     */
-    setupFace(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * setup voice - v1
-     * @param options
-     * @param access_token
-     */
-    setupVoice(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * enroll verification - v1
-     * @param options
-     * @param access_token
-     * @param verificationType
-     * @returns
-     */
-    enrollVerificationV1(options: any, access_token: string, verificationType: string): Promise<unknown>;
-    /**
-     * @deprecated
-     * enroll email - v1
-     * @param options
-     * @param access_token
-     */
-    enrollEmail(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * enroll SMS - v1
-     * @param options
-     * @param access_token
-     */
-    enrollSMS(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * enroll IVR - v1
-     * @param options
-     * @param access_token
-     */
-    enrollIVR(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * enroll TOTP - v1
-     * @param options
-     * @param access_token
-     */
-    enrollTOTP(options: any, access_token: string): void;
-    /**
-     * @deprecated
-     * authenticate mfa - v1
-     * @param verificationType
-     * @returns
-     */
-    authenticateMfaV1(options: any, verificationType: string): Promise<unknown>;
-    /**
-     * @deprecated
-     * authenticate email - v1
-     * @param options
-     */
-    authenticateEmail(options: any): void;
-    /**
-     * @deprecated
-     * authenticate sms - v1
-     * @param options
-     */
-    authenticateSMS(options: any): void;
-    /**
-     * @deprecated
-     * authenticate ivr - v1
-     * @param options
-     */
-    authenticateIVR(options: any): void;
-    /**
-     * @deprecated
-     * authenticate totp - v1
-     * @param options
-     */
-    authenticateTOTP(options: any): void;
-    /**
-     * @deprecated
-     * authenticate backupcode - v1
-     * @param options
+     * offline token check
      */
-    authenticateBackupcode(options: any): void;
+    offlineTokenCheck(accessToken: string): {
+        isExpiryDateValid: boolean;
+        isScopesValid: boolean;
+        isIssuerValid: boolean;
+    };
 }