@emilgroup/customer-sdk-node 1.1.1 → 1.3.0

package/.openapi-generator/FILES

@@ -30,6 +30,7 @@ models/policy-premium-class.ts
 models/policy-premium-item-class.ts
 models/policy-version-class.ts
 models/refresh-token-dto.ts
+models/request-policy-update-response-class.ts
 models/reset-password-by-customer-request-dto.ts
 models/respond-to-auth-challenge-class.ts
 models/respond-to-auth-challenge-request-dto.ts

package/README.md

@@ -17,29 +17,46 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/customer-sdk-node@1.1.1 --save
+npm install @emilgroup/customer-sdk-node@1.3.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/customer-sdk-node@1.1.1
+yarn add @emilgroup/customer-sdk-node@1.3.0
 ```
 
 And then you can import `CustomersApi`.
 
 ```ts
-import { CustomersApi } from '@emilgroup/customer-sdk'
+import { CustomersApi } from '@emilgroup/customer-sdk-node'
 
 const customersApi = new CustomersApi();
 ```
+## Credentials
 
-To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `CustomersApi`:
+To use authentication protected endpoints, you have to first authorize. To do so, the easiest way is to provide a configuration file under `~/.emil/credentials` with the following content:
+
+```shell
+emil_username=XXXXX@XXXX.XXX
+emil_password=XXXXXXXXXXXXXX
+```
+
+It is also possible to provide environment variables instead:
+
+```shell
+export EMIL_USERNAME=XXXXX@XXXX.XXX
+export EMIL_PASSWORD=XXXXXXXXXXXXXX
+```
+
+## Example
+
+Here is a basic functionning example:
 
 ```ts
 async function listCustomers(): Promise<Void> {
     try {
         const customersApi = new CustomersApi();
 
-        await customersApi.authorize('username', 'password');
+        await customersApi.initialize(); // should be called only once per Api.
 
         const { data: { items } } = await customersApi.listCustomers();
 

package/api/customers-api.ts

@@ -45,6 +45,8 @@ import { ListPoliciesResponseClass } from '../models';
 // @ts-ignore
 import { RefreshTokenDto } from '../models';
 // @ts-ignore
+import { RequestPolicyUpdateResponseClass } from '../models';
+// @ts-ignore
 import { ResetPasswordByCustomerRequestDto } from '../models';
 // @ts-ignore
 import { RespondToAuthChallengeClass } from '../models';
@@ -228,7 +230,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
         },
         /**
          * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-         * @summary Invite by customer
+         * @summary Invite a customer by self
          * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
          * @param {*} [options] Override http request option.
@@ -271,7 +273,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
         },
         /**
          * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-         * @summary Invite by tenant
+         * @summary Invite a customer by tenant
          * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
          * @param {*} [options] Override http request option.
@@ -497,6 +499,81 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Request to update an existing policy by customer
+         * @summary Request policy update by customer
+         * @param {string} policyCode The policy code
+         * @param {string} customerCode The customer code or \"me\" for the currently logged in customer
+         * @param {string} code Policy code
+         * @param {Array<string>} policyObjects Policy objects
+         * @param {string} from Update from
+         * @param {string} [to] Update to
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        requestPolicyUpdate: async (policyCode: string, customerCode: string, code: string, policyObjects: Array<string>, from: string, to?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'policyCode' is not null or undefined
+            assertParamExists('requestPolicyUpdate', 'policyCode', policyCode)
+            // verify required parameter 'customerCode' is not null or undefined
+            assertParamExists('requestPolicyUpdate', 'customerCode', customerCode)
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('requestPolicyUpdate', 'code', code)
+            // verify required parameter 'policyObjects' is not null or undefined
+            assertParamExists('requestPolicyUpdate', 'policyObjects', policyObjects)
+            // verify required parameter 'from' is not null or undefined
+            assertParamExists('requestPolicyUpdate', 'from', from)
+            const localVarPath = `/v1/customers/{customerCode}/policies/{policyCode}/request-update`
+                .replace(`{${"policyCode"}}`, encodeURIComponent(String(policyCode)))
+                .replace(`{${"customerCode"}}`, encodeURIComponent(String(customerCode)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (code !== undefined) {
+                localVarQueryParameter['code'] = code;
+            }
+
+            if (policyObjects) {
+                localVarQueryParameter['policyObjects'] = policyObjects;
+            }
+
+            if (from !== undefined) {
+                localVarQueryParameter['from'] = (from as any instanceof Date) ?
+                    (from as any).toISOString() :
+                    from;
+            }
+
+            if (to !== undefined) {
+                localVarQueryParameter['to'] = (to as any instanceof Date) ?
+                    (to as any).toISOString() :
+                    to;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Change customer\'s password using the token provided by the reset password endpoint.
          * @summary Change password by customer
@@ -710,7 +787,7 @@ export const CustomersApiFp = function(configuration?: Configuration) {
         },
         /**
          * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-         * @summary Invite by customer
+         * @summary Invite a customer by self
          * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken
          * @param {*} [options] Override http request option.
@@ -722,7 +799,7 @@ export const CustomersApiFp = function(configuration?: Configuration) {
         },
         /**
          * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-         * @summary Invite by tenant
+         * @summary Invite a customer by tenant
          * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken
          * @param {*} [options] Override http request option.
@@ -780,6 +857,23 @@ export const CustomersApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.refreshToken(refreshTokenDto, cookie, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Request to update an existing policy by customer
+         * @summary Request policy update by customer
+         * @param {string} policyCode The policy code
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
+         * @param {string} code Policy code
+         * @param {Array<string>} policyObjects Policy objects
+         * @param {string} from Update from
+         * @param {string} [to] Update to
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async requestPolicyUpdate(policyCode: string, customerCode: string, code: string, policyObjects: Array<string>, from: string, to?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestPolicyUpdateResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.requestPolicyUpdate(policyCode, customerCode, code, policyObjects, from, to, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Change customer\'s password using the token provided by the reset password endpoint.
          * @summary Change password by customer
@@ -879,7 +973,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
         },
         /**
          * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-         * @summary Invite by customer
+         * @summary Invite a customer by self
          * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken
          * @param {*} [options] Override http request option.
@@ -890,7 +984,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
         },
         /**
          * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-         * @summary Invite by tenant
+         * @summary Invite a customer by tenant
          * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto 
          * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken
          * @param {*} [options] Override http request option.
@@ -944,6 +1038,22 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
         refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: any): AxiosPromise<void> {
             return localVarFp.refreshToken(refreshTokenDto, cookie, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Request to update an existing policy by customer
+         * @summary Request policy update by customer
+         * @param {string} policyCode The policy code
+         * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
+         * @param {string} code Policy code
+         * @param {Array<string>} policyObjects Policy objects
+         * @param {string} from Update from
+         * @param {string} [to] Update to
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        requestPolicyUpdate(policyCode: string, customerCode: string, code: string, policyObjects: Array<string>, from: string, to?: string, authorization?: string, options?: any): AxiosPromise<RequestPolicyUpdateResponseClass> {
+            return localVarFp.requestPolicyUpdate(policyCode, customerCode, code, policyObjects, from, to, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * Change customer\'s password using the token provided by the reset password endpoint.
          * @summary Change password by customer
@@ -1253,6 +1363,62 @@ export interface CustomersApiRefreshTokenRequest {
     readonly cookie?: string
 }
 
+/**
+ * Request parameters for requestPolicyUpdate operation in CustomersApi.
+ * @export
+ * @interface CustomersApiRequestPolicyUpdateRequest
+ */
+export interface CustomersApiRequestPolicyUpdateRequest {
+    /**
+     * The policy code
+     * @type {string}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly policyCode: string
+
+    /**
+     * The customer code or \&quot;me\&quot; for the currently logged in customer
+     * @type {string}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly customerCode: string
+
+    /**
+     * Policy code
+     * @type {string}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly code: string
+
+    /**
+     * Policy objects
+     * @type {Array<string>}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly policyObjects: Array<string>
+
+    /**
+     * Update from
+     * @type {string}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly from: string
+
+    /**
+     * Update to
+     * @type {string}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly to?: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CustomersApiRequestPolicyUpdate
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for resetPassword operation in CustomersApi.
  * @export
@@ -1366,7 +1532,7 @@ export class CustomersApi extends BaseAPI {
 
     /**
      * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-     * @summary Invite by customer
+     * @summary Invite a customer by self
      * @param {CustomersApiInviteByCustomerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1378,7 +1544,7 @@ export class CustomersApi extends BaseAPI {
 
     /**
      * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
-     * @summary Invite by tenant
+     * @summary Invite a customer by tenant
      * @param {CustomersApiInviteByTenantRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1424,6 +1590,18 @@ export class CustomersApi extends BaseAPI {
         return CustomersApiFp(this.configuration).refreshToken(requestParameters.refreshTokenDto, requestParameters.cookie, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Request to update an existing policy by customer
+     * @summary Request policy update by customer
+     * @param {CustomersApiRequestPolicyUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomersApi
+     */
+    public requestPolicyUpdate(requestParameters: CustomersApiRequestPolicyUpdateRequest, options?: AxiosRequestConfig) {
+        return CustomersApiFp(this.configuration).requestPolicyUpdate(requestParameters.policyCode, requestParameters.customerCode, requestParameters.code, requestParameters.policyObjects, requestParameters.from, requestParameters.to, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Change customer\'s password using the token provided by the reset password endpoint.
      * @summary Change password by customer

package/base.ts

@@ -17,6 +17,7 @@ import { Configuration } from "./configuration";
 // Some imports not used depending on template conditions
 // @ts-ignore
 import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import { InitiateAuthResponseClass, RespondToAuthChallengeClass, RespondToAuthChallengeRequestDto } from "./models";
 import * as fs from 'fs';
 import * as path from 'path';
 import * as os from 'os';
@@ -69,6 +70,7 @@ export class BaseAPI {
     protected configuration: Configuration | undefined;
     private username?: string;
     private password?: string;
+    private isCustomerToken = false;
 
     constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         if (configuration) {
@@ -83,35 +85,169 @@ export class BaseAPI {
         this.attachInterceptor(axios);
     }
 
+    async initialize(env: Environment = Environment.Production) {
+        this.configuration.basePath = env;
+
+        await this.loadCredentials();
+
+        if (this.username) {
+            await this.authorize(this.username, this.password);
+            this.password = null; // to avoid keeping password loaded in memory.
+        }
+    }
+
+    private async loadCredentials() {
+        try {
+            await this.readConfigFile();
+        } catch (error) {
+            console.warn(`No credentials file found. Check that ${filePath} exists.`);
+        }
+
+        this.readEnvVariables();
+
+        if (!this.username) {
+            console.info(`No credentials found in credentials file or environment variables. Either provide some or use 
+                authorize() function.`);
+        }
+    }
+
+    private async readConfigFile() {
+        const file = await fs.promises.readFile(filePath, 'utf-8');
+
+        const lines = file.split(os.EOL)
+            .filter(Boolean);
+
+        lines.forEach((line: string) => {
+            if (line.startsWith(KEY_USERNAME)) {
+                this.username = line.length > KEY_USERNAME.length + 1 ? line.substring(KEY_USERNAME.length + 1) : '';
+            } else if (line.startsWith(KEY_PASSWORD)) {
+                this.password = line.length > KEY_PASSWORD.length + 1 ? line.substring(KEY_PASSWORD.length + 1) : '';
+            }
+        });
+    }
+
+    private readEnvVariables(): boolean {
+        if (process.env.EMIL_USERNAME) {
+            this.username = process.env.EMIL_USERNAME;
+            this.password = process.env.EMIL_PASSWORD || '';
+
+            return true;
+        }
+
+        return false;
+    }
+
     selectEnvironment(env: Environment) {
         this.configuration.basePath = env;
     }
 
-    async authorize(username: string, password: string, tenantSlug: string): Promise<void> {
+    async authorize(username: string, password: string): Promise<void> {
         const options: AxiosRequestConfig = {
             method: 'POST',
-            url: `${this.configuration.basePath}/v1/customers/login`,
-            headers: {'Content-Type': 'application/json'},
+            url: `${this.configuration.basePath}/authservice/v1/login`,
+            headers: { 'Content-Type': 'application/json' },
             data: {
-                username, 
+                username,
                 password,
-                tenantSlug,
             },
             withCredentials: true,
         };
 
         const response = await globalAxios.request<LoginClass>(options);
-        
+
         const { data: { accessToken } } = response;
         const refreshToken = this.extractRefreshToken(response)
 
         this.configuration.username = username;
-        this.configuration.tenantSlug = tenantSlug;
         this.configuration.accessToken = `Bearer ${accessToken}`;
         this.configuration.refreshToken = refreshToken;
     }
 
-    async refreshTokenInternal(): Promise<string> {
+    async initiateAuthorization(username: string, password: string, tenantSlug: string): 
+        Promise<AxiosResponse<InitiateAuthResponseClass>> {
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/v1/customers/auth/initiate`,
+            headers: { 'Content-Type': 'application/json' },
+            data: {
+                authFlow: "USER_PASSWORD_AUTH",
+                authParameters: {
+                    "USERNAME": username,
+                    "PASSWORD": password,
+                }, 
+                tenantSlug,
+            },
+            withCredentials: true,
+        };
+
+        const response = await globalAxios.request<InitiateAuthResponseClass>(options);
+
+        if (response.data.authenticationResult) {
+            const { accessToken } = response.data.authenticationResult;
+            const refreshToken = this.extractRefreshToken(response)
+    
+            this.configuration.username = username;
+            this.configuration.tenantSlug = tenantSlug;
+            this.configuration.accessToken = `Bearer ${accessToken}`;
+            this.configuration.refreshToken = refreshToken;
+
+            this.isCustomerToken = true;
+        }
+
+        return response;
+    }
+
+    async respondToAuthorizationChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto): 
+        Promise<AxiosResponse<RespondToAuthChallengeClass>> {
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/v1/customers/auth/respond`,
+            headers: { 'Content-Type': 'application/json' },
+            data: {
+                ...respondToAuthChallengeRequestDto,
+            },
+            withCredentials: true,
+        };
+
+        const response = await globalAxios.request<RespondToAuthChallengeClass>(options);
+
+        if (response.data.authenticationResult) {
+            const { accessToken } = response.data.authenticationResult;
+            const refreshToken = this.extractRefreshToken(response)
+    
+            this.configuration.accessToken = `Bearer ${accessToken}`;
+            this.configuration.refreshToken = refreshToken;
+
+            this.isCustomerToken = true;
+        }
+
+        return response;
+    }
+
+    async refreshTokenTenant(): Promise<string> {
+        const { username, refreshToken } = this.configuration;
+
+        if (!username || !refreshToken) {
+            return '';
+        }
+
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/refresh-token`,
+            headers: {
+                'Content-Type': 'application/json',
+                Cookie: refreshToken,
+            },
+            data: { username: username },
+            withCredentials: true,
+        };
+
+        const { data: { accessToken } } = await globalAxios.request<LoginClass>(options);
+
+        return accessToken;
+    }
+
+    async refreshTokenCustomer(): Promise<string> {
         const { username, refreshToken, tenantSlug } = this.configuration;
 
         if (!username || !refreshToken) {
@@ -156,7 +292,12 @@ export class BaseAPI {
                     if (err.response.status === 401 && !originalConfig._retry) {
                         originalConfig._retry = true;
                         try {
-                            const tokenString = await this.refreshTokenInternal();
+                            let tokenString: string;
+                            if (this.isCustomerToken) {
+                                tokenString = await this.refreshTokenCustomer();
+                            } else {
+                                tokenString = await this.refreshTokenTenant();
+                            }
                             const accessToken = `Bearer ${tokenString}`;
 
                             const localVarHeaderParameter = {} as any;