@emilgroup/insurance-sdk-node 1.36.0 → 1.36.1

package/dist/api/leads-api.d.ts

@@ -0,0 +1,626 @@
+/**
+ * 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 { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateLeadAsyncResponseClass } from '../models';
+import { CreateLeadRequestDto } from '../models';
+import { CreateLeadResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetLeadResponseClass } from '../models';
+import { ListLeadsResponseClass } from '../models';
+import { PatchLeadRequestDto } from '../models';
+import { PatchLeadResponseClass } from '../models';
+import { UpdateLeadRequestDto } from '../models';
+import { UpdateLeadResponseClass } from '../models';
+/**
+ * LeadsApi - axios parameter creator
+ * @export
+ */
+export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+     * @summary Create the lead
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLead: (createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will send the lead to the queue for creation. Should be used when creating multiple leads     at the same time - also called \'batch processing\'.
+     * @summary Create the lead asynchronously
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadAsync: (createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint initiates the creation of a lead, which is the initial step in a comprehensive      workflow responsible for the creation of an account, policy, and banking information.      Unlike the standard lead creation endpoint, this variant ensures that the process waits until the entire workflow      is successfully completed before providing a response.
+     * @summary Create the lead
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadSync: (createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the lead. Supply the unique code that was returned when you created the lead and this will delete it.
+     * @summary Delete the lead
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLead: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+     * @summary Retrieve the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLead: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List leads
+     * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed.    Any parameters not provided will be left unchanged.
+     * @summary Patch the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {PatchLeadRequestDto} patchLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchLead: (code: string, patchLeadRequestDto: PatchLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateLeadRequestDto} updateLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLead: (code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateLeadRequestDto} updateLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLeadSync: (code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * LeadsApi - functional programming interface
+ * @export
+ */
+export declare const LeadsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+     * @summary Create the lead
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadResponseClass>>;
+    /**
+     * This will send the lead to the queue for creation. Should be used when creating multiple leads     at the same time - also called \'batch processing\'.
+     * @summary Create the lead asynchronously
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadAsync(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadAsyncResponseClass>>;
+    /**
+     * This endpoint initiates the creation of a lead, which is the initial step in a comprehensive      workflow responsible for the creation of an account, policy, and banking information.      Unlike the standard lead creation endpoint, this variant ensures that the process waits until the entire workflow      is successfully completed before providing a response.
+     * @summary Create the lead
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadSync(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadResponseClass>>;
+    /**
+     * Permanently deletes the lead. Supply the unique code that was returned when you created the lead and this will delete it.
+     * @summary Delete the lead
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLead(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+     * @summary Retrieve the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLead(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadResponseClass>>;
+    /**
+     * Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List leads
+     * @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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadsResponseClass>>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed.    Any parameters not provided will be left unchanged.
+     * @summary Patch the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {PatchLeadRequestDto} patchLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchLead(code: string, patchLeadRequestDto: PatchLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchLeadResponseClass>>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateLeadRequestDto} updateLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLeadResponseClass>>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateLeadRequestDto} updateLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLeadSync(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateLeadResponseClass>>;
+};
+/**
+ * LeadsApi - factory interface
+ * @export
+ */
+export declare const LeadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+     * @summary Create the lead
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLead(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadResponseClass>;
+    /**
+     * This will send the lead to the queue for creation. Should be used when creating multiple leads     at the same time - also called \'batch processing\'.
+     * @summary Create the lead asynchronously
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadAsync(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadAsyncResponseClass>;
+    /**
+     * This endpoint initiates the creation of a lead, which is the initial step in a comprehensive      workflow responsible for the creation of an account, policy, and banking information.      Unlike the standard lead creation endpoint, this variant ensures that the process waits until the entire workflow      is successfully completed before providing a response.
+     * @summary Create the lead
+     * @param {CreateLeadRequestDto} createLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadSync(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadResponseClass>;
+    /**
+     * Permanently deletes the lead. Supply the unique code that was returned when you created the lead and this will delete it.
+     * @summary Delete the lead
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLead(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+     * @summary Retrieve the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLead(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetLeadResponseClass>;
+    /**
+     * Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List leads
+     * @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>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed.    Any parameters not provided will be left unchanged.
+     * @summary Patch the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {PatchLeadRequestDto} patchLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchLead(code: string, patchLeadRequestDto: PatchLeadRequestDto, authorization?: string, options?: any): AxiosPromise<PatchLeadResponseClass>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateLeadRequestDto} updateLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLead(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLeadResponseClass>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateLeadRequestDto} updateLeadRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLeadSync(code: string, updateLeadRequestDto: UpdateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateLeadResponseClass>;
+};
+/**
+ * Request parameters for createLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiCreateLeadRequest
+ */
+export interface LeadsApiCreateLeadRequest {
+    /**
+     *
+     * @type {CreateLeadRequestDto}
+     * @memberof LeadsApiCreateLead
+     */
+    readonly createLeadRequestDto: CreateLeadRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiCreateLead
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createLeadAsync operation in LeadsApi.
+ * @export
+ * @interface LeadsApiCreateLeadAsyncRequest
+ */
+export interface LeadsApiCreateLeadAsyncRequest {
+    /**
+     *
+     * @type {CreateLeadRequestDto}
+     * @memberof LeadsApiCreateLeadAsync
+     */
+    readonly createLeadRequestDto: CreateLeadRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiCreateLeadAsync
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createLeadSync operation in LeadsApi.
+ * @export
+ * @interface LeadsApiCreateLeadSyncRequest
+ */
+export interface LeadsApiCreateLeadSyncRequest {
+    /**
+     *
+     * @type {CreateLeadRequestDto}
+     * @memberof LeadsApiCreateLeadSync
+     */
+    readonly createLeadRequestDto: CreateLeadRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiCreateLeadSync
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiDeleteLeadRequest
+ */
+export interface LeadsApiDeleteLeadRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LeadsApiDeleteLead
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiDeleteLead
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiGetLeadRequest
+ */
+export interface LeadsApiGetLeadRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadsApiGetLead
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiGetLead
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LeadsApiGetLead
+     */
+    readonly expand?: 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 patchLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiPatchLeadRequest
+ */
+export interface LeadsApiPatchLeadRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadsApiPatchLead
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {PatchLeadRequestDto}
+     * @memberof LeadsApiPatchLead
+     */
+    readonly patchLeadRequestDto: PatchLeadRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiPatchLead
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateLead operation in LeadsApi.
+ * @export
+ * @interface LeadsApiUpdateLeadRequest
+ */
+export interface LeadsApiUpdateLeadRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadsApiUpdateLead
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateLeadRequestDto}
+     * @memberof LeadsApiUpdateLead
+     */
+    readonly updateLeadRequestDto: UpdateLeadRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiUpdateLead
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateLeadSync operation in LeadsApi.
+ * @export
+ * @interface LeadsApiUpdateLeadSyncRequest
+ */
+export interface LeadsApiUpdateLeadSyncRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LeadsApiUpdateLeadSync
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateLeadRequestDto}
+     * @memberof LeadsApiUpdateLeadSync
+     */
+    readonly updateLeadRequestDto: UpdateLeadRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadsApiUpdateLeadSync
+     */
+    readonly authorization?: string;
+}
+/**
+ * LeadsApi - object-oriented interface
+ * @export
+ * @class LeadsApi
+ * @extends {BaseAPI}
+ */
+export declare class LeadsApi extends BaseAPI {
+    /**
+     * This will create a lead. Lead creation is the first step of a workflow responsible for      the creation of an account, policy, banking information.
+     * @summary Create the lead
+     * @param {LeadsApiCreateLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    createLead(requestParameters: LeadsApiCreateLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLeadResponseClass, any>>;
+    /**
+     * This will send the lead to the queue for creation. Should be used when creating multiple leads     at the same time - also called \'batch processing\'.
+     * @summary Create the lead asynchronously
+     * @param {LeadsApiCreateLeadAsyncRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    createLeadAsync(requestParameters: LeadsApiCreateLeadAsyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLeadAsyncResponseClass, any>>;
+    /**
+     * This endpoint initiates the creation of a lead, which is the initial step in a comprehensive      workflow responsible for the creation of an account, policy, and banking information.      Unlike the standard lead creation endpoint, this variant ensures that the process waits until the entire workflow      is successfully completed before providing a response.
+     * @summary Create the lead
+     * @param {LeadsApiCreateLeadSyncRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    createLeadSync(requestParameters: LeadsApiCreateLeadSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLeadResponseClass, any>>;
+    /**
+     * Permanently deletes the lead. Supply the unique code that was returned when you created the lead and this will delete it.
+     * @summary Delete the lead
+     * @param {LeadsApiDeleteLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    deleteLead(requestParameters: LeadsApiDeleteLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
+     * @summary Retrieve the lead
+     * @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    getLead(requestParameters: LeadsApiGetLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLeadResponseClass, any>>;
+    /**
+     * Returns a list of leads you have previously created. The leads are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List leads
+     * @param {LeadsApiListLeadsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    listLeads(requestParameters?: LeadsApiListLeadsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLeadsResponseClass, any>>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed.    Any parameters not provided will be left unchanged.
+     * @summary Patch the lead
+     * @param {LeadsApiPatchLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    patchLead(requestParameters: LeadsApiPatchLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchLeadResponseClass, any>>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {LeadsApiUpdateLeadRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    updateLead(requestParameters: LeadsApiUpdateLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLeadResponseClass, any>>;
+    /**
+     * Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the lead
+     * @param {LeadsApiUpdateLeadSyncRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadsApi
+     */
+    updateLeadSync(requestParameters: LeadsApiUpdateLeadSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateLeadResponseClass, any>>;
+}