cidaas-javascript-sdk 3.1.5 → 4.0.1

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

@@ -1,125 +1,224 @@
-import { IConfiguredListRequestEntity, IInitVerificationAuthenticationRequestEntity, FidoSetupEntity, IEnrollVerificationSetupRequestEntity, IAuthVerificationAuthenticationRequestEntity, FaceVerificationAuthenticationRequestEntity, AccountVerificationRequestEntity } from "./Entities";
+import { IConfiguredListRequestEntity, IInitVerificationAuthenticationRequestEntity, IEnrollVerificationSetupRequestEntity, IAuthVerificationAuthenticationRequestEntity, AccountVerificationRequestEntity } from "./Entities";
 export declare namespace VerificationService {
     /**
-       * initiate verification
-       * @param options
-       * @returns
+       * To initiate the account verification, call **initiateAccountVerification()**. This will send verification code  email or sms or ivr based on the verificationMedium you mentioned.
+       * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/cgans5erj5alg-init-account-verification for more details.
+       * @example
+       * ```js
+       * cidaas.initiateAccountVerification({
+       *   verificationMedium: 'email',
+       *   requestId: 'your requestId',
+       *   processingType: 'CODE',
+       *   email: 'your email'
+       * }).then(function (response) {
+       *   // the response will give you account verification details.
+       * }).catch(function(ex) {
+       *   // your failure code here
+       * });
+       * ```
        */
     function initiateAccountVerification(options: AccountVerificationRequestEntity): void;
     /**
-     * initiate verification and return response
-     * @param options
-     * @returns
-     */
-    function initiateAccountVerificationAsynFn(options: AccountVerificationRequestEntity): Promise<Response>;
-    /**
-     * verify account
-     * @param options
-     * @returns
+     * To complete the verification, call **verifyAccount()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/r8h9mvavvw2e6-verify-account for more details.
+     * @example
+     * ```js
+     * cidaas.verifyAccount({
+     *   accvid: 'your accvid', // which you will get on initiate account verification response
+     *   code: 'your code in email or sms or ivr'
+     * }).then(function (response) {
+     *   // the response will give you account verification ID and unique code.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function verifyAccount(options: {
         accvid: string;
         code: string;
     }): Promise<unknown>;
     /**
-     * get mfa list v2
-     * @param options
-     * @returns
-     */
-    function getMFAListV2(options: IConfiguredListRequestEntity): Promise<unknown>;
-    /**
-     * cancel mfa v2
-     * @param options
-     * @returns
-     */
-    function cancelMFAV2(options: {
+     * To get all configured multi factor authentication, call **getMFAList()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
+     * @example
+     * ```js
+     * cidaas.getMFAList({
+     *   request_id: 'your request id',
+     *   email: 'your email'
+     * }).then(function (response) {
+     *   // the response will give you list of configured multi factor authentication
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    function getMFAList(options: IConfiguredListRequestEntity): Promise<unknown>;
+    /**
+     * to cancel mfa process, call **cancelMFA()**.
+     * @example
+     * ```js
+     * cidaas.cancelMFA({
+     *   exchange_id: 'exchange id from initiateMFA() response',
+     *   reason: 'reason of mfa cancelation',
+     *   type: 'authentication type e.g. email'
+     * }).then(function (response) {
+     *   // your success code here
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    function cancelMFA(options: {
         exchange_id: string;
         reason: string;
         type: string;
     }): Promise<unknown>;
     /**
-     * @param access_token
-     * @returns
+     * To get list of all verification type configured, call **getAllVerificationList()**. access_token must be passed as function parameter.
+     * @example
+     * ```js
+     * const access_token = "your access token";
+     *
+     * cidaas.getAllVerificationList(access_token)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function getAllVerificationList(access_token: string): Promise<unknown>;
     /**
-     * enrollVerification
-     * @param options
-     * @returns
+     * To initiate enrollment of new multi factor authentication, call **initiateEnrollment()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/f85aef6754714-initiate-physical-verification-setup for more details.
+     * @example
+     * ```js
+     * const access_token = "your access token";
+     * const options = {
+     *   verification_type: 'one of verification_type such as fido2, face, ivr',
+     *   deviceInfo: {
+     *    deviceId: '',
+     *    location: {lat: '', lon: ''}
+     *  }
+     * }
+     *
+     * cidaas.initiateEnrollment(options, access_token)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    function initiateEnrollment(options: {
+        verification_type: string;
+        deviceInfo?: {
+            deviceId: string;
+            location: {
+                lat: string;
+                lon: string;
+            };
+        };
+    }, accessToken: string): Promise<unknown>;
+    /**
+     * to get the status of MFA enrollment, call **getEnrollmentStatus()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/b06447d02d8e0-get-status-of-physical-verification-setup-configuration for more details.
+     * @example
+     * ```js
+     * cidaas.getEnrollmentStatus('statusId from initiateEnrollment()', 'your access token')
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+    */
+    function getEnrollmentStatus(status_id: string, accessToken: string): Promise<unknown>;
+    /**
+     * to finish enrollment process of new multi factor authentication, call **enrollVerification()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/20ec76e937b27-enroll-physical-verification-setup for more details.
+     * @example
+     * ```js
+     * const fidoPayload = {
+     *   sub: 'your sub',
+     *   exchange_id: 'exchange_id from initiateEnrollment()',
+     *   verification_type: 'fido2',
+     *   fido2_client_response: {
+     *     client_response: 'client_response from doing fido process',
+     *     fidoRequestId: 'fidoRequestId from initiateEnrollment',
+     *   }
+     * }
+     * cidaas.enrollVerification(fidoPayload)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function enrollVerification(options: IEnrollVerificationSetupRequestEntity): Promise<unknown>;
     /**
-     * @deprecated This function is no longer supported, instead use {this.updateStatus()}
-     * @param status_id
-     * @returns
-     */
-    function updateSocket(status_id: string): Promise<unknown>;
-    /**
-     * update the status of notification
-     * @param status_id
-     * @returns
-     */
-    function updateStatus(status_id: string): Promise<unknown>;
-    /**
-     * setupFidoVerification
-     * @param options
-     * @returns
-     */
-    function setupFidoVerification(options: FidoSetupEntity): Promise<unknown>;
-    /**
-     * checkVerificationTypeConfigured
-     * @param options
-     * @returns
+     * to see details of configured verification type, call **checkVerificationTypeConfigured()**.
+     * @example
+     * ```js
+     * cidaas.checkVerificationTypeConfigured({
+     *   request_id: 'your request id',
+     *   email: 'your email',
+     *   verification_type: 'email'
+     * }).then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
      */
     function checkVerificationTypeConfigured(options: IConfiguredListRequestEntity): Promise<unknown>;
     /**
-     * initiate mfa v2
-     * @param options
-     * @returns
-     */
-    function initiateMFAV2(options: IInitVerificationAuthenticationRequestEntity): Promise<unknown>;
-    /**
-     * @deprecated
-     * @param options
-     * @param verificationType
-     * @returns
-     */
-    function initiateMfaV1(options: any, verificationType: string): Promise<unknown>;
-    /**
-     * authenticate mfa v2
-     * @param options
-     * @returns
-     */
-    function authenticateMFAV2(options: IAuthVerificationAuthenticationRequestEntity): Promise<unknown>;
-    /**
-     * authenticateVerification form type (for face)
-     * @param options
-     * @returns
-     */
-    function authenticateFaceVerification(options: FaceVerificationAuthenticationRequestEntity): Promise<unknown>;
-    /**
-     * @deprecated
-     * setup verification - v1
-     * @param options
-     * @param access_token
-     * @param verificationType
-     * @returns
-     */
-    function setupVerificationV1(options: any, access_token: string, verificationType: string): Promise<unknown>;
-    /**
-     * @deprecated
-     * enroll verification - v1
-     * @param options
-     * @param access_token
-     * @param verificationType
-     * @returns
-     */
-    function enrollVerificationV1(options: any, access_token: string, verificationType: string): Promise<unknown>;
-    /**
-     * @deprecated
-     * authenticate mfa - v1
-     * @param verificationType
-     * @returns
-     */
-    function authenticateMfaV1(options: any, verificationType: string): Promise<unknown>;
+     * to initiate multi factor auhentication, call **initiateMFA()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a3ea581bb249-initiate-verification for more details.
+     * @example
+     * ```js
+     * const access_token = "your access token";
+     * const options = {
+     *   request_id: 'your request id',
+     *   usage_type: 'PASSWORDLESS_AUTHENTICATION',
+     *   type: 'email'
+     *   email: 'your email'
+     *  }
+     * }
+     *
+     * cidaas.initiateMFA(options, access_token)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    function initiateMFA(options: IInitVerificationAuthenticationRequestEntity, accessToken?: string): Promise<unknown>;
+    /**
+     * to authenticate with multi factor auhentication, call **authenticateMFA()**.
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/1aa38936252d6-perform-the-authentication-method for more details.
+      * @example
+     * ```js
+     * cidaas.authenticateMFA({
+     *   type: 'email',
+     *   client_id: 'your client id',
+     *   exchange_id: exchange id from initiateMFA(),
+     *   pass_code: 'code to authenticate'
+     * }).then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    function authenticateMFA(options: IAuthVerificationAuthenticationRequestEntity): Promise<unknown>;
 }