@emilgroup/insurance-sdk-node 1.2.0 → 1.5.0

package/dist/api/product-fields-api.d.ts

@@ -0,0 +1,477 @@
+/**
+ * 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 { CreateProductFieldRequestDto } from '../models';
+import { CreateProductFieldResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetProductFieldResponseClass } from '../models';
+import { ListProductFieldTypesResponseClass } from '../models';
+import { ListProductFieldsResponseClass } from '../models';
+import { UpdateProductFieldRequestDto } from '../models';
+import { UpdateProductFieldResponseClass } from '../models';
+/**
+ * ProductFieldsApi - axios parameter creator
+ * @export
+ */
+export declare const ProductFieldsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a product field in the database.
+     * @summary Create the product field
+     * @param {CreateProductFieldRequestDto} createProductFieldRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProductField: (createProductFieldRequestDto: CreateProductFieldRequestDto, 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 {string} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProductField: (id: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the product field that was previously created. Supply the unique product field id that was returned when you created it and Emil Api will return the corresponding product field information.
+     * @summary Retrieve the product field
+     * @param {string} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductField: (id: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of product field types you have previously created. The product field types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product field types
+     * @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}
+     */
+    listProductFieldTypes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of product fields you have previously created. The product fields are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product fields
+     * @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}
+     */
+    listProductFields: (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 {string} id
+     * @param {UpdateProductFieldRequestDto} updateProductFieldRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProductField: (id: string, updateProductFieldRequestDto: UpdateProductFieldRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductFieldsApi - functional programming interface
+ * @export
+ */
+export declare const ProductFieldsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a product field in the database.
+     * @summary Create the product field
+     * @param {CreateProductFieldRequestDto} createProductFieldRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProductField(createProductFieldRequestDto: CreateProductFieldRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductFieldResponseClass>>;
+    /**
+     * 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 {string} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProductField(id: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the product field that was previously created. Supply the unique product field id that was returned when you created it and Emil Api will return the corresponding product field information.
+     * @summary Retrieve the product field
+     * @param {string} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductField(id: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductFieldResponseClass>>;
+    /**
+     * Returns a list of product field types you have previously created. The product field types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product field types
+     * @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}
+     */
+    listProductFieldTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductFieldTypesResponseClass>>;
+    /**
+     * Returns a list of product fields you have previously created. The product fields are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product fields
+     * @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}
+     */
+    listProductFields(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductFieldsResponseClass>>;
+    /**
+     * 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 {string} id
+     * @param {UpdateProductFieldRequestDto} updateProductFieldRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProductField(id: string, updateProductFieldRequestDto: UpdateProductFieldRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductFieldResponseClass>>;
+};
+/**
+ * ProductFieldsApi - factory interface
+ * @export
+ */
+export declare const ProductFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a product field in the database.
+     * @summary Create the product field
+     * @param {CreateProductFieldRequestDto} createProductFieldRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createProductField(createProductFieldRequestDto: CreateProductFieldRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductFieldResponseClass>;
+    /**
+     * 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 {string} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProductField(id: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the product field that was previously created. Supply the unique product field id that was returned when you created it and Emil Api will return the corresponding product field information.
+     * @summary Retrieve the product field
+     * @param {string} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductField(id: string, authorization?: string, options?: any): AxiosPromise<GetProductFieldResponseClass>;
+    /**
+     * Returns a list of product field types you have previously created. The product field types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product field types
+     * @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}
+     */
+    listProductFieldTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductFieldTypesResponseClass>;
+    /**
+     * Returns a list of product fields you have previously created. The product fields are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product fields
+     * @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}
+     */
+    listProductFields(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductFieldsResponseClass>;
+    /**
+     * 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 {string} id
+     * @param {UpdateProductFieldRequestDto} updateProductFieldRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateProductField(id: string, updateProductFieldRequestDto: UpdateProductFieldRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductFieldResponseClass>;
+};
+/**
+ * Request parameters for createProductField operation in ProductFieldsApi.
+ * @export
+ * @interface ProductFieldsApiCreateProductFieldRequest
+ */
+export interface ProductFieldsApiCreateProductFieldRequest {
+    /**
+     *
+     * @type {CreateProductFieldRequestDto}
+     * @memberof ProductFieldsApiCreateProductField
+     */
+    readonly createProductFieldRequestDto: CreateProductFieldRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFieldsApiCreateProductField
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteProductField operation in ProductFieldsApi.
+ * @export
+ * @interface ProductFieldsApiDeleteProductFieldRequest
+ */
+export interface ProductFieldsApiDeleteProductFieldRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductFieldsApiDeleteProductField
+     */
+    readonly id: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFieldsApiDeleteProductField
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getProductField operation in ProductFieldsApi.
+ * @export
+ * @interface ProductFieldsApiGetProductFieldRequest
+ */
+export interface ProductFieldsApiGetProductFieldRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductFieldsApiGetProductField
+     */
+    readonly id: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFieldsApiGetProductField
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listProductFieldTypes operation in ProductFieldsApi.
+ * @export
+ * @interface ProductFieldsApiListProductFieldTypesRequest
+ */
+export interface ProductFieldsApiListProductFieldTypesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFieldTypes
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listProductFields operation in ProductFieldsApi.
+ * @export
+ * @interface ProductFieldsApiListProductFieldsRequest
+ */
+export interface ProductFieldsApiListProductFieldsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch.
+     * @type {string}
+     * @memberof ProductFieldsApiListProductFields
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateProductField operation in ProductFieldsApi.
+ * @export
+ * @interface ProductFieldsApiUpdateProductFieldRequest
+ */
+export interface ProductFieldsApiUpdateProductFieldRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductFieldsApiUpdateProductField
+     */
+    readonly id: string;
+    /**
+     *
+     * @type {UpdateProductFieldRequestDto}
+     * @memberof ProductFieldsApiUpdateProductField
+     */
+    readonly updateProductFieldRequestDto: UpdateProductFieldRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFieldsApiUpdateProductField
+     */
+    readonly authorization?: string;
+}
+/**
+ * ProductFieldsApi - object-oriented interface
+ * @export
+ * @class ProductFieldsApi
+ * @extends {BaseAPI}
+ */
+export declare class ProductFieldsApi extends BaseAPI {
+    /**
+     * Create a product field in the database.
+     * @summary Create the product field
+     * @param {ProductFieldsApiCreateProductFieldRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    createProductField(requestParameters: ProductFieldsApiCreateProductFieldRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductFieldResponseClass, 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 {ProductFieldsApiDeleteProductFieldRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    deleteProductField(requestParameters: ProductFieldsApiDeleteProductFieldRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the product field that was previously created. Supply the unique product field id that was returned when you created it and Emil Api will return the corresponding product field information.
+     * @summary Retrieve the product field
+     * @param {ProductFieldsApiGetProductFieldRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    getProductField(requestParameters: ProductFieldsApiGetProductFieldRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductFieldResponseClass, any>>;
+    /**
+     * Returns a list of product field types you have previously created. The product field types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product field types
+     * @param {ProductFieldsApiListProductFieldTypesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    listProductFieldTypes(requestParameters?: ProductFieldsApiListProductFieldTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductFieldTypesResponseClass, any>>;
+    /**
+     * Returns a list of product fields you have previously created. The product fields are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product fields
+     * @param {ProductFieldsApiListProductFieldsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    listProductFields(requestParameters?: ProductFieldsApiListProductFieldsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductFieldsResponseClass, 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 {ProductFieldsApiUpdateProductFieldRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFieldsApi
+     */
+    updateProductField(requestParameters: ProductFieldsApiUpdateProductFieldRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateProductFieldResponseClass, any>>;
+}