@emilgroup/insurance-sdk-node 1.2.0 → 1.4.0

package/api/leads-api.ts

@@ -5,7 +5,7 @@
  * 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
@@ -23,7 +23,15 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 // @ts-ignore
 import { CreateLeadRequestDto } from '../models';
 // @ts-ignore
+import { CreateLeadResponseClass } from '../models';
+// @ts-ignore
+import { GetLeadResponseClass } from '../models';
+// @ts-ignore
+import { ListLeadsResponseClass } from '../models';
+// @ts-ignore
 import { UpdateLeadRequestDto } from '../models';
+// @ts-ignore
+import { UpdateLeadResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -124,6 +132,77 @@ export const LeadsApiAxiosParamCreator = function (configuration?: Configuration
 
 
     
+            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 you have previously created. The lead are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List lead
+         * @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=1,      your subsequent call can include pageToken=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=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}
+         */
+        listLeads: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/insuranceservice/v1/leads`;
+            // 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};
@@ -202,7 +281,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createLead(createLeadRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -215,10 +294,27 @@ export const LeadsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getLead(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async getLead(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getLead(code, expand, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Returns a list of lead you have previously created. The lead are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List lead
+         * @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 listLeads(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listLeads(authorization, pageSize, pageToken, filter, search, order, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
          * @summary Update the lead
@@ -228,7 +324,7 @@ export const LeadsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLeadResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.updateLead(code, updateLeadRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -250,7 +346,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
+        createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadResponseClass> {
             return localVarFp.createLead(createLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
@@ -262,9 +358,25 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getLead(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<object> {
+        getLead(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetLeadResponseClass> {
             return localVarFp.getLead(code, expand, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns a list of lead you have previously created. The lead are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List lead
+         * @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}
+         */
+        listLeads(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListLeadsResponseClass> {
+            return localVarFp.listLeads(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        },
         /**
          * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
          * @summary Update the lead
@@ -274,7 +386,7 @@ export const LeadsApiFactory = function (configuration?: Configuration, basePath
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
+        updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLeadResponseClass> {
             return localVarFp.updateLead(code, updateLeadRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
     };
@@ -329,6 +441,62 @@ export interface LeadsApiGetLeadRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for listLeads operation in LeadsApi.
+ * @export
+ * @interface LeadsApiListLeadsRequest
+ */
+export interface LeadsApiListLeadsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiListLeads
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof LeadsApiListLeads
+     */
+    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 LeadsApiListLeads
+     */
+    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 LeadsApiListLeads
+     */
+    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 LeadsApiListLeads
+     */
+    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 LeadsApiListLeads
+     */
+    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 LeadsApiListLeads
+     */
+    readonly expand?: any
+}
+
 /**
  * Request parameters for updateLead operation in LeadsApi.
  * @export
@@ -388,6 +556,18 @@ export class LeadsApi extends BaseAPI {
         return LeadsApiFp(this.configuration).getLead(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Returns a list of lead you have previously created. The lead are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List lead
+     * @param {LeadsApiListLeadsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    public listLeads(requestParameters: LeadsApiListLeadsRequest = {}, options?: AxiosRequestConfig) {
+        return LeadsApiFp(this.configuration).listLeads(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the lead