@emilgroup/insurance-sdk-node 1.9.0 → 1.10.0

package/dist/api/lead-statuses-api.d.ts

@@ -0,0 +1,265 @@
+/**
+ * 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 { CreateLeadStatusRequestDto } from '../models';
+import { CreateLeadStatusResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetLeadStatusResponseClass } from '../models';
+import { ListLeadStatusesResponseClass } from '../models';
+/**
+ * LeadStatusesApi - axios parameter creator
+ * @export
+ */
+export declare const LeadStatusesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a lead status. There are 3 predefined lead statuses in our service, but tenants can define their own custom lead statuses as well. Predefined lead statuses are \"created\",\"approved\" and \"declined\".
+     * @summary Create the lead status
+     * @param {CreateLeadStatusRequestDto} createLeadStatusRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadStatus: (createLeadStatusRequestDto: CreateLeadStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the lead status. Supply the unique id that was returned when you      created the lead status and this will delete it. Deleting a lead status can have an impact on workflows,     and it\'s crucial to ensure that no workflows are using the lead status that is being deleted.
+     * @summary Delete the lead status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLeadStatus: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the lead status that was previously created. Supply the unique lead status code that was returned when you created it and Emil Api will return the corresponding lead status information.
+     * @summary Retrieve the lead status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLeadStatus: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of lead statuses you have previously created. The lead statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List lead statuses
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: owner, id, name and productSlug.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLeadStatuses: (authorization?: string, filter?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * LeadStatusesApi - functional programming interface
+ * @export
+ */
+export declare const LeadStatusesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a lead status. There are 3 predefined lead statuses in our service, but tenants can define their own custom lead statuses as well. Predefined lead statuses are \"created\",\"approved\" and \"declined\".
+     * @summary Create the lead status
+     * @param {CreateLeadStatusRequestDto} createLeadStatusRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadStatus(createLeadStatusRequestDto: CreateLeadStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadStatusResponseClass>>;
+    /**
+     * Permanently deletes the lead status. Supply the unique id that was returned when you      created the lead status and this will delete it. Deleting a lead status can have an impact on workflows,     and it\'s crucial to ensure that no workflows are using the lead status that is being deleted.
+     * @summary Delete the lead status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLeadStatus(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the lead status that was previously created. Supply the unique lead status code that was returned when you created it and Emil Api will return the corresponding lead status information.
+     * @summary Retrieve the lead status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLeadStatus(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLeadStatusResponseClass>>;
+    /**
+     * Returns a list of lead statuses you have previously created. The lead statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List lead statuses
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: owner, id, name and productSlug.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLeadStatuses(authorization?: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListLeadStatusesResponseClass>>;
+};
+/**
+ * LeadStatusesApi - factory interface
+ * @export
+ */
+export declare const LeadStatusesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a lead status. There are 3 predefined lead statuses in our service, but tenants can define their own custom lead statuses as well. Predefined lead statuses are \"created\",\"approved\" and \"declined\".
+     * @summary Create the lead status
+     * @param {CreateLeadStatusRequestDto} createLeadStatusRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createLeadStatus(createLeadStatusRequestDto: CreateLeadStatusRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadStatusResponseClass>;
+    /**
+     * Permanently deletes the lead status. Supply the unique id that was returned when you      created the lead status and this will delete it. Deleting a lead status can have an impact on workflows,     and it\'s crucial to ensure that no workflows are using the lead status that is being deleted.
+     * @summary Delete the lead status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLeadStatus(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the lead status that was previously created. Supply the unique lead status code that was returned when you created it and Emil Api will return the corresponding lead status information.
+     * @summary Retrieve the lead status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLeadStatus(id: number, authorization?: string, options?: any): AxiosPromise<GetLeadStatusResponseClass>;
+    /**
+     * Returns a list of lead statuses you have previously created. The lead statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List lead statuses
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: owner, id, name and productSlug.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listLeadStatuses(authorization?: string, filter?: string, options?: any): AxiosPromise<ListLeadStatusesResponseClass>;
+};
+/**
+ * Request parameters for createLeadStatus operation in LeadStatusesApi.
+ * @export
+ * @interface LeadStatusesApiCreateLeadStatusRequest
+ */
+export interface LeadStatusesApiCreateLeadStatusRequest {
+    /**
+     *
+     * @type {CreateLeadStatusRequestDto}
+     * @memberof LeadStatusesApiCreateLeadStatus
+     */
+    readonly createLeadStatusRequestDto: CreateLeadStatusRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadStatusesApiCreateLeadStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteLeadStatus operation in LeadStatusesApi.
+ * @export
+ * @interface LeadStatusesApiDeleteLeadStatusRequest
+ */
+export interface LeadStatusesApiDeleteLeadStatusRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof LeadStatusesApiDeleteLeadStatus
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadStatusesApiDeleteLeadStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getLeadStatus operation in LeadStatusesApi.
+ * @export
+ * @interface LeadStatusesApiGetLeadStatusRequest
+ */
+export interface LeadStatusesApiGetLeadStatusRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof LeadStatusesApiGetLeadStatus
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadStatusesApiGetLeadStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listLeadStatuses operation in LeadStatusesApi.
+ * @export
+ * @interface LeadStatusesApiListLeadStatusesRequest
+ */
+export interface LeadStatusesApiListLeadStatusesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof LeadStatusesApiListLeadStatuses
+     */
+    readonly authorization?: string;
+    /**
+     * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: owner, id, name and productSlug.
+     * @type {string}
+     * @memberof LeadStatusesApiListLeadStatuses
+     */
+    readonly filter?: string;
+}
+/**
+ * LeadStatusesApi - object-oriented interface
+ * @export
+ * @class LeadStatusesApi
+ * @extends {BaseAPI}
+ */
+export declare class LeadStatusesApi extends BaseAPI {
+    /**
+     * This will create a lead status. There are 3 predefined lead statuses in our service, but tenants can define their own custom lead statuses as well. Predefined lead statuses are \"created\",\"approved\" and \"declined\".
+     * @summary Create the lead status
+     * @param {LeadStatusesApiCreateLeadStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadStatusesApi
+     */
+    createLeadStatus(requestParameters: LeadStatusesApiCreateLeadStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLeadStatusResponseClass, any>>;
+    /**
+     * Permanently deletes the lead status. Supply the unique id that was returned when you      created the lead status and this will delete it. Deleting a lead status can have an impact on workflows,     and it\'s crucial to ensure that no workflows are using the lead status that is being deleted.
+     * @summary Delete the lead status
+     * @param {LeadStatusesApiDeleteLeadStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadStatusesApi
+     */
+    deleteLeadStatus(requestParameters: LeadStatusesApiDeleteLeadStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the lead status that was previously created. Supply the unique lead status code that was returned when you created it and Emil Api will return the corresponding lead status information.
+     * @summary Retrieve the lead status
+     * @param {LeadStatusesApiGetLeadStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadStatusesApi
+     */
+    getLeadStatus(requestParameters: LeadStatusesApiGetLeadStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLeadStatusResponseClass, any>>;
+    /**
+     * Returns a list of lead statuses you have previously created. The lead statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List lead statuses
+     * @param {LeadStatusesApiListLeadStatusesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LeadStatusesApi
+     */
+    listLeadStatuses(requestParameters?: LeadStatusesApiListLeadStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListLeadStatusesResponseClass, any>>;
+}