@emilgroup/public-api-sdk 1.19.0 → 1.24.0

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

@@ -1,441 +0,0 @@
-/**
- * Emil PublicAPI
- * The Emil Public 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 { GetLeadResponseClass } from '../models';
-import { InitiateLeadResponseClass } 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 synchronously
-     * @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>;
-    /**
-     * 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 {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getLead: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * This will initiate a lead code.
-     * @summary Initiate a lead code
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    initiateLead: (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 synchronously
-     * @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>>;
-    /**
-     * 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 {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getLead(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadResponseClass>>;
-    /**
-     * This will initiate a lead code.
-     * @summary Initiate a lead code
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    initiateLead(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateLeadResponseClass>>;
-    /**
-     * 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 synchronously
-     * @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>;
-    /**
-     * 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 {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getLead(code: string, authorization?: string, options?: any): AxiosPromise<GetLeadResponseClass>;
-    /**
-     * This will initiate a lead code.
-     * @summary Initiate a lead code
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    initiateLead(authorization?: string, options?: any): AxiosPromise<InitiateLeadResponseClass>;
-    /**
-     * 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 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;
-}
-/**
- * Request parameters for initiateLead operation in LeadsApi.
- * @export
- * @interface LeadsApiInitiateLeadRequest
- */
-export interface LeadsApiInitiateLeadRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof LeadsApiInitiateLead
-     */
-    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 synchronously
-     * @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>>;
-    /**
-     * 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>>;
-    /**
-     * This will initiate a lead code.
-     * @summary Initiate a lead code
-     * @param {LeadsApiInitiateLeadRequest} requestParameters Request parameters.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof LeadsApi
-     */
-    initiateLead(requestParameters?: LeadsApiInitiateLeadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateLeadResponseClass, 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>>;
-}