@emilgroup/insurance-sdk-node 1.36.0 → 1.36.1

package/dist/api/insured-objects-api.d.ts

@@ -0,0 +1,318 @@
+/**
+ * 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 { CreateInsuredObjectRequestDto } from '../models';
+import { CreateInsuredObjectResponseClass } from '../models';
+import { GetInsuredObjectResponseClass } from '../models';
+import { ListInsuredObjectsResponseClass } from '../models';
+/**
+ * InsuredObjectsApi - axios parameter creator
+ * @export
+ */
+export declare const InsuredObjectsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates an insured object.
+     * @summary Create the insured object
+     * @param {CreateInsuredObjectRequestDto} createInsuredObjectRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInsuredObject: (createInsuredObjectRequestDto: CreateInsuredObjectRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the insured object. Supply the unique id that was returned when you created the insured object and this will delete it.
+     * @summary Delete the insured object
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteInsuredObject: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the insured object that was previously created. Supply the unique insured object id that was returned when you created it and Emil Api will return the corresponding insured object information.
+     * @summary Retrieve the insured object
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsuredObject: (id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of insured objects you have previously created. The insured objects are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List insured objects
+     * @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}
+     */
+    listInsuredObjects: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * InsuredObjectsApi - functional programming interface
+ * @export
+ */
+export declare const InsuredObjectsApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates an insured object.
+     * @summary Create the insured object
+     * @param {CreateInsuredObjectRequestDto} createInsuredObjectRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInsuredObject(createInsuredObjectRequestDto: CreateInsuredObjectRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInsuredObjectResponseClass>>;
+    /**
+     * Permanently deletes the insured object. Supply the unique id that was returned when you created the insured object and this will delete it.
+     * @summary Delete the insured object
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteInsuredObject(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Retrieves the details of the insured object that was previously created. Supply the unique insured object id that was returned when you created it and Emil Api will return the corresponding insured object information.
+     * @summary Retrieve the insured object
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsuredObject(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInsuredObjectResponseClass>>;
+    /**
+     * Returns a list of insured objects you have previously created. The insured objects are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List insured objects
+     * @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}
+     */
+    listInsuredObjects(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInsuredObjectsResponseClass>>;
+};
+/**
+ * InsuredObjectsApi - factory interface
+ * @export
+ */
+export declare const InsuredObjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates an insured object.
+     * @summary Create the insured object
+     * @param {CreateInsuredObjectRequestDto} createInsuredObjectRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createInsuredObject(createInsuredObjectRequestDto: CreateInsuredObjectRequestDto, authorization?: string, options?: any): AxiosPromise<CreateInsuredObjectResponseClass>;
+    /**
+     * Permanently deletes the insured object. Supply the unique id that was returned when you created the insured object and this will delete it.
+     * @summary Delete the insured object
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteInsuredObject(id: number, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Retrieves the details of the insured object that was previously created. Supply the unique insured object id that was returned when you created it and Emil Api will return the corresponding insured object information.
+     * @summary Retrieve the insured object
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Fields to expand response by.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInsuredObject(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetInsuredObjectResponseClass>;
+    /**
+     * Returns a list of insured objects you have previously created. The insured objects are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List insured objects
+     * @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}
+     */
+    listInsuredObjects(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListInsuredObjectsResponseClass>;
+};
+/**
+ * Request parameters for createInsuredObject operation in InsuredObjectsApi.
+ * @export
+ * @interface InsuredObjectsApiCreateInsuredObjectRequest
+ */
+export interface InsuredObjectsApiCreateInsuredObjectRequest {
+    /**
+     *
+     * @type {CreateInsuredObjectRequestDto}
+     * @memberof InsuredObjectsApiCreateInsuredObject
+     */
+    readonly createInsuredObjectRequestDto: CreateInsuredObjectRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof InsuredObjectsApiCreateInsuredObject
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteInsuredObject operation in InsuredObjectsApi.
+ * @export
+ * @interface InsuredObjectsApiDeleteInsuredObjectRequest
+ */
+export interface InsuredObjectsApiDeleteInsuredObjectRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof InsuredObjectsApiDeleteInsuredObject
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof InsuredObjectsApiDeleteInsuredObject
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getInsuredObject operation in InsuredObjectsApi.
+ * @export
+ * @interface InsuredObjectsApiGetInsuredObjectRequest
+ */
+export interface InsuredObjectsApiGetInsuredObjectRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof InsuredObjectsApiGetInsuredObject
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof InsuredObjectsApiGetInsuredObject
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by.
+     * @type {string}
+     * @memberof InsuredObjectsApiGetInsuredObject
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listInsuredObjects operation in InsuredObjectsApi.
+ * @export
+ * @interface InsuredObjectsApiListInsuredObjectsRequest
+ */
+export interface InsuredObjectsApiListInsuredObjectsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria.
+     * @type {string}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch.
+     * @type {string}
+     * @memberof InsuredObjectsApiListInsuredObjects
+     */
+    readonly expand?: string;
+}
+/**
+ * InsuredObjectsApi - object-oriented interface
+ * @export
+ * @class InsuredObjectsApi
+ * @extends {BaseAPI}
+ */
+export declare class InsuredObjectsApi extends BaseAPI {
+    /**
+     * Creates an insured object.
+     * @summary Create the insured object
+     * @param {InsuredObjectsApiCreateInsuredObjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InsuredObjectsApi
+     */
+    createInsuredObject(requestParameters: InsuredObjectsApiCreateInsuredObjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateInsuredObjectResponseClass, any>>;
+    /**
+     * Permanently deletes the insured object. Supply the unique id that was returned when you created the insured object and this will delete it.
+     * @summary Delete the insured object
+     * @param {InsuredObjectsApiDeleteInsuredObjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InsuredObjectsApi
+     */
+    deleteInsuredObject(requestParameters: InsuredObjectsApiDeleteInsuredObjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Retrieves the details of the insured object that was previously created. Supply the unique insured object id that was returned when you created it and Emil Api will return the corresponding insured object information.
+     * @summary Retrieve the insured object
+     * @param {InsuredObjectsApiGetInsuredObjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InsuredObjectsApi
+     */
+    getInsuredObject(requestParameters: InsuredObjectsApiGetInsuredObjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInsuredObjectResponseClass, any>>;
+    /**
+     * Returns a list of insured objects you have previously created. The insured objects are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List insured objects
+     * @param {InsuredObjectsApiListInsuredObjectsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InsuredObjectsApi
+     */
+    listInsuredObjects(requestParameters?: InsuredObjectsApiListInsuredObjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInsuredObjectsResponseClass, any>>;
+}