@emilgroup/insurance-sdk-node 1.36.0 → 1.37.0

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

@@ -0,0 +1,485 @@
+/**
+ * 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 { CreateProductRequestDto } from '../models';
+import { CreateProductResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetProductResponseClass } from '../models';
+import { ListProductsResponseClass } from '../models';
+import { UpdateProductRequestDto } from '../models';
+import { UpdateProductResponseClass } from '../models';
+/**
+ * ProductsApi - axios parameter creator
+ * @export
+ */
+export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a blank product. The product cannot be used as long    as it is missing product factors, insured objects and premium formulas.
+     * @summary Create the product
+     * @param {CreateProductRequestDto} createProductRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProduct: (createProductRequestDto: CreateProductRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the product. Supply the unique id that was returned when you created the product and this will delete it.
+     * @summary Delete the product
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProduct: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {string} code Unique identifier for the object.
+     * @param {number} id Unique identifier referencing the product.
+     * @param {string} slug A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductByCode: (code: string, id: number, slug: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {number} id Unique identifier referencing the product.
+     * @param {string} code Unique identifier of the product that this object belongs to.
+     * @param {string} slug A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductByIdentifier: (id: number, code: string, slug: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of products you have previously created. The products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List products
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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] You can expand product versions and insured object types list in this endpoint. By default, versions &amp; insuredObjectTypes will be an empty array.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProducts: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the product
+     * @param {number} id
+     * @param {UpdateProductRequestDto} updateProductRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProduct: (id: number, updateProductRequestDto: UpdateProductRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductsApi - functional programming interface
+ * @export
+ */
+export declare const ProductsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a blank product. The product cannot be used as long    as it is missing product factors, insured objects and premium formulas.
+     * @summary Create the product
+     * @param {CreateProductRequestDto} createProductRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProduct(createProductRequestDto: CreateProductRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductResponseClass>>;
+    /**
+     * Permanently deletes the product. Supply the unique id that was returned when you created the product and this will delete it.
+     * @summary Delete the product
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProduct(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {string} code Unique identifier for the object.
+     * @param {number} id Unique identifier referencing the product.
+     * @param {string} slug A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductByCode(code: string, id: number, slug: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductResponseClass>>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {number} id Unique identifier referencing the product.
+     * @param {string} code Unique identifier of the product that this object belongs to.
+     * @param {string} slug A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductByIdentifier(id: number, code: string, slug: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductResponseClass>>;
+    /**
+     * Returns a list of products you have previously created. The products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List products
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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] You can expand product versions and insured object types list in this endpoint. By default, versions &amp; insuredObjectTypes will be an empty array.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductsResponseClass>>;
+    /**
+     * Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the product
+     * @param {number} id
+     * @param {UpdateProductRequestDto} updateProductRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProduct(id: number, updateProductRequestDto: UpdateProductRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductResponseClass>>;
+};
+/**
+ * ProductsApi - factory interface
+ * @export
+ */
+export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a blank product. The product cannot be used as long    as it is missing product factors, insured objects and premium formulas.
+     * @summary Create the product
+     * @param {CreateProductRequestDto} createProductRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProduct(createProductRequestDto: CreateProductRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductResponseClass>;
+    /**
+     * Permanently deletes the product. Supply the unique id that was returned when you created the product and this will delete it.
+     * @summary Delete the product
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProduct(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {string} code Unique identifier for the object.
+     * @param {number} id Unique identifier referencing the product.
+     * @param {string} slug A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductByCode(code: string, id: number, slug: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetProductResponseClass>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {number} id Unique identifier referencing the product.
+     * @param {string} code Unique identifier of the product that this object belongs to.
+     * @param {string} slug A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductByIdentifier(id: number, code: string, slug: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetProductResponseClass>;
+    /**
+     * Returns a list of products you have previously created. The products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List products
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @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] You can expand product versions and insured object types list in this endpoint. By default, versions &amp; insuredObjectTypes will be an empty array.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProducts(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductsResponseClass>;
+    /**
+     * Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the product
+     * @param {number} id
+     * @param {UpdateProductRequestDto} updateProductRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProduct(id: number, updateProductRequestDto: UpdateProductRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductResponseClass>;
+};
+/**
+ * Request parameters for createProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiCreateProductRequest
+ */
+export interface ProductsApiCreateProductRequest {
+    /**
+     *
+     * @type {CreateProductRequestDto}
+     * @memberof ProductsApiCreateProduct
+     */
+    readonly createProductRequestDto: CreateProductRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ProductsApiCreateProduct
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiDeleteProductRequest
+ */
+export interface ProductsApiDeleteProductRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ProductsApiDeleteProduct
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ProductsApiDeleteProduct
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getProductByCode operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductByCodeRequest
+ */
+export interface ProductsApiGetProductByCodeRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ProductsApiGetProductByCode
+     */
+    readonly code: string;
+    /**
+     * Unique identifier referencing the product.
+     * @type {number}
+     * @memberof ProductsApiGetProductByCode
+     */
+    readonly id: number;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof ProductsApiGetProductByCode
+     */
+    readonly slug: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ProductsApiGetProductByCode
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof ProductsApiGetProductByCode
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for getProductByIdentifier operation in ProductsApi.
+ * @export
+ * @interface ProductsApiGetProductByIdentifierRequest
+ */
+export interface ProductsApiGetProductByIdentifierRequest {
+    /**
+     * Unique identifier referencing the product.
+     * @type {number}
+     * @memberof ProductsApiGetProductByIdentifier
+     */
+    readonly id: number;
+    /**
+     * Unique identifier of the product that this object belongs to.
+     * @type {string}
+     * @memberof ProductsApiGetProductByIdentifier
+     */
+    readonly code: string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof ProductsApiGetProductByIdentifier
+     */
+    readonly slug: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ProductsApiGetProductByIdentifier
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof ProductsApiGetProductByIdentifier
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiListProductsRequest
+ */
+export interface ProductsApiListProductsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof ProductsApiListProducts
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly order?: string;
+    /**
+     * You can expand product versions and insured object types list in this endpoint. By default, versions &amp; insuredObjectTypes will be an empty array.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateProduct operation in ProductsApi.
+ * @export
+ * @interface ProductsApiUpdateProductRequest
+ */
+export interface ProductsApiUpdateProductRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ProductsApiUpdateProduct
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdateProductRequestDto}
+     * @memberof ProductsApiUpdateProduct
+     */
+    readonly updateProductRequestDto: UpdateProductRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ProductsApiUpdateProduct
+     */
+    readonly authorization?: string;
+}
+/**
+ * ProductsApi - object-oriented interface
+ * @export
+ * @class ProductsApi
+ * @extends {BaseAPI}
+ */
+export declare class ProductsApi extends BaseAPI {
+    /**
+     * Create a blank product. The product cannot be used as long    as it is missing product factors, insured objects and premium formulas.
+     * @summary Create the product
+     * @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    createProduct(requestParameters: ProductsApiCreateProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductResponseClass, any>>;
+    /**
+     * Permanently deletes the product. Supply the unique id that was returned when you created the product and this will delete it.
+     * @summary Delete the product
+     * @param {ProductsApiDeleteProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    deleteProduct(requestParameters: ProductsApiDeleteProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {ProductsApiGetProductByCodeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    getProductByCode(requestParameters: ProductsApiGetProductByCodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductResponseClass, any>>;
+    /**
+     * Retrieves the details of the product that was previously created. Supply the unique product code that was returned when you created it and Emil Api will return the corresponding product information.
+     * @summary Retrieve the product
+     * @param {ProductsApiGetProductByIdentifierRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    getProductByIdentifier(requestParameters: ProductsApiGetProductByIdentifierRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductResponseClass, any>>;
+    /**
+     * Returns a list of products you have previously created. The products are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List products
+     * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    listProducts(requestParameters?: ProductsApiListProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductsResponseClass, any>>;
+    /**
+     * Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the product
+     * @param {ProductsApiUpdateProductRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductsApi
+     */
+    updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateProductResponseClass, any>>;
+}