@emilgroup/insurance-sdk-node 1.2.0 → 1.5.0

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

@@ -0,0 +1,493 @@
+/**
+ * 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 { GetProductFactorResponseClass } from '../models';
+import { GetProductFactorValueResponseClass } from '../models';
+import { GetProductFactorsForVersionResponseClass } from '../models';
+import { GroupedProductFactorsResponseClass } from '../models';
+import { ListProductFactorsResponseClass } from '../models';
+import { StoreProductFactorsResponseClass } from '../models';
+/**
+ * ProductFactorsApi - axios parameter creator
+ * @export
+ */
+export declare const ProductFactorsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieves the details of the product factor that was previously created. Supply the unique product factor id that was returned when you created it and Emil Api will return the corresponding product factor information.
+     * @summary Retrieve the product factor
+     * @param {number} id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactor: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the value corresponding to a specific product factor.
+     * @summary Get product factor value
+     * @param {number} productVersionId Product Version Id
+     * @param {string} label Product factor label
+     * @param {string} key Key for the product factor value
+     * @param {string} name Name for the product factor value
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactorValue: (productVersionId: number, label: string, key: string, name: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns product factors without values (values=none),     or with values if their number less or equal to 200 (values=short),     or with all values (values=all - this may take several seconds).
+     * @summary Returns all product factors for the product version.
+     * @param {number} productVersionId Unique identifier referencing the product Version.
+     * @param {string} values Which values to return for every factor (None or Short for short value lists only or All).
+     * @param {string} [authorization] Bearer Token
+     * @param {boolean} [forPublic] true if this is a call from PublicAPI or false otherwise (default).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactorsForVersion: (productVersionId: number, values: string, authorization?: string, forPublic?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of product factors you have previously created. The product factors are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product factors
+     * @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}
+     */
+    listProductFactors: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upload a CSV file containing product factors necessary for a product.     The columns must be in the following order: group,label,key,name,value. It is advised to validate     the file first.
+     * @summary Upload product factors
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [productVersionId]
+     * @param {any} [factors]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    storeProductFactors: (authorization?: string, productVersionId?: number, factors?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Validate a CSV file containing all product factors.     The columns must be in the following order: group,label,key,name,value.
+     * @summary Validate product factors
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [factors]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateProductFactors: (authorization?: string, factors?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductFactorsApi - functional programming interface
+ * @export
+ */
+export declare const ProductFactorsApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieves the details of the product factor that was previously created. Supply the unique product factor id that was returned when you created it and Emil Api will return the corresponding product factor information.
+     * @summary Retrieve the product factor
+     * @param {number} id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactor(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductFactorResponseClass>>;
+    /**
+     * Get the value corresponding to a specific product factor.
+     * @summary Get product factor value
+     * @param {number} productVersionId Product Version Id
+     * @param {string} label Product factor label
+     * @param {string} key Key for the product factor value
+     * @param {string} name Name for the product factor value
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactorValue(productVersionId: number, label: string, key: string, name: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductFactorValueResponseClass>>;
+    /**
+     * Returns product factors without values (values=none),     or with values if their number less or equal to 200 (values=short),     or with all values (values=all - this may take several seconds).
+     * @summary Returns all product factors for the product version.
+     * @param {number} productVersionId Unique identifier referencing the product Version.
+     * @param {string} values Which values to return for every factor (None or Short for short value lists only or All).
+     * @param {string} [authorization] Bearer Token
+     * @param {boolean} [forPublic] true if this is a call from PublicAPI or false otherwise (default).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactorsForVersion(productVersionId: number, values: string, authorization?: string, forPublic?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductFactorsForVersionResponseClass>>;
+    /**
+     * Returns a list of product factors you have previously created. The product factors are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product factors
+     * @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}
+     */
+    listProductFactors(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductFactorsResponseClass>>;
+    /**
+     * Upload a CSV file containing product factors necessary for a product.     The columns must be in the following order: group,label,key,name,value. It is advised to validate     the file first.
+     * @summary Upload product factors
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [productVersionId]
+     * @param {any} [factors]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    storeProductFactors(authorization?: string, productVersionId?: number, factors?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreProductFactorsResponseClass>>;
+    /**
+     * Validate a CSV file containing all product factors.     The columns must be in the following order: group,label,key,name,value.
+     * @summary Validate product factors
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [factors]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateProductFactors(authorization?: string, factors?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupedProductFactorsResponseClass>>;
+};
+/**
+ * ProductFactorsApi - factory interface
+ * @export
+ */
+export declare const ProductFactorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Retrieves the details of the product factor that was previously created. Supply the unique product factor id that was returned when you created it and Emil Api will return the corresponding product factor information.
+     * @summary Retrieve the product factor
+     * @param {number} id
+     * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactor(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetProductFactorResponseClass>;
+    /**
+     * Get the value corresponding to a specific product factor.
+     * @summary Get product factor value
+     * @param {number} productVersionId Product Version Id
+     * @param {string} label Product factor label
+     * @param {string} key Key for the product factor value
+     * @param {string} name Name for the product factor value
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactorValue(productVersionId: number, label: string, key: string, name: string, authorization?: string, options?: any): AxiosPromise<GetProductFactorValueResponseClass>;
+    /**
+     * Returns product factors without values (values=none),     or with values if their number less or equal to 200 (values=short),     or with all values (values=all - this may take several seconds).
+     * @summary Returns all product factors for the product version.
+     * @param {number} productVersionId Unique identifier referencing the product Version.
+     * @param {string} values Which values to return for every factor (None or Short for short value lists only or All).
+     * @param {string} [authorization] Bearer Token
+     * @param {boolean} [forPublic] true if this is a call from PublicAPI or false otherwise (default).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductFactorsForVersion(productVersionId: number, values: string, authorization?: string, forPublic?: boolean, options?: any): AxiosPromise<GetProductFactorsForVersionResponseClass>;
+    /**
+     * Returns a list of product factors you have previously created. The product factors are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product factors
+     * @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}
+     */
+    listProductFactors(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductFactorsResponseClass>;
+    /**
+     * Upload a CSV file containing product factors necessary for a product.     The columns must be in the following order: group,label,key,name,value. It is advised to validate     the file first.
+     * @summary Upload product factors
+     * @param {string} [authorization] Bearer Token
+     * @param {number} [productVersionId]
+     * @param {any} [factors]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    storeProductFactors(authorization?: string, productVersionId?: number, factors?: any, options?: any): AxiosPromise<StoreProductFactorsResponseClass>;
+    /**
+     * Validate a CSV file containing all product factors.     The columns must be in the following order: group,label,key,name,value.
+     * @summary Validate product factors
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [factors]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    validateProductFactors(authorization?: string, factors?: any, options?: any): AxiosPromise<GroupedProductFactorsResponseClass>;
+};
+/**
+ * Request parameters for getProductFactor operation in ProductFactorsApi.
+ * @export
+ * @interface ProductFactorsApiGetProductFactorRequest
+ */
+export interface ProductFactorsApiGetProductFactorRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ProductFactorsApiGetProductFactor
+     */
+    readonly id: number;
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof ProductFactorsApiGetProductFactor
+     */
+    readonly id2: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactor
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactor
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for getProductFactorValue operation in ProductFactorsApi.
+ * @export
+ * @interface ProductFactorsApiGetProductFactorValueRequest
+ */
+export interface ProductFactorsApiGetProductFactorValueRequest {
+    /**
+     * Product Version Id
+     * @type {number}
+     * @memberof ProductFactorsApiGetProductFactorValue
+     */
+    readonly productVersionId: number;
+    /**
+     * Product factor label
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactorValue
+     */
+    readonly label: string;
+    /**
+     * Key for the product factor value
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactorValue
+     */
+    readonly key: string;
+    /**
+     * Name for the product factor value
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactorValue
+     */
+    readonly name: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactorValue
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getProductFactorsForVersion operation in ProductFactorsApi.
+ * @export
+ * @interface ProductFactorsApiGetProductFactorsForVersionRequest
+ */
+export interface ProductFactorsApiGetProductFactorsForVersionRequest {
+    /**
+     * Unique identifier referencing the product Version.
+     * @type {number}
+     * @memberof ProductFactorsApiGetProductFactorsForVersion
+     */
+    readonly productVersionId: number;
+    /**
+     * Which values to return for every factor (None or Short for short value lists only or All).
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactorsForVersion
+     */
+    readonly values: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFactorsApiGetProductFactorsForVersion
+     */
+    readonly authorization?: string;
+    /**
+     * true if this is a call from PublicAPI or false otherwise (default).
+     * @type {boolean}
+     * @memberof ProductFactorsApiGetProductFactorsForVersion
+     */
+    readonly forPublic?: boolean;
+}
+/**
+ * Request parameters for listProductFactors operation in ProductFactorsApi.
+ * @export
+ * @interface ProductFactorsApiListProductFactorsRequest
+ */
+export interface ProductFactorsApiListProductFactorsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria.
+     * @type {string}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch.
+     * @type {string}
+     * @memberof ProductFactorsApiListProductFactors
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for storeProductFactors operation in ProductFactorsApi.
+ * @export
+ * @interface ProductFactorsApiStoreProductFactorsRequest
+ */
+export interface ProductFactorsApiStoreProductFactorsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFactorsApiStoreProductFactors
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ProductFactorsApiStoreProductFactors
+     */
+    readonly productVersionId?: number;
+    /**
+     *
+     * @type {any}
+     * @memberof ProductFactorsApiStoreProductFactors
+     */
+    readonly factors?: any;
+}
+/**
+ * Request parameters for validateProductFactors operation in ProductFactorsApi.
+ * @export
+ * @interface ProductFactorsApiValidateProductFactorsRequest
+ */
+export interface ProductFactorsApiValidateProductFactorsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductFactorsApiValidateProductFactors
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof ProductFactorsApiValidateProductFactors
+     */
+    readonly factors?: any;
+}
+/**
+ * ProductFactorsApi - object-oriented interface
+ * @export
+ * @class ProductFactorsApi
+ * @extends {BaseAPI}
+ */
+export declare class ProductFactorsApi extends BaseAPI {
+    /**
+     * Retrieves the details of the product factor that was previously created. Supply the unique product factor id that was returned when you created it and Emil Api will return the corresponding product factor information.
+     * @summary Retrieve the product factor
+     * @param {ProductFactorsApiGetProductFactorRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFactorsApi
+     */
+    getProductFactor(requestParameters: ProductFactorsApiGetProductFactorRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductFactorResponseClass, any>>;
+    /**
+     * Get the value corresponding to a specific product factor.
+     * @summary Get product factor value
+     * @param {ProductFactorsApiGetProductFactorValueRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFactorsApi
+     */
+    getProductFactorValue(requestParameters: ProductFactorsApiGetProductFactorValueRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductFactorValueResponseClass, any>>;
+    /**
+     * Returns product factors without values (values=none),     or with values if their number less or equal to 200 (values=short),     or with all values (values=all - this may take several seconds).
+     * @summary Returns all product factors for the product version.
+     * @param {ProductFactorsApiGetProductFactorsForVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFactorsApi
+     */
+    getProductFactorsForVersion(requestParameters: ProductFactorsApiGetProductFactorsForVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductFactorsForVersionResponseClass, any>>;
+    /**
+     * Returns a list of product factors you have previously created. The product factors are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product factors
+     * @param {ProductFactorsApiListProductFactorsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFactorsApi
+     */
+    listProductFactors(requestParameters?: ProductFactorsApiListProductFactorsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductFactorsResponseClass, any>>;
+    /**
+     * Upload a CSV file containing product factors necessary for a product.     The columns must be in the following order: group,label,key,name,value. It is advised to validate     the file first.
+     * @summary Upload product factors
+     * @param {ProductFactorsApiStoreProductFactorsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFactorsApi
+     */
+    storeProductFactors(requestParameters?: ProductFactorsApiStoreProductFactorsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreProductFactorsResponseClass, any>>;
+    /**
+     * Validate a CSV file containing all product factors.     The columns must be in the following order: group,label,key,name,value.
+     * @summary Validate product factors
+     * @param {ProductFactorsApiValidateProductFactorsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductFactorsApi
+     */
+    validateProductFactors(requestParameters?: ProductFactorsApiValidateProductFactorsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupedProductFactorsResponseClass, any>>;
+}