cidaas-javascript-sdk 4.2.4 → 4.3.1

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

@@ -1,5 +1,14 @@
-import { OidcSettings, LoginRedirectOptions, LogoutRedirectOptions, PopupSignInOptions, PopupSignOutOptions, SilentSignInOptions, LoginRequestOptions, User, LogoutResponse } from '../authentication';
-import { AccessTokenRequest, TokenIntrospectionEntity, UserEntity, ResetPasswordEntity, IConfiguredListRequestEntity, IInitVerificationAuthenticationRequestEntity, FindUserEntity, IUserEntity, IEnrollVerificationSetupRequestEntity, IUserLinkEntity, ChangePasswordEntity, IConsentAcceptEntity, IAuthVerificationAuthenticationRequestEntity, LoginFormRequestEntity, AccountVerificationRequestEntity, ValidateResetPasswordEntity, AcceptResetPasswordEntity, PhysicalVerificationLoginRequest, IChangePasswordEntity, IUserActivityPayloadEntity } from "./Entities";
+import { GetAccessTokenRequest, RenewTokenRequest, TokenIntrospectionRequest } from '../token-service/TokenService.model';
+import { AcceptClaimConsentRequest, AcceptConsentRequest, AcceptScopeConsentRequest, GetConsentDetailsRequest, GetConsentVersionDetailsRequest, RevokeClaimConsentRequest } from '../consent-service/ConsentService.model';
+import { FirstTimeChangePasswordRequest, LoginAfterRegisterRequest, LoginWithCredentialsRequest, MfaContinueRequest, PasswordlessLoginRequest, ProgressiveRegistrationHeader, SocialProviderPathParameter, SocialProviderQueryParameter } from '../login-service/LoginService.model';
+import { LoginPrecheckRequest } from '../common/Common.model';
+import { CidaasUser } from '../common/User.model';
+import { ChangePasswordRequest, CompleteLinkAccountRequest, DeduplicationLoginRequest, DeleteUserAccountRequest, GetDeduplicationDetailsRequest, GetInviteUserDetailsRequest, GetUserProfileRequest, HandleResetPasswordRequest, InitiateLinkAccountRequest, InitiateResetPasswordRequest, RegisterDeduplicationRequest, RegisterRequest, ResetPasswordRequest, UserCheckExistsRequest, getCommunicationStatusRequest } from '../user-service/UserService.model';
+import { HTTPRequestHeader } from "../common/Common.model";
+import { User } from "oidc-client-ts";
+import { OidcSettings, LoginRedirectOptions, PopupSignInOptions, SilentSignInOptions, LogoutRedirectOptions, PopupSignOutOptions, LogoutResponse, LoginRequestOptions } from "../authentication/Authentication.model";
+import { AuthenticateMFARequest, CancelMFARequest, CheckVerificationTypeConfiguredRequest, ConfigureFriendlyNameRequest, ConfigureVerificationRequest, EnrollVerificationRequest, GetMFAListRequest, InitiateAccountVerificationRequest, InitiateEnrollmentRequest, InitiateMFARequest, InitiateVerificationRequest, VerifyAccountRequest } from "../verification-service/VerificationService.model";
+import { DeleteDeviceRequest, GetClientInfoRequest, GetRegistrationSetupRequest, GetUserActivitiesRequest, LogoutUserRequest, UpdateProfileImageRequest, UserActionOnEnrollmentRequest, GetRequestIdRequest } from "./webauth.model";
 export declare const createPreloginWebauth: (authority: string) => WebAuth;
 export declare class WebAuth {
     constructor(settings: OidcSettings);
@@ -105,14 +114,19 @@ export declare class WebAuth {
      * 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) {
+     * const option: GetRequestIdRequest = {
+     *   'client_id': 'your client id',
+     *   'redirect_uri': 'your redirect url',
+     *   'scope': 'your scopes',
+     * }
+     * cidaas.getRequestId(option).then(function (response) {
      *   // the response will give you request id.
      * }).catch(function(ex) {
      *   // your failure code here
      * });
      * ```
      */
-    getRequestId(): Promise<unknown>;
+    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
@@ -124,7 +138,7 @@ export declare class WebAuth {
      * });
      * ```
      */
-    getTenantInfo(): Promise<unknown>;
+    getTenantInfo(): Promise<any>;
     /**
      * 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.
@@ -135,9 +149,7 @@ export declare class WebAuth {
      * });
      * ```
      */
-    logoutUser(options: {
-        access_token: string;
-    }): void;
+    logoutUser(options: LogoutUserRequest): void;
     /**
      * 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.
@@ -152,15 +164,13 @@ export declare class WebAuth {
      * });
      * ```
      */
-    getClientInfo(options: {
-        requestId: string;
-    }): Promise<unknown>;
+    getClientInfo(options: GetClientInfoRequest): Promise<any>;
     /**
      * 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 options = null; // the payload is deprecated and will be removed in the next major release
      * const accessToken = 'your access token';
      * cidaas.getDevicesInfo(options, accessToken).then(function (resp) {
      *   // the response will give you devices informations.
@@ -169,7 +179,7 @@ export declare class WebAuth {
      * });
      * ```
      */
-    getDevicesInfo(options: any, accessToken: string): Promise<unknown>;
+    getDevicesInfo(options: void, accessToken: string): Promise<any>;
     /**
      * 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.
@@ -186,10 +196,7 @@ export declare class WebAuth {
      * });
      * ```
      */
-    deleteDevice(options: {
-        device_id: string;
-        userAgent?: string;
-    }, accessToken: string): Promise<unknown>;
+    deleteDevice(options: DeleteDeviceRequest, accessToken: string): Promise<any>;
     /**
      * 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.
@@ -205,10 +212,7 @@ export declare class WebAuth {
      * });
      * ```
      */
-    getRegistrationSetup(options: {
-        acceptlanguage?: string;
-        requestId: string;
-    }): Promise<unknown>;
+    getRegistrationSetup(options: GetRegistrationSetupRequest): Promise<any>;
     /**
      * 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.
@@ -221,268 +225,211 @@ export declare class WebAuth {
      * });
      * ```
      */
-    createDeviceInfo(): Promise<unknown>;
+    createDeviceInfo(): Promise<any>;
     /**
      * get the user profile information
      * @param options
      * @returns
      */
-    getUserProfile(options: {
-        access_token: string;
-    }): Promise<unknown>;
+    getUserProfile(options: GetUserProfileRequest): Promise<any>;
     /**
      * renew token using refresh token
      * @param options
      * @returns
      */
-    renewToken(options: AccessTokenRequest): Promise<unknown>;
+    renewToken(options: RenewTokenRequest): Promise<any>;
     /**
      * get access token from code
      * @param options
      * @returns
      */
-    getAccessToken(options: AccessTokenRequest): Promise<unknown>;
+    getAccessToken(options: GetAccessTokenRequest): Promise<any>;
     /**
      * validate access token
      * @param options
      * @returns
      */
-    validateAccessToken(options: TokenIntrospectionEntity): Promise<unknown>;
+    validateAccessToken(options: TokenIntrospectionRequest): Promise<any>;
     /**
      * login with username and password
      * @param options
      */
-    loginWithCredentials(options: LoginFormRequestEntity): void;
+    loginWithCredentials(options: LoginWithCredentialsRequest): void;
     /**
      * login with social
      * @param options
      * @param queryParams
      */
-    loginWithSocial(options: {
-        provider: string;
-        requestId: string;
-    }, queryParams: {
-        dc: string;
-        device_fp: string;
-    }): void;
+    loginWithSocial(options: SocialProviderPathParameter, queryParams?: SocialProviderQueryParameter): void;
     /**
      * register with social
      * @param options
      * @param queryParams
      */
-    registerWithSocial(options: {
-        provider: string;
-        requestId: string;
-    }, queryParams: {
-        dc: string;
-        device_fp: string;
-    }): void;
+    registerWithSocial(options: SocialProviderPathParameter, queryParams?: SocialProviderQueryParameter): void;
     /**
      * register user
      * @param options
      * @param headers
      * @returns
      */
-    register(options: UserEntity, headers: {
-        requestId: string;
-        captcha?: string;
-        acceptlanguage?: string;
-        bot_captcha_response?: string;
-        trackId?: string;
-    }): Promise<unknown>;
+    register(options: RegisterRequest, headers: HTTPRequestHeader): Promise<any>;
     /**
      * get invite info
      * @param options
+     * @param headers
      * @returns
      */
-    getInviteUserDetails(options: {
-        invite_id: string;
-        callLatestAPI?: boolean;
-    }): Promise<unknown>;
+    getInviteUserDetails(options: GetInviteUserDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * get Communication status
      * @param options
+     * @param headers
      * @returns
      */
-    getCommunicationStatus(options: {
-        sub: string;
-    }, headers: {
-        requestId: string;
-    }): Promise<unknown>;
+    getCommunicationStatus(options: getCommunicationStatusRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * initiate verification
      * @param options
      * @returns
      */
-    initiateAccountVerification(options: AccountVerificationRequestEntity): void;
+    initiateAccountVerification(options: InitiateAccountVerificationRequest): void;
     /**
      * verify account
      * @param options
+     * @param headers
      * @returns
      */
-    verifyAccount(options: {
-        accvid: string;
-        code: string;
-    }): Promise<unknown>;
+    verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * initiate reset password
      * @param options
+     * @param headers
      * @returns
      */
-    initiateResetPassword(options: ResetPasswordEntity): Promise<unknown>;
+    initiateResetPassword(options: InitiateResetPasswordRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * handle reset password
      * @param options
+     * @param handleResponseAsJson
+     * @param headers
      */
-    handleResetPassword(options: ValidateResetPasswordEntity): Promise<unknown>;
+    handleResetPassword(options: HandleResetPasswordRequest, handleResponseAsJson?: boolean, headers?: HTTPRequestHeader): Promise<any>;
     /**
     * reset password
     * @param options
+    * @param handleResponseAsJson
+    * @param headers
     */
-    resetPassword(options: AcceptResetPasswordEntity): Promise<unknown>;
+    resetPassword(options: ResetPasswordRequest, handleResponseAsJson?: boolean, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * get mfa list
      * @param options
+     * @param headers
      * @returns
      */
-    getMFAList(options: IConfiguredListRequestEntity): Promise<unknown>;
+    getMFAList(options: GetMFAListRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * cancel mfa
      * @param options
+     * @param headers
      * @returns
      */
-    cancelMFA(options: {
-        exchange_id: string;
-        reason: string;
-        type: string;
-    }): Promise<unknown>;
+    cancelMFA(options: CancelMFARequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * passwordless login
      * @param options
      */
-    passwordlessLogin(options: PhysicalVerificationLoginRequest): void;
+    passwordlessLogin(options: PasswordlessLoginRequest): void;
     /**
      * get user consent details
      * @param options
      * @returns
      */
-    getConsentDetails(options: {
-        consent_id: string;
-        consent_version_id: string;
-        sub: string;
-    }): Promise<unknown>;
+    getConsentDetails(options: GetConsentDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * accept consent
      * @param options
+     * @param headers
      * @returns
      */
-    acceptConsent(options: IConsentAcceptEntity): Promise<unknown>;
+    acceptConsent(options: AcceptConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * get scope consent details
      * @param options
+     * @param headers
      * @returns
      */
-    loginPrecheck(options: {
-        track_id: string;
-        locale: string;
-    }): Promise<unknown>;
+    loginPrecheck(options: LoginPrecheckRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * get scope consent version details
      * @param options
+     * @param headers
      * @returns
      */
-    getConsentVersionDetails(options: {
-        consentid: string;
-        locale: string;
-        access_token: string;
-    }): Promise<unknown>;
+    getConsentVersionDetails(options: GetConsentVersionDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * accept scope Consent
      * @param options
+     * @param headers
      * @returns
      */
-    acceptScopeConsent(options: {
-        client_id: string;
-        sub: string;
-        scopes: string[];
-    }): Promise<unknown>;
+    acceptScopeConsent(options: AcceptScopeConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * accept claim Consent
      * @param options
+     * @param headers
      * @returns
      */
-    acceptClaimConsent(options: {
-        client_id: string;
-        sub: string;
-        accepted_claims: string[];
-    }): Promise<unknown>;
+    acceptClaimConsent(options: AcceptClaimConsentRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * revoke claim Consent
      * @param options
      * @returns
      */
-    revokeClaimConsent(options: {
-        client_id: string;
-        sub: string;
-        revoked_claims: string[];
-    }): Promise<unknown>;
+    revokeClaimConsent(options: RevokeClaimConsentRequest): Promise<any>;
     /**
      * get Deduplication details
      * @param options
+     * @param headers
      * @returns
      */
-    getDeduplicationDetails(options: {
-        trackId: string;
-    }): Promise<unknown>;
+    getDeduplicationDetails(options: GetDeduplicationDetailsRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * deduplication login
      * @param options
      */
-    deduplicationLogin(options: {
-        trackId: string;
-        requestId: string;
-        sub: string;
-    }): void;
+    deduplicationLogin(options: DeduplicationLoginRequest): void;
     /**
      * register Deduplication
      * @param options
+     * @param headers
      * @returns
      */
-    registerDeduplication(options: {
-        trackId: string;
-    }): Promise<unknown>;
+    registerDeduplication(options: RegisterDeduplicationRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
-     * accepts any as the request
      * consent continue login
      * @param options
      */
-    consentContinue(options: {
-        client_id: string;
-        consent_refs: string[];
-        sub: string;
-        scopes: string[];
-        matcher: any;
-        track_id: string;
-    }): void;
+    consentContinue(options: LoginPrecheckRequest): void;
     /**
      * mfa continue login
+     * options: PhysicalVerificationLoginRequest is not needed anymore. It is now DEPRECATED and will be removed in the next major release
      * @param options
      */
-    mfaContinue(options: PhysicalVerificationLoginRequest & {
-        track_id: string;
-    }): void;
+    mfaContinue(options: MfaContinueRequest): void;
     /**
      * change password continue
      * @param options
      */
-    firstTimeChangePassword(options: IChangePasswordEntity): void;
+    firstTimeChangePassword(options: FirstTimeChangePasswordRequest): void;
     /**
      * change password
      * @param options
      * @param access_token
      * @returns
      */
-    changePassword(options: ChangePasswordEntity, access_token: string): Promise<unknown>;
+    changePassword(options: ChangePasswordRequest, access_token: string): Promise<any>;
     /**
      * update profile
      * @param options
@@ -490,7 +437,7 @@ export declare class WebAuth {
      * @param sub
      * @returns
      */
-    updateProfile(options: UserEntity, access_token: string, sub: string): Promise<unknown>;
+    updateProfile(options: CidaasUser, access_token: string, sub: string): Promise<any>;
     /**
      * 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.
@@ -511,43 +458,53 @@ export declare class WebAuth {
      * });
      * ```
      */
-    getUserActivities(options: IUserActivityPayloadEntity, accessToken: string): Promise<unknown>;
+    getUserActivities(options: GetUserActivitiesRequest, accessToken: string): Promise<any>;
+    /**
+     * To run predefined action after enrollment, call userActionOnEnrollment()
+     * @param options
+     * @param trackId
+     * @example
+     * ```js
+     * const options = {
+     *   action: 'predefined action'
+     * };
+     * cidaas.userActionOnEnrollment(options, 'trackId');
+     */
+    userActionOnEnrollment(options: UserActionOnEnrollmentRequest, trackId: string): Promise<any>;
     /**
      * @param access_token
+     * @param headers
      * @returns
      */
-    getAllVerificationList(access_token: string): Promise<unknown>;
+    getAllVerificationList(access_token: string, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * initiate link accoount
      * @param options
      * @param access_token
      * @returns
      */
-    initiateLinkAccount(options: IUserLinkEntity, access_token: string): Promise<unknown>;
+    initiateLinkAccount(options: InitiateLinkAccountRequest, access_token: string): Promise<any>;
     /**
      * complete link accoount
      * @param options
      * @param access_token
      * @returns
      */
-    completeLinkAccount(options: {
-        code?: string;
-        link_request_id?: string;
-    }, access_token: string): Promise<unknown>;
+    completeLinkAccount(options: CompleteLinkAccountRequest, access_token: string): Promise<any>;
     /**
      * get linked users
      * @param access_token
      * @param sub
      * @returns
      */
-    getLinkedUsers(access_token: string, sub: string): Promise<unknown>;
+    getLinkedUsers(access_token: string, sub: string): Promise<any>;
     /**
      * unlink accoount
      * @param access_token
      * @param identityId
      * @returns
      */
-    unlinkAccount(access_token: string, identityId: string): Promise<unknown>;
+    unlinkAccount(access_token: string, identityId: string): Promise<any>;
     /**
     * To change profile image, call **updateProfileImage()**.
     * @example
@@ -565,56 +522,41 @@ export declare class WebAuth {
     * });
     * ```
     */
-    updateProfileImage(options: {
-        image_key: string;
-        photo: any;
-        filename: string;
-    }, access_token: string): Promise<unknown>;
+    updateProfileImage(options: UpdateProfileImageRequest, access_token: string): Promise<any>;
     /**
      * enrollVerification
      * @param options
      * @returns
      */
-    initiateEnrollment(options: {
-        verification_type: string;
-        deviceInfo?: {
-            deviceId: string;
-            location: {
-                lat: string;
-                lon: string;
-            };
-        };
-    }, accessToken: string): Promise<unknown>;
+    initiateEnrollment(options: InitiateEnrollmentRequest, accessToken: string): Promise<any>;
     /**
      * update the status of notification
      * @param status_id
+     * @param headers
      * @returns
      */
-    getEnrollmentStatus(status_id: string, accessToken: string): Promise<unknown>;
+    getEnrollmentStatus(status_id: string, accessToken: string, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * enrollVerification
      * @param options
      * @returns
      */
-    enrollVerification(options: IEnrollVerificationSetupRequestEntity): Promise<unknown>;
+    enrollVerification(options: EnrollVerificationRequest): Promise<any>;
     /**
      * checkVerificationTypeConfigured
      * @param options
      * @returns
      */
-    checkVerificationTypeConfigured(options: IConfiguredListRequestEntity): Promise<unknown>;
+    checkVerificationTypeConfigured(options: CheckVerificationTypeConfiguredRequest): Promise<any>;
     /**
      * deleteUserAccount
      * @param options
      * @returns
      */
-    deleteUserAccount(options: {
-        access_token: string;
-        sub: string;
-    }): Promise<unknown>;
+    deleteUserAccount(options: DeleteUserAccountRequest): Promise<any>;
     /**
      * getMissingFields
-     * @param trackId - required. If only trackId is given, it will get missing fields from cidaas after succesfull registration using default provider
+     * @param trackId - required. If only trackId is given, it will get missing fields from cidaas after succesful registration using default provider
      * @param useSocialProvider - optional. If given, it will get missing fields from social provider after successful registration using social provider
      *
      * @example
@@ -633,32 +575,23 @@ export declare class WebAuth {
      */
     getMissingFields(trackId: string, useSocialProvider?: {
         requestId: string;
-    }): Promise<unknown>;
+    }, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * progressiveRegistration
      * @param options
      * @param headers
      * @returns
      */
-    progressiveRegistration(options: IUserEntity, headers: {
-        requestId: string;
-        trackId: string;
-        acceptlanguage: string;
-    }): Promise<unknown>;
+    progressiveRegistration(options: CidaasUser, headers: ProgressiveRegistrationHeader): Promise<any>;
     /**
      * loginAfterRegister
      * @param options
      */
-    loginAfterRegister(options: {
-        device_id: string;
-        dc?: string;
-        rememberMe: boolean;
-        trackId: string;
-    }): void;
+    loginAfterRegister(options: LoginAfterRegisterRequest): void;
     /**
      * device code flow - initiate
      */
-    initiateDeviceCode(clientId?: string): Promise<unknown>;
+    initiateDeviceCode(clientId?: string): Promise<any>;
     /**
      * device code flow - verify
      * @param code
@@ -667,9 +600,10 @@ export declare class WebAuth {
     /**
      * check if an user exists
      * @param options
+     * @param headers
      * @returns
      */
-    userCheckExists(options: FindUserEntity): Promise<unknown>;
+    userCheckExists(options: UserCheckExistsRequest, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * To set accept language
      * @param acceptLanguage
@@ -678,15 +612,41 @@ export declare class WebAuth {
     /**
      * initiate mfa
      * @param options
+     * @param headers
      * @returns
      */
-    initiateMFA(options: IInitVerificationAuthenticationRequestEntity, accessToken?: string): Promise<unknown>;
+    initiateMFA(options: InitiateMFARequest, accessToken?: string, headers?: HTTPRequestHeader): Promise<any>;
     /**
      * authenticate mfa
      * @param options
+     * @param headers
+     * @returns
+     */
+    authenticateMFA(options: AuthenticateMFARequest, headers?: HTTPRequestHeader): Promise<any>;
+    /**
+     * initiate verification
+     * @param options
+     * @returns
+     */
+    initiateVerification(options: InitiateVerificationRequest, trackId: string, method: string): Promise<any>;
+    /**
+     * configure verification
+     * @param options
+     * @returns
+     */
+    configureVerification(options: ConfigureVerificationRequest, method: string): Promise<any>;
+    /**
+     * configure friendly name
+     * @param options
+     * @returns
+     */
+    configureFriendlyName(options: ConfigureFriendlyNameRequest, trackId: string, method: string): Promise<any>;
+    /**
+     * login as guest
+     * @param requestId
      * @returns
      */
-    authenticateMFA(options: IAuthVerificationAuthenticationRequestEntity): Promise<unknown>;
+    actionGuestLogin(requestId: string): void;
     /**
      * offline token check
      */