@emilgroup/customer-sdk-node 1.6.1 → 1.9.0

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

@@ -0,0 +1,327 @@
+/**
+ * EMIL CustomerService
+ * The EMIL CustomerService 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 { CreateCustomerClaimRequestDto } from '../models';
+import { CreatePresignedPostResponseClass } from '../models';
+import { UpdateCustomerClaimRequestDto } from '../models';
+import { UploadCustomerClaimDocumentsRequestDto } from '../models';
+/**
+ * ClaimsApi - axios parameter creator
+ * @export
+ */
+export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new claim for customer.
+     * @summary Create a new claim for customer
+     * @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
+     * @param {CreateCustomerClaimRequestDto} createCustomerClaimRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerClaim: (customerCode: string, createCustomerClaimRequestDto: CreateCustomerClaimRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List claims by customer.
+     * @summary List claims by customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. 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 {any} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerClaims: (customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update claim for customer.
+     * @summary Update claim for customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {string} claimCode The claim code to identify a claim.
+     * @param {UpdateCustomerClaimRequestDto} updateCustomerClaimRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomerClaim: (customerCode: string, claimCode: string, updateCustomerClaimRequestDto: UpdateCustomerClaimRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * API to upload and attach documents to a claim.
+     * @summary Upload claim documents
+     * @param {string} customerCode
+     * @param {string} claimCode The claim code to identify a claim.
+     * @param {UploadCustomerClaimDocumentsRequestDto} uploadCustomerClaimDocumentsRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadCustomerClaimDocuments: (customerCode: string, claimCode: string, uploadCustomerClaimDocumentsRequestDto: UploadCustomerClaimDocumentsRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ClaimsApi - functional programming interface
+ * @export
+ */
+export declare const ClaimsApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new claim for customer.
+     * @summary Create a new claim for customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {CreateCustomerClaimRequestDto} createCustomerClaimRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerClaim(customerCode: string, createCustomerClaimRequestDto: CreateCustomerClaimRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * List claims by customer.
+     * @summary List claims by customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. 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 {any} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerClaims(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Update claim for customer.
+     * @summary Update claim for customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {string} claimCode The claim code to identify a claim.
+     * @param {UpdateCustomerClaimRequestDto} updateCustomerClaimRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomerClaim(customerCode: string, claimCode: string, updateCustomerClaimRequestDto: UpdateCustomerClaimRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * API to upload and attach documents to a claim.
+     * @summary Upload claim documents
+     * @param {string} customerCode
+     * @param {string} claimCode The claim code to identify a claim.
+     * @param {UploadCustomerClaimDocumentsRequestDto} uploadCustomerClaimDocumentsRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadCustomerClaimDocuments(customerCode: string, claimCode: string, uploadCustomerClaimDocumentsRequestDto: UploadCustomerClaimDocumentsRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
+};
+/**
+ * ClaimsApi - factory interface
+ * @export
+ */
+export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new claim for customer.
+     * @summary Create a new claim for customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {CreateCustomerClaimRequestDto} createCustomerClaimRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCustomerClaim(customerCode: string, createCustomerClaimRequestDto: CreateCustomerClaimRequestDto, options?: any): AxiosPromise<object>;
+    /**
+     * List claims by customer.
+     * @summary List claims by customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. 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 {any} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCustomerClaims(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<object>;
+    /**
+     * Update claim for customer.
+     * @summary Update claim for customer
+     * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @param {string} claimCode The claim code to identify a claim.
+     * @param {UpdateCustomerClaimRequestDto} updateCustomerClaimRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCustomerClaim(customerCode: string, claimCode: string, updateCustomerClaimRequestDto: UpdateCustomerClaimRequestDto, options?: any): AxiosPromise<object>;
+    /**
+     * API to upload and attach documents to a claim.
+     * @summary Upload claim documents
+     * @param {string} customerCode
+     * @param {string} claimCode The claim code to identify a claim.
+     * @param {UploadCustomerClaimDocumentsRequestDto} uploadCustomerClaimDocumentsRequestDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadCustomerClaimDocuments(customerCode: string, claimCode: string, uploadCustomerClaimDocumentsRequestDto: UploadCustomerClaimDocumentsRequestDto, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
+};
+/**
+ * Request parameters for createCustomerClaim operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiCreateCustomerClaimRequest
+ */
+export interface ClaimsApiCreateCustomerClaimRequest {
+    /**
+     * The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @type {string}
+     * @memberof ClaimsApiCreateCustomerClaim
+     */
+    readonly customerCode: string;
+    /**
+     *
+     * @type {CreateCustomerClaimRequestDto}
+     * @memberof ClaimsApiCreateCustomerClaim
+     */
+    readonly createCustomerClaimRequestDto: CreateCustomerClaimRequestDto;
+}
+/**
+ * Request parameters for listCustomerClaims operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiListCustomerClaimsRequest
+ */
+export interface ClaimsApiListCustomerClaimsRequest {
+    /**
+     * The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @type {string}
+     * @memberof ClaimsApiListCustomerClaims
+     */
+    readonly customerCode: string;
+    /**
+     * A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof ClaimsApiListCustomerClaims
+     */
+    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 ClaimsApiListCustomerClaims
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof ClaimsApiListCustomerClaims
+     */
+    readonly filter?: any;
+    /**
+     * 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 ClaimsApiListCustomerClaims
+     */
+    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 ClaimsApiListCustomerClaims
+     */
+    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 ClaimsApiListCustomerClaims
+     */
+    readonly expand?: any;
+}
+/**
+ * Request parameters for updateCustomerClaim operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiUpdateCustomerClaimRequest
+ */
+export interface ClaimsApiUpdateCustomerClaimRequest {
+    /**
+     * The customer code or \&quot;me\&quot; for the currently logged in customer.
+     * @type {string}
+     * @memberof ClaimsApiUpdateCustomerClaim
+     */
+    readonly customerCode: string;
+    /**
+     * The claim code to identify a claim.
+     * @type {string}
+     * @memberof ClaimsApiUpdateCustomerClaim
+     */
+    readonly claimCode: string;
+    /**
+     *
+     * @type {UpdateCustomerClaimRequestDto}
+     * @memberof ClaimsApiUpdateCustomerClaim
+     */
+    readonly updateCustomerClaimRequestDto: UpdateCustomerClaimRequestDto;
+}
+/**
+ * Request parameters for uploadCustomerClaimDocuments operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiUploadCustomerClaimDocumentsRequest
+ */
+export interface ClaimsApiUploadCustomerClaimDocumentsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ClaimsApiUploadCustomerClaimDocuments
+     */
+    readonly customerCode: string;
+    /**
+     * The claim code to identify a claim.
+     * @type {string}
+     * @memberof ClaimsApiUploadCustomerClaimDocuments
+     */
+    readonly claimCode: string;
+    /**
+     *
+     * @type {UploadCustomerClaimDocumentsRequestDto}
+     * @memberof ClaimsApiUploadCustomerClaimDocuments
+     */
+    readonly uploadCustomerClaimDocumentsRequestDto: UploadCustomerClaimDocumentsRequestDto;
+}
+/**
+ * ClaimsApi - object-oriented interface
+ * @export
+ * @class ClaimsApi
+ * @extends {BaseAPI}
+ */
+export declare class ClaimsApi extends BaseAPI {
+    /**
+     * Create a new claim for customer.
+     * @summary Create a new claim for customer
+     * @param {ClaimsApiCreateCustomerClaimRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    createCustomerClaim(requestParameters: ClaimsApiCreateCustomerClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * List claims by customer.
+     * @summary List claims by customer
+     * @param {ClaimsApiListCustomerClaimsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    listCustomerClaims(requestParameters: ClaimsApiListCustomerClaimsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Update claim for customer.
+     * @summary Update claim for customer
+     * @param {ClaimsApiUpdateCustomerClaimRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    updateCustomerClaim(requestParameters: ClaimsApiUpdateCustomerClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * API to upload and attach documents to a claim.
+     * @summary Upload claim documents
+     * @param {ClaimsApiUploadCustomerClaimDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    uploadCustomerClaimDocuments(requestParameters: ClaimsApiUploadCustomerClaimDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
+}