cidaas-javascript-sdk 3.1.5 → 4.0.1

package/dist/web-auth/VerificationService.js

@@ -5,9 +5,21 @@ var Helper_1 = require("./Helper");
 var VerificationService;
 (function (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) {
         try {
@@ -23,229 +35,244 @@ var VerificationService;
     VerificationService.initiateAccountVerification = initiateAccountVerification;
     ;
     /**
-     * initiate verification and return response
-     * @param options
-     * @returns
-     */
-    function initiateAccountVerificationAsynFn(options) {
-        try {
-            var searchParams = new URLSearchParams(options);
-            var response = fetch(window.webAuthSettings.authority + "/verification-srv/account/initiate", {
-                method: "POST",
-                redirect: "follow",
-                body: searchParams.toString(),
-                headers: {
-                    "Content-Type": "application/x-www-form-urlencoded"
-                }
-            });
-            return response;
-        }
-        catch (ex) {
-            throw new Helper_1.CustomException(ex, 417);
-        }
-    }
-    VerificationService.initiateAccountVerificationAsynFn = initiateAccountVerificationAsynFn;
-    ;
-    /**
-     * 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) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/account/verify";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
     VerificationService.verifyAccount = verifyAccount;
     ;
     /**
-     * get mfa list v2
-     * @param options
-     * @returns
+     * 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 getMFAListV2(options) {
+    function getMFAList(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/list";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
-    VerificationService.getMFAListV2 = getMFAListV2;
+    VerificationService.getMFAList = getMFAList;
     ;
     /**
-     * cancel mfa v2
-     * @param options
-     * @returns
+     * 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 cancelMFAV2(options) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/cancel/" + options.type;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST");
+    function cancelMFA(options) {
+        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/cancel/" + options.type;
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
-    VerificationService.cancelMFAV2 = cancelMFAV2;
+    VerificationService.cancelMFA = cancelMFA;
     ;
     /**
-     * @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) {
         var _serviceURL = "".concat(window.webAuthSettings.authority, "/verification-srv/config/list");
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, undefined, "GET", access_token);
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", access_token);
     }
     VerificationService.getAllVerificationList = getAllVerificationList;
     ;
     /**
-     * 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 enrollVerification(options) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/enroll/" + options.verification_type;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST");
+    function initiateEnrollment(options, accessToken) {
+        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/initiate/" + options.verification_type;
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST", accessToken);
     }
-    VerificationService.enrollVerification = enrollVerification;
+    VerificationService.initiateEnrollment = initiateEnrollment;
     ;
     /**
-     * @deprecated This function is no longer supported, instead use {this.updateStatus()}
-     * @param status_id
-     * @returns
-     */
-    function updateSocket(status_id) {
+     * 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, accessToken) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/notification/status/" + status_id;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, undefined, "POST");
+        return Helper_1.Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST", accessToken);
     }
-    VerificationService.updateSocket = updateSocket;
+    VerificationService.getEnrollmentStatus = getEnrollmentStatus;
     ;
     /**
-     * update the status of notification
-     * @param status_id
-     * @returns
+     * 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 updateStatus(status_id) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/notification/status/" + status_id;
-        return Helper_1.Helper.createPostPromise(undefined, _serviceURL, undefined, "POST");
-    }
-    VerificationService.updateStatus = updateStatus;
-    ;
-    /**
-     * setupFidoVerification
-     * @param options
-     * @returns
-     */
-    function setupFidoVerification(options) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/initiate/suggestmfa/" + options.verification_type;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST");
+    function enrollVerification(options) {
+        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/enroll/" + options.verification_type;
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
-    VerificationService.setupFidoVerification = setupFidoVerification;
+    VerificationService.enrollVerification = enrollVerification;
     ;
     /**
-     * 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) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/check/" + options.verification_type;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST");
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
     VerificationService.checkVerificationTypeConfigured = checkVerificationTypeConfigured;
     ;
     /**
-     * initiate mfa v2
-     * @param options
-     * @returns
+     * 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 initiateMFAV2(options) {
+    function initiateMFA(options, accessToken) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/initiate/" + options.type;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
+        // TODO: remove accessToken parameter in the next major release
+        if (accessToken) {
+            return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST", accessToken);
+        }
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, false, "POST");
     }
-    VerificationService.initiateMFAV2 = initiateMFAV2;
+    VerificationService.initiateMFA = initiateMFA;
     ;
     /**
-     * @deprecated
-     * @param options
-     * @param verificationType
-     * @returns
-     */
-    function initiateMfaV1(options, verificationType) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/" + verificationType.toLowerCase() + "/initiate";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
-    }
-    VerificationService.initiateMfaV1 = initiateMfaV1;
-    /**
-     * authenticate mfa v2
-     * @param options
-     * @returns
+     * 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 authenticateMFAV2(options) {
+    function authenticateMFA(options) {
         var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/authenticate/" + options.type;
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, undefined, "POST");
-    }
-    VerificationService.authenticateMFAV2 = authenticateMFAV2;
-    ;
-    /**
-     * authenticateVerification form type (for face)
-     * @param options
-     * @returns
-     */
-    function authenticateFaceVerification(options) {
-        return new Promise(function (resolve, reject) {
-            try {
-                var http = new XMLHttpRequest();
-                var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/authenticate/face";
-                http.onreadystatechange = function () {
-                    if (http.readyState == 4) {
-                        if (http.responseText) {
-                            resolve(JSON.parse(http.responseText));
-                        }
-                        else {
-                            resolve(undefined);
-                        }
-                    }
-                };
-                http.open("POST", _serviceURL, true);
-                http.setRequestHeader("Content-type", "multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW");
-                if (window.localeSettings) {
-                    http.setRequestHeader("accept-language", window.localeSettings);
-                }
-                http.send(JSON.stringify(options));
-            }
-            catch (ex) {
-                reject(ex);
-            }
-        });
+        return Helper_1.Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
     }
-    VerificationService.authenticateFaceVerification = authenticateFaceVerification;
+    VerificationService.authenticateMFA = authenticateMFA;
     ;
-    /**
-     * @deprecated
-     * setup verification - v1
-     * @param options
-     * @param access_token
-     * @param verificationType
-     * @returns
-     */
-    function setupVerificationV1(options, access_token, verificationType) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/" + verificationType.toLowerCase() + "/setup";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST", access_token);
-    }
-    VerificationService.setupVerificationV1 = setupVerificationV1;
-    /**
-     * @deprecated
-     * enroll verification - v1
-     * @param options
-     * @param access_token
-     * @param verificationType
-     * @returns
-     */
-    function enrollVerificationV1(options, access_token, verificationType) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/" + verificationType.toLowerCase() + "/enroll";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST", access_token);
-    }
-    VerificationService.enrollVerificationV1 = enrollVerificationV1;
-    /**
-     * @deprecated
-     * authenticate mfa - v1
-     * @param verificationType
-     * @returns
-     */
-    function authenticateMfaV1(options, verificationType) {
-        var _serviceURL = window.webAuthSettings.authority + "/verification-srv/" + verificationType.toLowerCase() + "/authenticate";
-        return Helper_1.Helper.createPostPromise(options, _serviceURL, false, "POST");
-    }
-    VerificationService.authenticateMfaV1 = authenticateMfaV1;
 })(VerificationService = exports.VerificationService || (exports.VerificationService = {}));