@emilgroup/claim-sdk-node 1.3.0 → 1.4.0

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

@@ -0,0 +1,430 @@
+/**
+ * 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 { CreateSettlementRequestDto } from '../models';
+import { CreateSettlementResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetSettlementResponseClass } from '../models';
+import { ListSettlementsResponseClass } from '../models';
+import { UpdateSettlementRequestDto } from '../models';
+import { UpdateSettlementResponseClass } from '../models';
+/**
+ * SettlementsApi - axios parameter creator
+ * @export
+ */
+export declare const SettlementsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a settlement against a claim in the database
+     * @summary Create the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {CreateSettlementRequestDto} createSettlementRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSettlement: (authorization: string, claimCode: string, createSettlementRequestDto: CreateSettlementRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete the requested settlement from the database.
+     * @summary Delete the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} code
+     * @param {string} claimCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSettlement: (authorization: string, code: string, claimCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
+     * @summary Retrieve the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} code
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlement: (authorization: string, claimCode: string, code: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List settlements
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} claimCode2 The identifier code of the claim.
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: claimCode, accountNumber
+     * @param {string} [search] Searching the response for a pattern to match for specific request results
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order.      Default: ASC
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones.      Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size. Parameters: claim.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSettlements: (authorization: string, claimCode: string, claimCode2: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} code
+     * @param {UpdateSettlementRequestDto} updateSettlementRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSettlement: (authorization: string, claimCode: string, code: string, updateSettlementRequestDto: UpdateSettlementRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SettlementsApi - functional programming interface
+ * @export
+ */
+export declare const SettlementsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a settlement against a claim in the database
+     * @summary Create the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {CreateSettlementRequestDto} createSettlementRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSettlement(authorization: string, claimCode: string, createSettlementRequestDto: CreateSettlementRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettlementResponseClass>>;
+    /**
+     * This will delete the requested settlement from the database.
+     * @summary Delete the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} code
+     * @param {string} claimCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSettlement(authorization: string, code: string, claimCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
+     * @summary Retrieve the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} code
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlement(authorization: string, claimCode: string, code: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementResponseClass>>;
+    /**
+     * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List settlements
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} claimCode2 The identifier code of the claim.
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: claimCode, accountNumber
+     * @param {string} [search] Searching the response for a pattern to match for specific request results
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order.      Default: ASC
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones.      Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size. Parameters: claim.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSettlements(authorization: string, claimCode: string, claimCode2: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettlementsResponseClass>>;
+    /**
+     * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} code
+     * @param {UpdateSettlementRequestDto} updateSettlementRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSettlement(authorization: string, claimCode: string, code: string, updateSettlementRequestDto: UpdateSettlementRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSettlementResponseClass>>;
+};
+/**
+ * SettlementsApi - factory interface
+ * @export
+ */
+export declare const SettlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a settlement against a claim in the database
+     * @summary Create the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {CreateSettlementRequestDto} createSettlementRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSettlement(authorization: string, claimCode: string, createSettlementRequestDto: CreateSettlementRequestDto, options?: any): AxiosPromise<CreateSettlementResponseClass>;
+    /**
+     * This will delete the requested settlement from the database.
+     * @summary Delete the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} code
+     * @param {string} claimCode
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSettlement(authorization: string, code: string, claimCode: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
+     * @summary Retrieve the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} code
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSettlement(authorization: string, claimCode: string, code: string, options?: any): AxiosPromise<GetSettlementResponseClass>;
+    /**
+     * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List settlements
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} claimCode2 The identifier code of the claim.
+     * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: claimCode, accountNumber
+     * @param {string} [search] Searching the response for a pattern to match for specific request results
+     * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order.      Default: ASC
+     * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones.      Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size. Parameters: claim.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSettlements(authorization: string, claimCode: string, claimCode2: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListSettlementsResponseClass>;
+    /**
+     * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the settlement
+     * @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} claimCode
+     * @param {string} code
+     * @param {UpdateSettlementRequestDto} updateSettlementRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSettlement(authorization: string, claimCode: string, code: string, updateSettlementRequestDto: UpdateSettlementRequestDto, options?: any): AxiosPromise<UpdateSettlementResponseClass>;
+};
+/**
+ * Request parameters for createSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiCreateSettlementRequest
+ */
+export interface SettlementsApiCreateSettlementRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiCreateSettlement
+     */
+    readonly authorization: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiCreateSettlement
+     */
+    readonly claimCode: string;
+    /**
+     *
+     * @type {CreateSettlementRequestDto}
+     * @memberof SettlementsApiCreateSettlement
+     */
+    readonly createSettlementRequestDto: CreateSettlementRequestDto;
+}
+/**
+ * Request parameters for deleteSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiDeleteSettlementRequest
+ */
+export interface SettlementsApiDeleteSettlementRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiDeleteSettlement
+     */
+    readonly authorization: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiDeleteSettlement
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiDeleteSettlement
+     */
+    readonly claimCode: string;
+}
+/**
+ * Request parameters for getSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiGetSettlementRequest
+ */
+export interface SettlementsApiGetSettlementRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiGetSettlement
+     */
+    readonly authorization: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiGetSettlement
+     */
+    readonly claimCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiGetSettlement
+     */
+    readonly code: string;
+}
+/**
+ * Request parameters for listSettlements operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiListSettlementsRequest
+ */
+export interface SettlementsApiListSettlementsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly authorization: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly claimCode: string;
+    /**
+     * The identifier code of the claim.
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly claimCode2: string;
+    /**
+     * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
+     * @type {number}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly pageSize?: number;
+    /**
+     * A cursor for use in pagination. pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.      Parameters: claimCode, accountNumber
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly filter?: string;
+    /**
+     * Searching the response for a pattern to match for specific request results
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly search?: string;
+    /**
+     * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order.      Default: ASC
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly order?: string;
+    /**
+     * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones.      Expanding resources can reduce the number of API calls required to accomplish a task.      However, use this with parsimony as some expanded fields can drastically increase payload size. Parameters: claim.
+     * @type {string}
+     * @memberof SettlementsApiListSettlements
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updateSettlement operation in SettlementsApi.
+ * @export
+ * @interface SettlementsApiUpdateSettlementRequest
+ */
+export interface SettlementsApiUpdateSettlementRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettlementsApiUpdateSettlement
+     */
+    readonly authorization: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiUpdateSettlement
+     */
+    readonly claimCode: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SettlementsApiUpdateSettlement
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateSettlementRequestDto}
+     * @memberof SettlementsApiUpdateSettlement
+     */
+    readonly updateSettlementRequestDto: UpdateSettlementRequestDto;
+}
+/**
+ * SettlementsApi - object-oriented interface
+ * @export
+ * @class SettlementsApi
+ * @extends {BaseAPI}
+ */
+export declare class SettlementsApi extends BaseAPI {
+    /**
+     * This will create a settlement against a claim in the database
+     * @summary Create the settlement
+     * @param {SettlementsApiCreateSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    createSettlement(requestParameters: SettlementsApiCreateSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSettlementResponseClass, any>>;
+    /**
+     * This will delete the requested settlement from the database.
+     * @summary Delete the settlement
+     * @param {SettlementsApiDeleteSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    deleteSettlement(requestParameters: SettlementsApiDeleteSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
+     * @summary Retrieve the settlement
+     * @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    getSettlement(requestParameters: SettlementsApiGetSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementResponseClass, any>>;
+    /**
+     * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List settlements
+     * @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    listSettlements(requestParameters: SettlementsApiListSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSettlementsResponseClass, any>>;
+    /**
+     * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the settlement
+     * @param {SettlementsApiUpdateSettlementRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettlementsApi
+     */
+    updateSettlement(requestParameters: SettlementsApiUpdateSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateSettlementResponseClass, any>>;
+}