cidaas-javascript-sdk 4.3.3 → 5.1.0

package/dist/user-service/UserService.model.d.ts

@@ -1,8 +1,14 @@
 import { ProcessingType } from "../common/Common.model";
 import { CidaasUser } from "../common/User.model";
 export interface GetUserProfileRequest {
-    /** Access token needed to authorized api call */
-    access_token: string;
+    /** Access token needed to authorized api call. If not provided, access token from UserStorage will be used. */
+    access_token?: string;
+}
+export interface GetRegistrationSetupRequest {
+    /** Request id returned from the authorization call */
+    requestId: string;
+    /** Response language, which is configured in cidaas admin ui */
+    acceptlanguage?: string;
 }
 export interface RegisterRequest extends CidaasUser {
     /** id which is generated during user invitation process */
@@ -14,21 +20,19 @@ export interface GetInviteUserDetailsRequest {
     /** described whether latest api or legacy api should be called */
     callLatestAPI?: boolean;
 }
-export interface getCommunicationStatusRequest {
+export interface GetCommunicationStatusRequest {
     /** Subject (User) identifier */
     sub: string;
 }
 export interface InitiateResetPasswordRequest {
     /**
      * Type of medium to be used to reset password
-     * BREAKING TODO: change type to ResetMedium only in next major version
-     * */
-    resetMedium: ResetMedium | string;
+     */
+    resetMedium: ResetMedium;
     /**
      * defines whether the password can be resetted via email link or whether the user needs to enter a code to complete the reset password process.
-     * BREAKING TODO: change type to ProcessingType only in next major version
-     * */
-    processingType: ProcessingType | string;
+     */
+    processingType: ProcessingType;
     /** Email of the user */
     email?: string;
     /** Mobile number of the user */
@@ -105,10 +109,10 @@ export interface InitiateLinkAccountRequest {
     user_name_to_link: string;
 }
 export interface DeleteUserAccountRequest {
-    /** Access token needed to authorized api call */
-    access_token?: string;
     /** Subject (User) identifier */
     sub: string;
+    /** Access token needed to authorized api call. If not provided, access token from UserStorage will be used. */
+    access_token?: string;
 }
 export interface CompleteLinkAccountRequest {
     /** code will be sent to account to be linked */
@@ -134,9 +138,39 @@ export interface UserCheckExistsRequest {
     /** If filled, will be sent as query parameter */
     webfinger?: string;
 }
+export interface GetUserActivitiesRequest {
+    /** sub of user to get its activities */
+    sub: string;
+    /** limits activities number to be shown */
+    size?: number;
+    /** shows activities starting from the 'from' number. Default is 0 */
+    from?: number;
+    /** if true, the activites will be sorted with the latest one at start */
+    descending?: boolean;
+    /** activities are shown based on the dateFilter */
+    dateFilter?: DateFilter;
+}
+export interface UserActionOnEnrollmentRequest {
+    /** action to be executed */
+    action: string;
+}
+export interface UpdateProfileImageRequest {
+    /** id for the image */
+    image_key: string;
+    /** name of the image */
+    filename: string;
+    /** image file */
+    photo: Blob;
+}
+export interface DateFilter {
+    /** earliest time to show activities */
+    from_date: string;
+    /** latest time to show activities */
+    to_date: string;
+}
 /** Type of medium to be used to reset password */
 export declare enum ResetMedium {
-    'SMS' = 0,
-    'EMAIL' = 1,
-    'IVR' = 2
+    Sms = "SMS",
+    Email = "EMAIL",
+    Ivr = "IVR"
 }

package/dist/user-service/UserService.model.js

@@ -4,7 +4,7 @@ exports.ResetMedium = void 0;
 /** Type of medium to be used to reset password */
 var ResetMedium;
 (function (ResetMedium) {
-    ResetMedium[ResetMedium["SMS"] = 0] = "SMS";
-    ResetMedium[ResetMedium["EMAIL"] = 1] = "EMAIL";
-    ResetMedium[ResetMedium["IVR"] = 2] = "IVR";
-})(ResetMedium = exports.ResetMedium || (exports.ResetMedium = {}));
+    ResetMedium["Sms"] = "SMS";
+    ResetMedium["Email"] = "EMAIL";
+    ResetMedium["Ivr"] = "IVR";
+})(ResetMedium || (exports.ResetMedium = ResetMedium = {}));

package/dist/verification-service/VerificationService.d.ts

@@ -1,225 +1,283 @@
 import { HTTPRequestHeader } from "../common/Common.model";
+import ConfigUserProvider from "../common/ConfigUserProvider";
 import { AuthenticateMFARequest, CancelMFARequest, CheckVerificationTypeConfiguredRequest, ConfigureFriendlyNameRequest, ConfigureVerificationRequest, EnrollVerificationRequest, GetMFAListRequest, InitiateAccountVerificationRequest, InitiateEnrollmentRequest, InitiateMFARequest, InitiateVerificationRequest, VerifyAccountRequest } from "./VerificationService.model";
-/**
-   * 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: ProcessingType.CODE,
-   *   email: 'your email'
-   * }).then(function (response) {
-   *   // the response will give you account verification details.
-   * }).catch(function(ex) {
-   *   // your failure code here
-   * });
-   * ```
-   */
-export declare function initiateAccountVerification(options: InitiateAccountVerificationRequest): void;
-/**
- * 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
- * });
- * ```
- */
-export declare function verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * To get all configured multi factor authentication, call **getMFAList()**.
- *
- * As Parameter, you need to pass request id & one of the following: email or mobile phone or username.
- *
- * In case you are in prelogin page and don't have user information yet (such as mfa-required & account-verification page), you could pass
- * request id & masked sub (one of the following: sub or q), depends on which one is available in the query parameter generated by cidaas.
- *
- * 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
- * });
- * ```
- */
-export declare function getMFAList(options: GetMFAListRequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function cancelMFA(options: CancelMFARequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function getAllVerificationList(access_token: string, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function initiateEnrollment(options: InitiateEnrollmentRequest, accessToken: string): Promise<any>;
-/**
- * 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
- * });
- * ```
-*/
-export declare function getEnrollmentStatus(status_id: string, accessToken: string, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function enrollVerification(options: EnrollVerificationRequest): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function checkVerificationTypeConfigured(options: CheckVerificationTypeConfiguredRequest): Promise<any>;
-/**
- * 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
- * });
- * ```
- */
-export declare function initiateMFA(options: InitiateMFARequest, accessToken?: string, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * 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
-  * });
-  * ```
-  */
-export declare function authenticateMFA(options: AuthenticateMFARequest, headers?: HTTPRequestHeader): Promise<any>;
-/**
- * to initiate verification process, call **initiateVerification**
- */
-export declare function initiateVerification(options: InitiateVerificationRequest, trackId: string, method: string): Promise<any>;
-/**
- * to finish configuring verification process, call **configureVerification**
- */
-export declare function configureVerification(options: ConfigureVerificationRequest, method: string): Promise<any>;
-/**
- * to configure friendly name, call **configureFriendlyName**
- */
-export declare function configureFriendlyName(options: ConfigureFriendlyNameRequest, trackId: string, method: string): Promise<any>;
+export declare class VerificationService {
+    private config;
+    private userManager;
+    constructor(configUserProvider: ConfigUserProvider);
+    /**
+     * 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
+     * cidaasVerificationService.initiateAccountVerification({
+     *   verificationMedium: 'email',
+     *   requestId: 'your requestId',
+     *   processingType: ProcessingType.Code,
+     *   email: 'your email'
+     * }).then(function (response) {
+     *   // the response will give you account verification details.
+     * }).catch(function(ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    initiateAccountVerification(options: InitiateAccountVerificationRequest): void;
+    /**
+     * 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
+     * cidaasVerificationService.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
+     * });
+     * ```
+     */
+    verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * To get all configured multi factor authentication, call **getMFAList()**.
+     *
+     * As Parameter, you need to pass request id & one of the following: email or mobile phone or username.
+     *
+     * In case you are in prelogin page and don't have user information yet (such as mfa-required & account-verification page), you could pass
+     * request id & masked sub (one of the following: sub or q), depends on which one is available in the query parameter generated by cidaas.
+     *
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
+     * @example
+     * ```js
+     * cidaasVerificationService.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
+     * });
+     * ```
+     */
+    getMFAList(options: GetMFAListRequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * to cancel mfa process, call **cancelMFA()**.
+     * @example
+     * ```js
+     * cidaasVerificationService.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
+     * });
+     * ```
+     */
+    cancelMFA(options: CancelMFARequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * To get list of all verification type configured, call **getAllVerificationList()**. access_token must be passed as function parameter.
+     * @example
+     * ```js
+     * cidaasVerificationService.getAllVerificationList()
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    getAllVerificationList(access_token?: string, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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 options = {
+     *   verification_type: 'one of verification_type such as fido2, face, ivr',
+     *   deviceInfo: {
+     *    deviceId: '',
+     *    location: {lat: '', lon: ''}
+     *  }
+     * }
+     *
+     * cidaasVerificationService.initiateEnrollment(options)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    initiateEnrollment(options: InitiateEnrollmentRequest, access_token?: string): Promise<any>;
+    /**
+     * 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
+     * cidaasVerificationService.getEnrollmentStatus('statusId from initiateEnrollment()')
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+    */
+    getEnrollmentStatus(status_id: string, access_token?: string, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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',
+     *   }
+     * }
+     * cidaasVerificationService.enrollVerification(fidoPayload)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    enrollVerification(options: EnrollVerificationRequest): Promise<any>;
+    /**
+     * to see details of configured verification type, call **checkVerificationTypeConfigured()**.
+     * @example
+     * ```js
+     * cidaasVerificationService.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
+     * });
+     * ```
+     */
+    checkVerificationTypeConfigured(options: CheckVerificationTypeConfiguredRequest): Promise<any>;
+    /**
+     * 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 options = {
+     *   request_id: 'your request id',
+     *   usage_type: 'PASSWORDLESS_AUTHENTICATION',
+     *   type: 'email'
+     *   email: 'your email'
+     *  }
+     * }
+     *
+     * cidaasVerificationService.initiateMFA(options)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    initiateMFA(options: InitiateMFARequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * 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
+     * cidaasVerificationService.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
+     * });
+     * ```
+     */
+    authenticateMFA(options: AuthenticateMFARequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * to initiate verification process, call **initiateVerification**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/odmtzu2e53f5k-initiate-verification-enrollment for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   mobile_number: 'your mobile number',
+     *  }
+     * }
+     * const trackId = 'your track id'
+     * const method = 'email'
+     *
+     * cidaasVerificationService.initiateVerification(options, trackId, method)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    initiateVerification(options: InitiateVerificationRequest, trackId: string, method: string): Promise<any>;
+    /**
+     * to finish configuring verification process, call **configureVerification**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/vurqjgv46yyid-initiate-verification-setup-authenticate for more details.
+     * @example
+     * ```js
+     * const options = {
+     *   exchange_id: 'your exchange id';
+     *	 sub: 'your sub;
+     *	 pass_code: 'your pass code';
+     *  }
+     * }
+     * const method = 'email'
+     *
+     * cidaasVerificationService.initiateVerification(options, method)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    configureVerification(options: ConfigureVerificationRequest, method: string): Promise<any>;
+    /**
+     * to configure friendly name, call **configureFriendlyName**
+     * Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/f0i458vm5zo6z-add-a-friendly-name for more details.
+     * @example
+     * ```js
+     * const options = {
+     *	 sub: 'your sub;
+     *	 friendly_name: 'your friendly name';
+     *  }
+     * }
+     * const trackId = 'your track id'
+     * const method = 'email'
+     *
+     * cidaasVerificationService.configureFriendlyName(options, trackId, method)
+     * .then(function (response) {
+     *   // type your code here
+     * })
+     * .catch(function (ex) {
+     *   // your failure code here
+     * });
+     * ```
+     */
+    configureFriendlyName(options: ConfigureFriendlyNameRequest, trackId: string, method: string): Promise<any>;
+}