@emilgroup/claim-sdk-node 1.10.0 → 1.16.0

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

@@ -0,0 +1,318 @@
+/**
+ * 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 { CreateClaimStatusRequestDto } from '../models';
+import { CreateClaimStatusResponseClass } from '../models';
+import { GetClaimStatusResponseClass } from '../models';
+import { ListClaimStatusesResponseClass } from '../models';
+/**
+ * ClaimStatusesApi - axios parameter creator
+ * @export
+ */
+export declare const ClaimStatusesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This creates a claim status in the database
+     * @summary Create the claim status
+     * @param {CreateClaimStatusRequestDto} createClaimStatusRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimStatus: (createClaimStatusRequestDto: CreateClaimStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the claim status. Supply the unique id that was returned when you created the claim status and this will delete it.
+     * @summary Delete the claim status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimStatus: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the claim status that was previously created. Supply the unique claim status id that was returned when you created it and Emil Api will return the corresponding claim status information.
+     * @summary Retrieve the claim status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimStatus: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of claim statuses you have previously created. The claim statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim statuses
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [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 {'id' | 'name' | 'productSlug'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [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 {any} [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.
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listClaimStatuses: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'id' | 'name' | 'productSlug', search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ClaimStatusesApi - functional programming interface
+ * @export
+ */
+export declare const ClaimStatusesApiFp: (configuration?: Configuration) => {
+    /**
+     * This creates a claim status in the database
+     * @summary Create the claim status
+     * @param {CreateClaimStatusRequestDto} createClaimStatusRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimStatus(createClaimStatusRequestDto: CreateClaimStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateClaimStatusResponseClass>>;
+    /**
+     * Permanently deletes the claim status. Supply the unique id that was returned when you created the claim status and this will delete it.
+     * @summary Delete the claim status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimStatus(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the details of the claim status that was previously created. Supply the unique claim status id that was returned when you created it and Emil Api will return the corresponding claim status information.
+     * @summary Retrieve the claim status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimStatus(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClaimStatusResponseClass>>;
+    /**
+     * Returns a list of claim statuses you have previously created. The claim statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim statuses
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [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 {'id' | 'name' | 'productSlug'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [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 {any} [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.
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listClaimStatuses(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'id' | 'name' | 'productSlug', search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListClaimStatusesResponseClass>>;
+};
+/**
+ * ClaimStatusesApi - factory interface
+ * @export
+ */
+export declare const ClaimStatusesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This creates a claim status in the database
+     * @summary Create the claim status
+     * @param {CreateClaimStatusRequestDto} createClaimStatusRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimStatus(createClaimStatusRequestDto: CreateClaimStatusRequestDto, authorization?: string, options?: any): AxiosPromise<CreateClaimStatusResponseClass>;
+    /**
+     * Permanently deletes the claim status. Supply the unique id that was returned when you created the claim status and this will delete it.
+     * @summary Delete the claim status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimStatus(id: number, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves the details of the claim status that was previously created. Supply the unique claim status id that was returned when you created it and Emil Api will return the corresponding claim status information.
+     * @summary Retrieve the claim status
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimStatus(id: number, authorization?: string, options?: any): AxiosPromise<GetClaimStatusResponseClass>;
+    /**
+     * Returns a list of claim statuses you have previously created. The claim statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim statuses
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @param {any} [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 {'id' | 'name' | 'productSlug'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [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 {any} [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.
+     * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listClaimStatuses(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'id' | 'name' | 'productSlug', search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListClaimStatusesResponseClass>;
+};
+/**
+ * Request parameters for createClaimStatus operation in ClaimStatusesApi.
+ * @export
+ * @interface ClaimStatusesApiCreateClaimStatusRequest
+ */
+export interface ClaimStatusesApiCreateClaimStatusRequest {
+    /**
+     *
+     * @type {CreateClaimStatusRequestDto}
+     * @memberof ClaimStatusesApiCreateClaimStatus
+     */
+    readonly createClaimStatusRequestDto: CreateClaimStatusRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimStatusesApiCreateClaimStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteClaimStatus operation in ClaimStatusesApi.
+ * @export
+ * @interface ClaimStatusesApiDeleteClaimStatusRequest
+ */
+export interface ClaimStatusesApiDeleteClaimStatusRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ClaimStatusesApiDeleteClaimStatus
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimStatusesApiDeleteClaimStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getClaimStatus operation in ClaimStatusesApi.
+ * @export
+ * @interface ClaimStatusesApiGetClaimStatusRequest
+ */
+export interface ClaimStatusesApiGetClaimStatusRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ClaimStatusesApiGetClaimStatus
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimStatusesApiGetClaimStatus
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listClaimStatuses operation in ClaimStatusesApi.
+ * @export
+ * @interface ClaimStatusesApiListClaimStatusesRequest
+ */
+export interface ClaimStatusesApiListClaimStatusesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly pageSize?: any;
+    /**
+     * 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 {any}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {'id' | 'name' | 'productSlug'}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly filter?: 'id' | 'name' | 'productSlug';
+    /**
+     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @type {any}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly search?: any;
+    /**
+     * 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 {any}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly order?: any;
+    /**
+     * 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.
+     * @type {any}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly expand?: any;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {any}
+     * @memberof ClaimStatusesApiListClaimStatuses
+     */
+    readonly filters?: any;
+}
+/**
+ * ClaimStatusesApi - object-oriented interface
+ * @export
+ * @class ClaimStatusesApi
+ * @extends {BaseAPI}
+ */
+export declare class ClaimStatusesApi extends BaseAPI {
+    /**
+     * This creates a claim status in the database
+     * @summary Create the claim status
+     * @param {ClaimStatusesApiCreateClaimStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimStatusesApi
+     */
+    createClaimStatus(requestParameters: ClaimStatusesApiCreateClaimStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateClaimStatusResponseClass, any>>;
+    /**
+     * Permanently deletes the claim status. Supply the unique id that was returned when you created the claim status and this will delete it.
+     * @summary Delete the claim status
+     * @param {ClaimStatusesApiDeleteClaimStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimStatusesApi
+     */
+    deleteClaimStatus(requestParameters: ClaimStatusesApiDeleteClaimStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the details of the claim status that was previously created. Supply the unique claim status id that was returned when you created it and Emil Api will return the corresponding claim status information.
+     * @summary Retrieve the claim status
+     * @param {ClaimStatusesApiGetClaimStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimStatusesApi
+     */
+    getClaimStatus(requestParameters: ClaimStatusesApiGetClaimStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetClaimStatusResponseClass, any>>;
+    /**
+     * Returns a list of claim statuses you have previously created. The claim statuses are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim statuses
+     * @param {ClaimStatusesApiListClaimStatusesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimStatusesApi
+     */
+    listClaimStatuses(requestParameters?: ClaimStatusesApiListClaimStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListClaimStatusesResponseClass, any>>;
+}