@emilgroup/insurance-sdk-node 1.44.0 → 1.47.0

package/dist/api/booking-funnels-api.d.ts

@@ -0,0 +1,443 @@
+/**
+ * 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 { CreateBookingFunnelRequestDto } from '../models';
+import { DeleteResponseClass } from '../models';
+import { ListBookingFunnelsResponseClass } from '../models';
+import { PatchBookingFunnelRequestDto } from '../models';
+import { UpdateBookingFunnelRequestDto } from '../models';
+/**
+ * BookingFunnelsApi - axios parameter creator
+ * @export
+ */
+export declare const BookingFunnelsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a booking funnel.
+     * @summary Create the booking funnel
+     * @param {CreateBookingFunnelRequestDto} createBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBookingFunnel: (createBookingFunnelRequestDto: CreateBookingFunnelRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the booking funnel. Supply the unique code that was returned when you      created the booking funnel and this will delete it.
+     * @summary Delete the booking funnel
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBookingFunnel: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
+     * @summary Retrieve the booking funnel
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBookingFunnel: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List booking funnels
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBookingFunnels: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will patch a booking funnel.
+     * @param {string} code
+     * @param {PatchBookingFunnelRequestDto} patchBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBookingFunnel: (code: string, patchBookingFunnelRequestDto: PatchBookingFunnelRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update a booking funnel.
+     * @summary Update the booking funnel
+     * @param {string} code
+     * @param {UpdateBookingFunnelRequestDto} updateBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBookingFunnel: (code: string, updateBookingFunnelRequestDto: UpdateBookingFunnelRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BookingFunnelsApi - functional programming interface
+ * @export
+ */
+export declare const BookingFunnelsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a booking funnel.
+     * @summary Create the booking funnel
+     * @param {CreateBookingFunnelRequestDto} createBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBookingFunnel(createBookingFunnelRequestDto: CreateBookingFunnelRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Permanently deletes the booking funnel. Supply the unique code that was returned when you      created the booking funnel and this will delete it.
+     * @summary Delete the booking funnel
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBookingFunnel(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
+     * @summary Retrieve the booking funnel
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBookingFunnel(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List booking funnels
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBookingFunnels(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBookingFunnelsResponseClass>>;
+    /**
+     * This will patch a booking funnel.
+     * @param {string} code
+     * @param {PatchBookingFunnelRequestDto} patchBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBookingFunnel(code: string, patchBookingFunnelRequestDto: PatchBookingFunnelRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * This will update a booking funnel.
+     * @summary Update the booking funnel
+     * @param {string} code
+     * @param {UpdateBookingFunnelRequestDto} updateBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBookingFunnel(code: string, updateBookingFunnelRequestDto: UpdateBookingFunnelRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+};
+/**
+ * BookingFunnelsApi - factory interface
+ * @export
+ */
+export declare const BookingFunnelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a booking funnel.
+     * @summary Create the booking funnel
+     * @param {CreateBookingFunnelRequestDto} createBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBookingFunnel(createBookingFunnelRequestDto: CreateBookingFunnelRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Permanently deletes the booking funnel. Supply the unique code that was returned when you      created the booking funnel and this will delete it.
+     * @summary Delete the booking funnel
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBookingFunnel(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
+     * @summary Retrieve the booking funnel
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBookingFunnel(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List booking funnels
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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 {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBookingFunnels(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListBookingFunnelsResponseClass>;
+    /**
+     * This will patch a booking funnel.
+     * @param {string} code
+     * @param {PatchBookingFunnelRequestDto} patchBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchBookingFunnel(code: string, patchBookingFunnelRequestDto: PatchBookingFunnelRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * This will update a booking funnel.
+     * @summary Update the booking funnel
+     * @param {string} code
+     * @param {UpdateBookingFunnelRequestDto} updateBookingFunnelRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateBookingFunnel(code: string, updateBookingFunnelRequestDto: UpdateBookingFunnelRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+};
+/**
+ * Request parameters for createBookingFunnel operation in BookingFunnelsApi.
+ * @export
+ * @interface BookingFunnelsApiCreateBookingFunnelRequest
+ */
+export interface BookingFunnelsApiCreateBookingFunnelRequest {
+    /**
+     *
+     * @type {CreateBookingFunnelRequestDto}
+     * @memberof BookingFunnelsApiCreateBookingFunnel
+     */
+    readonly createBookingFunnelRequestDto: CreateBookingFunnelRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BookingFunnelsApiCreateBookingFunnel
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteBookingFunnel operation in BookingFunnelsApi.
+ * @export
+ * @interface BookingFunnelsApiDeleteBookingFunnelRequest
+ */
+export interface BookingFunnelsApiDeleteBookingFunnelRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BookingFunnelsApiDeleteBookingFunnel
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BookingFunnelsApiDeleteBookingFunnel
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getBookingFunnel operation in BookingFunnelsApi.
+ * @export
+ * @interface BookingFunnelsApiGetBookingFunnelRequest
+ */
+export interface BookingFunnelsApiGetBookingFunnelRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BookingFunnelsApiGetBookingFunnel
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BookingFunnelsApiGetBookingFunnel
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listBookingFunnels operation in BookingFunnelsApi.
+ * @export
+ * @interface BookingFunnelsApiListBookingFunnelsRequest
+ */
+export interface BookingFunnelsApiListBookingFunnelsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BookingFunnelsApiListBookingFunnels
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof BookingFunnelsApiListBookingFunnels
+     */
+    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 BookingFunnelsApiListBookingFunnels
+     */
+    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 BookingFunnelsApiListBookingFunnels
+     */
+    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 BookingFunnelsApiListBookingFunnels
+     */
+    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 BookingFunnelsApiListBookingFunnels
+     */
+    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 BookingFunnelsApiListBookingFunnels
+     */
+    readonly expand?: any;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {any}
+     * @memberof BookingFunnelsApiListBookingFunnels
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for patchBookingFunnel operation in BookingFunnelsApi.
+ * @export
+ * @interface BookingFunnelsApiPatchBookingFunnelRequest
+ */
+export interface BookingFunnelsApiPatchBookingFunnelRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BookingFunnelsApiPatchBookingFunnel
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {PatchBookingFunnelRequestDto}
+     * @memberof BookingFunnelsApiPatchBookingFunnel
+     */
+    readonly patchBookingFunnelRequestDto: PatchBookingFunnelRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BookingFunnelsApiPatchBookingFunnel
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateBookingFunnel operation in BookingFunnelsApi.
+ * @export
+ * @interface BookingFunnelsApiUpdateBookingFunnelRequest
+ */
+export interface BookingFunnelsApiUpdateBookingFunnelRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BookingFunnelsApiUpdateBookingFunnel
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateBookingFunnelRequestDto}
+     * @memberof BookingFunnelsApiUpdateBookingFunnel
+     */
+    readonly updateBookingFunnelRequestDto: UpdateBookingFunnelRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BookingFunnelsApiUpdateBookingFunnel
+     */
+    readonly authorization?: string;
+}
+/**
+ * BookingFunnelsApi - object-oriented interface
+ * @export
+ * @class BookingFunnelsApi
+ * @extends {BaseAPI}
+ */
+export declare class BookingFunnelsApi extends BaseAPI {
+    /**
+     * This will create a booking funnel.
+     * @summary Create the booking funnel
+     * @param {BookingFunnelsApiCreateBookingFunnelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingFunnelsApi
+     */
+    createBookingFunnel(requestParameters: BookingFunnelsApiCreateBookingFunnelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Permanently deletes the booking funnel. Supply the unique code that was returned when you      created the booking funnel and this will delete it.
+     * @summary Delete the booking funnel
+     * @param {BookingFunnelsApiDeleteBookingFunnelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingFunnelsApi
+     */
+    deleteBookingFunnel(requestParameters: BookingFunnelsApiDeleteBookingFunnelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
+     * @summary Retrieve the booking funnel
+     * @param {BookingFunnelsApiGetBookingFunnelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingFunnelsApi
+     */
+    getBookingFunnel(requestParameters: BookingFunnelsApiGetBookingFunnelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Returns a list of booking funnels you have previously created. The booking funnels are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List booking funnels
+     * @param {BookingFunnelsApiListBookingFunnelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingFunnelsApi
+     */
+    listBookingFunnels(requestParameters?: BookingFunnelsApiListBookingFunnelsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBookingFunnelsResponseClass, any>>;
+    /**
+     * This will patch a booking funnel.
+     * @param {BookingFunnelsApiPatchBookingFunnelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingFunnelsApi
+     */
+    patchBookingFunnel(requestParameters: BookingFunnelsApiPatchBookingFunnelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * This will update a booking funnel.
+     * @summary Update the booking funnel
+     * @param {BookingFunnelsApiUpdateBookingFunnelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BookingFunnelsApi
+     */
+    updateBookingFunnel(requestParameters: BookingFunnelsApiUpdateBookingFunnelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+}