@emilgroup/insurance-sdk-node 1.36.0 → 1.37.0

package/dist/api/premium-formulas-api.d.ts

@@ -0,0 +1,433 @@
+/**
+ * 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 { CreatePremiumFormulaRequestDto } from '../models';
+import { CreatePremiumFormulaResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { EmptyResponseClass } from '../models';
+import { GetPremiumFormulaResponseClass } from '../models';
+import { ListPremiumFormulasResponseClass } from '../models';
+import { SwapPremiumFormulasOrderRequestDto } from '../models';
+import { UpdatePremiumFormulaRequestDto } from '../models';
+import { UpdatePremiumFormulaResponseClass } from '../models';
+/**
+ * PremiumFormulasApi - axios parameter creator
+ * @export
+ */
+export declare const PremiumFormulasApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a premium formula.
+     * @summary Create the premium formula
+     * @param {CreatePremiumFormulaRequestDto} createPremiumFormulaRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPremiumFormula: (createPremiumFormulaRequestDto: CreatePremiumFormulaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the premium formula. Supply the unique id that was returned when you created the premium formula and this will delete it.
+     * @summary Delete the premium formula
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePremiumFormula: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the premium formula that was previously created. Supply the unique premium formula id that was returned when you created it and Emil Api will return the corresponding premium formula information.
+     * @summary Retrieve the premium formula
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPremiumFormula: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of premium formulas you have previously created. The premium formulas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List premium formulas
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query.
+     * @param {string} [order] Ordering criteria.
+     * @param {string} [expand] Extra fields to fetch.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPremiumFormulas: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Swaps premium formulas order.
+     * @summary Swaps premium formulas order
+     * @param {SwapPremiumFormulasOrderRequestDto} swapPremiumFormulasOrderRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    swapPremiumFormulasOrder: (swapPremiumFormulasOrderRequestDto: SwapPremiumFormulasOrderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified premium formula by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the premium formula
+     * @param {number} id
+     * @param {UpdatePremiumFormulaRequestDto} updatePremiumFormulaRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePremiumFormula: (id: number, updatePremiumFormulaRequestDto: UpdatePremiumFormulaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PremiumFormulasApi - functional programming interface
+ * @export
+ */
+export declare const PremiumFormulasApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a premium formula.
+     * @summary Create the premium formula
+     * @param {CreatePremiumFormulaRequestDto} createPremiumFormulaRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPremiumFormula(createPremiumFormulaRequestDto: CreatePremiumFormulaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePremiumFormulaResponseClass>>;
+    /**
+     * Permanently deletes the premium formula. Supply the unique id that was returned when you created the premium formula and this will delete it.
+     * @summary Delete the premium formula
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePremiumFormula(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the premium formula that was previously created. Supply the unique premium formula id that was returned when you created it and Emil Api will return the corresponding premium formula information.
+     * @summary Retrieve the premium formula
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPremiumFormula(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPremiumFormulaResponseClass>>;
+    /**
+     * Returns a list of premium formulas you have previously created. The premium formulas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List premium formulas
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query.
+     * @param {string} [order] Ordering criteria.
+     * @param {string} [expand] Extra fields to fetch.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPremiumFormulas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPremiumFormulasResponseClass>>;
+    /**
+     * Swaps premium formulas order.
+     * @summary Swaps premium formulas order
+     * @param {SwapPremiumFormulasOrderRequestDto} swapPremiumFormulasOrderRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    swapPremiumFormulasOrder(swapPremiumFormulasOrderRequestDto: SwapPremiumFormulasOrderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptyResponseClass>>;
+    /**
+     * Updates the specified premium formula by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the premium formula
+     * @param {number} id
+     * @param {UpdatePremiumFormulaRequestDto} updatePremiumFormulaRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePremiumFormula(id: number, updatePremiumFormulaRequestDto: UpdatePremiumFormulaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePremiumFormulaResponseClass>>;
+};
+/**
+ * PremiumFormulasApi - factory interface
+ * @export
+ */
+export declare const PremiumFormulasApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a premium formula.
+     * @summary Create the premium formula
+     * @param {CreatePremiumFormulaRequestDto} createPremiumFormulaRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPremiumFormula(createPremiumFormulaRequestDto: CreatePremiumFormulaRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePremiumFormulaResponseClass>;
+    /**
+     * Permanently deletes the premium formula. Supply the unique id that was returned when you created the premium formula and this will delete it.
+     * @summary Delete the premium formula
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePremiumFormula(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the premium formula that was previously created. Supply the unique premium formula id that was returned when you created it and Emil Api will return the corresponding premium formula information.
+     * @summary Retrieve the premium formula
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPremiumFormula(id: number, authorization?: string, options?: any): AxiosPromise<GetPremiumFormulaResponseClass>;
+    /**
+     * Returns a list of premium formulas you have previously created. The premium formulas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List premium formulas
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
+     * @param {string} [filter] List filter
+     * @param {string} [search] Search query.
+     * @param {string} [order] Ordering criteria.
+     * @param {string} [expand] Extra fields to fetch.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPremiumFormulas(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPremiumFormulasResponseClass>;
+    /**
+     * Swaps premium formulas order.
+     * @summary Swaps premium formulas order
+     * @param {SwapPremiumFormulasOrderRequestDto} swapPremiumFormulasOrderRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    swapPremiumFormulasOrder(swapPremiumFormulasOrderRequestDto: SwapPremiumFormulasOrderRequestDto, authorization?: string, options?: any): AxiosPromise<EmptyResponseClass>;
+    /**
+     * Updates the specified premium formula by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the premium formula
+     * @param {number} id
+     * @param {UpdatePremiumFormulaRequestDto} updatePremiumFormulaRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePremiumFormula(id: number, updatePremiumFormulaRequestDto: UpdatePremiumFormulaRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePremiumFormulaResponseClass>;
+};
+/**
+ * Request parameters for createPremiumFormula operation in PremiumFormulasApi.
+ * @export
+ * @interface PremiumFormulasApiCreatePremiumFormulaRequest
+ */
+export interface PremiumFormulasApiCreatePremiumFormulaRequest {
+    /**
+     *
+     * @type {CreatePremiumFormulaRequestDto}
+     * @memberof PremiumFormulasApiCreatePremiumFormula
+     */
+    readonly createPremiumFormulaRequestDto: CreatePremiumFormulaRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PremiumFormulasApiCreatePremiumFormula
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePremiumFormula operation in PremiumFormulasApi.
+ * @export
+ * @interface PremiumFormulasApiDeletePremiumFormulaRequest
+ */
+export interface PremiumFormulasApiDeletePremiumFormulaRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof PremiumFormulasApiDeletePremiumFormula
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PremiumFormulasApiDeletePremiumFormula
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPremiumFormula operation in PremiumFormulasApi.
+ * @export
+ * @interface PremiumFormulasApiGetPremiumFormulaRequest
+ */
+export interface PremiumFormulasApiGetPremiumFormulaRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof PremiumFormulasApiGetPremiumFormula
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PremiumFormulasApiGetPremiumFormula
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPremiumFormulas operation in PremiumFormulasApi.
+ * @export
+ * @interface PremiumFormulasApiListPremiumFormulasRequest
+ */
+export interface PremiumFormulasApiListPremiumFormulasRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria.
+     * @type {string}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch.
+     * @type {string}
+     * @memberof PremiumFormulasApiListPremiumFormulas
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for swapPremiumFormulasOrder operation in PremiumFormulasApi.
+ * @export
+ * @interface PremiumFormulasApiSwapPremiumFormulasOrderRequest
+ */
+export interface PremiumFormulasApiSwapPremiumFormulasOrderRequest {
+    /**
+     *
+     * @type {SwapPremiumFormulasOrderRequestDto}
+     * @memberof PremiumFormulasApiSwapPremiumFormulasOrder
+     */
+    readonly swapPremiumFormulasOrderRequestDto: SwapPremiumFormulasOrderRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PremiumFormulasApiSwapPremiumFormulasOrder
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updatePremiumFormula operation in PremiumFormulasApi.
+ * @export
+ * @interface PremiumFormulasApiUpdatePremiumFormulaRequest
+ */
+export interface PremiumFormulasApiUpdatePremiumFormulaRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof PremiumFormulasApiUpdatePremiumFormula
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdatePremiumFormulaRequestDto}
+     * @memberof PremiumFormulasApiUpdatePremiumFormula
+     */
+    readonly updatePremiumFormulaRequestDto: UpdatePremiumFormulaRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof PremiumFormulasApiUpdatePremiumFormula
+     */
+    readonly authorization?: string;
+}
+/**
+ * PremiumFormulasApi - object-oriented interface
+ * @export
+ * @class PremiumFormulasApi
+ * @extends {BaseAPI}
+ */
+export declare class PremiumFormulasApi extends BaseAPI {
+    /**
+     * Creates a premium formula.
+     * @summary Create the premium formula
+     * @param {PremiumFormulasApiCreatePremiumFormulaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumFormulasApi
+     */
+    createPremiumFormula(requestParameters: PremiumFormulasApiCreatePremiumFormulaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePremiumFormulaResponseClass, any>>;
+    /**
+     * Permanently deletes the premium formula. Supply the unique id that was returned when you created the premium formula and this will delete it.
+     * @summary Delete the premium formula
+     * @param {PremiumFormulasApiDeletePremiumFormulaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumFormulasApi
+     */
+    deletePremiumFormula(requestParameters: PremiumFormulasApiDeletePremiumFormulaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the premium formula that was previously created. Supply the unique premium formula id that was returned when you created it and Emil Api will return the corresponding premium formula information.
+     * @summary Retrieve the premium formula
+     * @param {PremiumFormulasApiGetPremiumFormulaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumFormulasApi
+     */
+    getPremiumFormula(requestParameters: PremiumFormulasApiGetPremiumFormulaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPremiumFormulaResponseClass, any>>;
+    /**
+     * Returns a list of premium formulas you have previously created. The premium formulas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List premium formulas
+     * @param {PremiumFormulasApiListPremiumFormulasRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumFormulasApi
+     */
+    listPremiumFormulas(requestParameters?: PremiumFormulasApiListPremiumFormulasRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPremiumFormulasResponseClass, any>>;
+    /**
+     * Swaps premium formulas order.
+     * @summary Swaps premium formulas order
+     * @param {PremiumFormulasApiSwapPremiumFormulasOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumFormulasApi
+     */
+    swapPremiumFormulasOrder(requestParameters: PremiumFormulasApiSwapPremiumFormulasOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptyResponseClass, any>>;
+    /**
+     * Updates the specified premium formula by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the premium formula
+     * @param {PremiumFormulasApiUpdatePremiumFormulaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PremiumFormulasApi
+     */
+    updatePremiumFormula(requestParameters: PremiumFormulasApiUpdatePremiumFormulaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePremiumFormulaResponseClass, any>>;
+}