@emilgroup/insurance-sdk 1.36.0 → 1.37.0

package/.openapi-generator/FILES

@@ -7,6 +7,7 @@ api/default-api.ts
 api/insured-object-types-api.ts
 api/insured-objects-api.ts
 api/lead-statuses-api.ts
+api/lead-versions-api.ts
 api/leads-api.ts
 api/named-ranges-api.ts
 api/policies-api.ts
@@ -15,6 +16,7 @@ api/product-factors-api.ts
 api/product-fields-api.ts
 api/product-versions-api.ts
 api/products-api.ts
+api/status-transition-rules-api.ts
 base.ts
 common.ts
 configuration.ts
@@ -50,13 +52,16 @@ models/create-product-field-request-dto.ts
 models/create-product-field-response-class.ts
 models/create-product-request-dto.ts
 models/create-product-response-class.ts
+models/create-status-transition-rule-request-dto.ts
+models/create-status-transition-rule-response-class.ts
 models/csv-product-factor-dto.ts
-models/delete-request-dto.ts
 models/delete-response-class.ts
 models/empty-response-class.ts
 models/get-insured-object-response-class.ts
 models/get-lead-response-class.ts
 models/get-lead-status-response-class.ts
+models/get-lead-version-request-dto.ts
+models/get-lead-version-response-class.ts
 models/get-named-range-response-class.ts
 models/get-policy-data-by-date-request-dto.ts
 models/get-policy-request-dto.ts
@@ -74,6 +79,7 @@ models/get-product-request-dto.ts
 models/get-product-response-class.ts
 models/get-product-version-request-dto.ts
 models/get-product-version-response-class.ts
+models/get-status-transition-rule-response-class.ts
 models/grouped-product-factor-class.ts
 models/grouped-product-factor-value-class.ts
 models/grouped-product-factors-response-class.ts
@@ -92,6 +98,7 @@ models/lead-status-class.ts
 models/list-insured-object-types-response-class.ts
 models/list-insured-objects-response-class.ts
 models/list-lead-statuses-response-class.ts
+models/list-lead-versions-response-class.ts
 models/list-leads-response-class.ts
 models/list-named-ranges-response-class.ts
 models/list-policies-response-class.ts
@@ -101,11 +108,14 @@ models/list-product-field-types-response-class.ts
 models/list-product-fields-response-class.ts
 models/list-products-response-class.ts
 models/list-request-dto.ts
+models/list-status-transition-rules-response-class.ts
 models/named-range-class.ts
 models/patch-lead-request-dto.ts
 models/patch-lead-response-class.ts
 models/patch-policy-request-dto.ts
 models/patch-policy-response-class.ts
+models/patch-status-transition-rule-request-dto.ts
+models/patch-status-transition-rule-response-class.ts
 models/policy-class.ts
 models/policy-object-class.ts
 models/policy-object-dto.ts
@@ -131,6 +141,7 @@ models/shared-lead-policy-object-dto.ts
 models/shared-product-field-class.ts
 models/shared-update-named-range-request-dto.ts
 models/shared-update-premium-formula-request-dto.ts
+models/status-transition-rule-class.ts
 models/store-product-factors-request-dto.ts
 models/store-product-factors-response-class.ts
 models/suspend-policy-request-dto.ts
@@ -154,6 +165,8 @@ models/update-product-request-dto.ts
 models/update-product-response-class.ts
 models/update-product-version-request-dto.ts
 models/update-product-version-response-class.ts
+models/update-status-transition-rule-request-dto.ts
+models/update-status-transition-rule-response-class.ts
 models/uploaded-document-dto.ts
 models/validate-product-factors-request-dto.ts
 models/withdraw-policy-response-class.ts

package/README.md

