@emilgroup/claim-sdk 1.17.2-beta.1 → 1.17.2-beta.3

package/dist/api/claim-regulations-api.d.ts

@@ -0,0 +1,372 @@
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService 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 { CreateRegulationItemRequestDto } from '../models';
+import { ListRegulationsResponseClass } from '../models';
+import { RegulationItemResponseClass } from '../models';
+/**
+ * ClaimRegulationsApi - axios parameter creator
+ * @export
+ */
+export declare const ClaimRegulationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This endpoint will create a new regulation item for a claim
+     * @summary Create the claim regulation item
+     * @param {CreateRegulationItemRequestDto} createRegulationItemRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimRegulation: (createRegulationItemRequestDto: CreateRegulationItemRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete the regulation item identified by the code.
+     * @summary Delete the claim regulation item
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimRegulations: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the claim regulation item that was previously created. Supply the unique claim regulation item code        that was returned when you created it and Emil Api will return the corresponding claim regulation item information.
+     * @summary Retrieve the claim regulation item
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'claim'} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimRegulation: (code: string, authorization?: string, expand?: 'claim', options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of claim regulation items you have previously created.          The claim regulation items are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List claim regulation items
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, claimCode, amount, bookingDate, currency&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: amount, bookingDate, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: claim.&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listClaimRegulations: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a regulation item status and some other fields identified by it\'s code. A Regulation item type cannot be changed once created e.g. to change a regulation from PAYOUT to RESERVE. In case of mistakes the current regulation item should be deleted and another item should be created.
+     * @summary Update the claim regulation item
+     * @param {string} code Unique identifier for the object.
+     * @param {object} body
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaimRegulation: (code: string, body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ClaimRegulationsApi - functional programming interface
+ * @export
+ */
+export declare const ClaimRegulationsApiFp: (configuration?: Configuration) => {
+    /**
+     * This endpoint will create a new regulation item for a claim
+     * @summary Create the claim regulation item
+     * @param {CreateRegulationItemRequestDto} createRegulationItemRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimRegulation(createRegulationItemRequestDto: CreateRegulationItemRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegulationItemResponseClass>>;
+    /**
+     * This will delete the regulation item identified by the code.
+     * @summary Delete the claim regulation item
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimRegulations(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the details of the claim regulation item that was previously created. Supply the unique claim regulation item code        that was returned when you created it and Emil Api will return the corresponding claim regulation item information.
+     * @summary Retrieve the claim regulation item
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'claim'} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimRegulation(code: string, authorization?: string, expand?: 'claim', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegulationItemResponseClass>>;
+    /**
+     * Returns a list of claim regulation items you have previously created.          The claim regulation items are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List claim regulation items
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, claimCode, amount, bookingDate, currency&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: amount, bookingDate, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: claim.&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listClaimRegulations(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRegulationsResponseClass>>;
+    /**
+     * Update a regulation item status and some other fields identified by it\'s code. A Regulation item type cannot be changed once created e.g. to change a regulation from PAYOUT to RESERVE. In case of mistakes the current regulation item should be deleted and another item should be created.
+     * @summary Update the claim regulation item
+     * @param {string} code Unique identifier for the object.
+     * @param {object} body
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaimRegulation(code: string, body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegulationItemResponseClass>>;
+};
+/**
+ * ClaimRegulationsApi - factory interface
+ * @export
+ */
+export declare const ClaimRegulationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This endpoint will create a new regulation item for a claim
+     * @summary Create the claim regulation item
+     * @param {CreateRegulationItemRequestDto} createRegulationItemRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimRegulation(createRegulationItemRequestDto: CreateRegulationItemRequestDto, authorization?: string, options?: any): AxiosPromise<RegulationItemResponseClass>;
+    /**
+     * This will delete the regulation item identified by the code.
+     * @summary Delete the claim regulation item
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimRegulations(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves the details of the claim regulation item that was previously created. Supply the unique claim regulation item code        that was returned when you created it and Emil Api will return the corresponding claim regulation item information.
+     * @summary Retrieve the claim regulation item
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {'claim'} [expand]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimRegulation(code: string, authorization?: string, expand?: 'claim', options?: any): AxiosPromise<RegulationItemResponseClass>;
+    /**
+     * Returns a list of claim regulation items you have previously created.          The claim regulation items are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List claim regulation items
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, claimCode, amount, bookingDate, currency&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: amount, bookingDate, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: claim.&lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listClaimRegulations(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRegulationsResponseClass>;
+    /**
+     * Update a regulation item status and some other fields identified by it\'s code. A Regulation item type cannot be changed once created e.g. to change a regulation from PAYOUT to RESERVE. In case of mistakes the current regulation item should be deleted and another item should be created.
+     * @summary Update the claim regulation item
+     * @param {string} code Unique identifier for the object.
+     * @param {object} body
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaimRegulation(code: string, body: object, authorization?: string, options?: any): AxiosPromise<RegulationItemResponseClass>;
+};
+/**
+ * Request parameters for createClaimRegulation operation in ClaimRegulationsApi.
+ * @export
+ * @interface ClaimRegulationsApiCreateClaimRegulationRequest
+ */
+export interface ClaimRegulationsApiCreateClaimRegulationRequest {
+    /**
+     *
+     * @type {CreateRegulationItemRequestDto}
+     * @memberof ClaimRegulationsApiCreateClaimRegulation
+     */
+    readonly createRegulationItemRequestDto: CreateRegulationItemRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimRegulationsApiCreateClaimRegulation
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteClaimRegulations operation in ClaimRegulationsApi.
+ * @export
+ * @interface ClaimRegulationsApiDeleteClaimRegulationsRequest
+ */
+export interface ClaimRegulationsApiDeleteClaimRegulationsRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ClaimRegulationsApiDeleteClaimRegulations
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimRegulationsApiDeleteClaimRegulations
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getClaimRegulation operation in ClaimRegulationsApi.
+ * @export
+ * @interface ClaimRegulationsApiGetClaimRegulationRequest
+ */
+export interface ClaimRegulationsApiGetClaimRegulationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ClaimRegulationsApiGetClaimRegulation
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimRegulationsApiGetClaimRegulation
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {'claim'}
+     * @memberof ClaimRegulationsApiGetClaimRegulation
+     */
+    readonly expand?: 'claim';
+}
+/**
+ * Request parameters for listClaimRegulations operation in ClaimRegulationsApi.
+ * @export
+ * @interface ClaimRegulationsApiListClaimRegulationsRequest
+ */
+export interface ClaimRegulationsApiListClaimRegulationsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimRegulationsApiListClaimRegulations
+     */
+    readonly authorization?: string;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @type {string}
+     * @memberof ClaimRegulationsApiListClaimRegulations
+     */
+    readonly filter?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, claimCode, amount, bookingDate, currency, regulationItemType, payoutType, regressType, reserveType, payoutStatus, regressStatus&lt;/i&gt;
+     * @type {string}
+     * @memberof ClaimRegulationsApiListClaimRegulations
+     */
+    readonly filters?: string;
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, claimCode, amount, bookingDate, currency&lt;/i&gt;
+     * @type {string}
+     * @memberof ClaimRegulationsApiListClaimRegulations
+     */
+    readonly search?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: amount, bookingDate, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ClaimRegulationsApiListClaimRegulations
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: claim.&lt;i&gt;
+     * @type {string}
+     * @memberof ClaimRegulationsApiListClaimRegulations
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateClaimRegulation operation in ClaimRegulationsApi.
+ * @export
+ * @interface ClaimRegulationsApiUpdateClaimRegulationRequest
+ */
+export interface ClaimRegulationsApiUpdateClaimRegulationRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ClaimRegulationsApiUpdateClaimRegulation
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {object}
+     * @memberof ClaimRegulationsApiUpdateClaimRegulation
+     */
+    readonly body: object;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimRegulationsApiUpdateClaimRegulation
+     */
+    readonly authorization?: string;
+}
+/**
+ * ClaimRegulationsApi - object-oriented interface
+ * @export
+ * @class ClaimRegulationsApi
+ * @extends {BaseAPI}
+ */
+export declare class ClaimRegulationsApi extends BaseAPI {
+    /**
+     * This endpoint will create a new regulation item for a claim
+     * @summary Create the claim regulation item
+     * @param {ClaimRegulationsApiCreateClaimRegulationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimRegulationsApi
+     */
+    createClaimRegulation(requestParameters: ClaimRegulationsApiCreateClaimRegulationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RegulationItemResponseClass, any>>;
+    /**
+     * This will delete the regulation item identified by the code.
+     * @summary Delete the claim regulation item
+     * @param {ClaimRegulationsApiDeleteClaimRegulationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimRegulationsApi
+     */
+    deleteClaimRegulations(requestParameters: ClaimRegulationsApiDeleteClaimRegulationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the details of the claim regulation item that was previously created. Supply the unique claim regulation item code        that was returned when you created it and Emil Api will return the corresponding claim regulation item information.
+     * @summary Retrieve the claim regulation item
+     * @param {ClaimRegulationsApiGetClaimRegulationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimRegulationsApi
+     */
+    getClaimRegulation(requestParameters: ClaimRegulationsApiGetClaimRegulationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RegulationItemResponseClass, any>>;
+    /**
+     * Returns a list of claim regulation items you have previously created.          The claim regulation items are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List claim regulation items
+     * @param {ClaimRegulationsApiListClaimRegulationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimRegulationsApi
+     */
+    listClaimRegulations(requestParameters?: ClaimRegulationsApiListClaimRegulationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRegulationsResponseClass, any>>;
+    /**
+     * Update a regulation item status and some other fields identified by it\'s code. A Regulation item type cannot be changed once created e.g. to change a regulation from PAYOUT to RESERVE. In case of mistakes the current regulation item should be deleted and another item should be created.
+     * @summary Update the claim regulation item
+     * @param {ClaimRegulationsApiUpdateClaimRegulationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimRegulationsApi
+     */
+    updateClaimRegulation(requestParameters: ClaimRegulationsApiUpdateClaimRegulationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RegulationItemResponseClass, any>>;
+}