@emilgroup/billing-sdk-node 1.3.0 → 1.4.0

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

@@ -0,0 +1,266 @@
+/**
+ * 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 { 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>;
+    /**
+     * 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>;
+};
+/**
+ * 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>>;
+    /**
+     * 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>>;
+};
+/**
+ * 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>;
+    /**
+     * 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>;
+};
+/**
+ * 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 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;
+}
+/**
+ * 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>>;
+    /**
+     * 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>>;
+}