@@ -17,11 +17,11 @@ 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/insurance-sdk@1.36.0 --save
+npm install @emilgroup/insurance-sdk@1.37.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/insurance-sdk@1.36.0
+yarn add @emilgroup/insurance-sdk@1.37.0
 ```
 
 And then you can import `PoliciesApi`.

package/api/lead-versions-api.ts

@@ -0,0 +1,361 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL InsuranceService
+ * The EMIL InsuranceService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { GetLeadVersionResponseClass } from '../models';
+// @ts-ignore
+import { ListLeadVersionsResponseClass } from '../models';
+/**
+ * LeadVersionsApi - axios parameter creator
+ * @export
+ */
+export const LeadVersionsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves the details of the lead version that was previously created. Supply the unique lead version code that was returned when you created it and Emil Api will return the corresponding lead version information.
+         * @summary Retrieve the lead version
+         * @param {string} code 
+         * @param {number} version 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLeadVersion: async (code: string, version: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getLeadVersion', 'code', code)
+            // verify required parameter 'version' is not null or undefined
+            assertParamExists('getLeadVersion', 'version', version)
+            const localVarPath = `/insuranceservice/v1/leads/{code}/versions/{version}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)))
+                .replace(`{${"version"}}`, encodeURIComponent(String(version)));
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            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,
+            };
+        },
+        /**
+         * Returns a list of lead versions you have previously created. The lead versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List lead versions
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+         * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listLeadVersions: async (code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('listLeadVersions', 'code', code)
+            const localVarPath = `/insuranceservice/v1/leads/{code}/versions`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            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,
+            };
+        },
+    }
+};
+
+/**
+ * LeadVersionsApi - functional programming interface
+ * @export
+ */
+export const LeadVersionsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = LeadVersionsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieves the details of the lead version that was previously created. Supply the unique lead version code that was returned when you created it and Emil Api will return the corresponding lead version information.
+         * @summary Retrieve the lead version
+         * @param {string} code 
+         * @param {number} version 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getLeadVersion(code: string, version: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadVersionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getLeadVersion(code, version, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns a list of lead versions you have previously created. The lead versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List lead versions
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+         * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listLeadVersions(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadVersionsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listLeadVersions(code, authorization, pageSize, pageToken, filter, search, order, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * LeadVersionsApi - factory interface
+ * @export
+ */
+export const LeadVersionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = LeadVersionsApiFp(configuration)
+    return {
+        /**
+         * Retrieves the details of the lead version that was previously created. Supply the unique lead version code that was returned when you created it and Emil Api will return the corresponding lead version information.
+         * @summary Retrieve the lead version
+         * @param {string} code 
+         * @param {number} version 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getLeadVersion(code: string, version: number, authorization?: string, options?: any): AxiosPromise<GetLeadVersionResponseClass> {
+            return localVarFp.getLeadVersion(code, version, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a list of lead versions you have previously created. The lead versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List lead versions
+         * @param {string} code 
+         * @param {string} [authorization] Bearer Token
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+         * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+         * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listLeadVersions(code: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListLeadVersionsResponseClass> {
+            return localVarFp.listLeadVersions(code, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getLeadVersion operation in LeadVersionsApi.
+ * @export
+ * @interface LeadVersionsApiGetLeadVersionRequest
+ */
+export interface LeadVersionsApiGetLeadVersionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadVersionsApiGetLeadVersion
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {number}
+     * @memberof LeadVersionsApiGetLeadVersion
+     */
+    readonly version: number
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadVersionsApiGetLeadVersion
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listLeadVersions operation in LeadVersionsApi.
+ * @export
+ * @interface LeadVersionsApiListLeadVersionsRequest
+ */
+export interface LeadVersionsApiListLeadVersionsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly pageSize?: any
+
+    /**
+     * A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {any}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly pageToken?: any
+
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly filter?: any
+
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly search?: any
+
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
+     * @type {any}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly order?: any
+
+    /**
+     * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @type {any}
+     * @memberof LeadVersionsApiListLeadVersions
+     */
+    readonly expand?: any
+}
+
+/**
+ * LeadVersionsApi - object-oriented interface
+ * @export
+ * @class LeadVersionsApi
+ * @extends {BaseAPI}
+ */
+export class LeadVersionsApi extends BaseAPI {
+    /**
+     * Retrieves the details of the lead version that was previously created. Supply the unique lead version code that was returned when you created it and Emil Api will return the corresponding lead version information.
+     * @summary Retrieve the lead version
+     * @param {LeadVersionsApiGetLeadVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadVersionsApi
+     */
+    public getLeadVersion(requestParameters: LeadVersionsApiGetLeadVersionRequest, options?: AxiosRequestConfig) {
+        return LeadVersionsApiFp(this.configuration).getLeadVersion(requestParameters.code, requestParameters.version, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns a list of lead versions you have previously created. The lead versions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List lead versions
+     * @param {LeadVersionsApiListLeadVersionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadVersionsApi
+     */
+    public listLeadVersions(requestParameters: LeadVersionsApiListLeadVersionsRequest, options?: AxiosRequestConfig) {
+        return LeadVersionsApiFp(this.configuration).listLeadVersions(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+}