@emilgroup/claim-sdk-node 1.3.0

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

@@ -0,0 +1,316 @@
+/**
+ * EMIL ClaimService
+ * The EMIL ClaimService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * 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 { CreateClaimRequestDto } from '../models';
+import { UpdateClaimRequestDto } from '../models';
+/**
+ * ClaimsApi - axios parameter creator
+ * @export
+ */
+export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a claim in the database
+     * @summary Create the claim
+     * @param {CreateClaimRequestDto} createClaimRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaim: (createClaimRequestDto: CreateClaimRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will fetch the identified claim from the database by code
+     * @summary Retrieve the claim
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaim: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will fetch list of claims from the database
+     * @summary Retrieve the claim
+     * @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 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}
+     */
+    listClaims: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update the identified claim in the database
+     * @summary Update the claim
+     * @param {string} code
+     * @param {UpdateClaimRequestDto} updateClaimRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaim: (code: string, updateClaimRequestDto: UpdateClaimRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ClaimsApi - functional programming interface
+ * @export
+ */
+export declare const ClaimsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a claim in the database
+     * @summary Create the claim
+     * @param {CreateClaimRequestDto} createClaimRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaim(createClaimRequestDto: CreateClaimRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * This will fetch the identified claim from the database by code
+     * @summary Retrieve the claim
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaim(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * This will fetch list of claims from the database
+     * @summary Retrieve the claim
+     * @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 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}
+     */
+    listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * This will update the identified claim in the database
+     * @summary Update the claim
+     * @param {string} code
+     * @param {UpdateClaimRequestDto} updateClaimRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaim(code: string, updateClaimRequestDto: UpdateClaimRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+};
+/**
+ * ClaimsApi - factory interface
+ * @export
+ */
+export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a claim in the database
+     * @summary Create the claim
+     * @param {CreateClaimRequestDto} createClaimRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaim(createClaimRequestDto: CreateClaimRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * This will fetch the identified claim from the database by code
+     * @summary Retrieve the claim
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaim(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * This will fetch list of claims from the database
+     * @summary Retrieve the claim
+     * @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 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}
+     */
+    listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<object>;
+    /**
+     * This will update the identified claim in the database
+     * @summary Update the claim
+     * @param {string} code
+     * @param {UpdateClaimRequestDto} updateClaimRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaim(code: string, updateClaimRequestDto: UpdateClaimRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
+};
+/**
+ * Request parameters for createClaim operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiCreateClaimRequest
+ */
+export interface ClaimsApiCreateClaimRequest {
+    /**
+     *
+     * @type {CreateClaimRequestDto}
+     * @memberof ClaimsApiCreateClaim
+     */
+    readonly createClaimRequestDto: CreateClaimRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimsApiCreateClaim
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getClaim operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiGetClaimRequest
+ */
+export interface ClaimsApiGetClaimRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ClaimsApiGetClaim
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimsApiGetClaim
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listClaims operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiListClaimsRequest
+ */
+export interface ClaimsApiListClaimsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimsApiListClaims
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * @type {any}
+     * @memberof ClaimsApiListClaims
+     */
+    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 ClaimsApiListClaims
+     */
+    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 ClaimsApiListClaims
+     */
+    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 ClaimsApiListClaims
+     */
+    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 ClaimsApiListClaims
+     */
+    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 ClaimsApiListClaims
+     */
+    readonly expand?: any;
+}
+/**
+ * Request parameters for updateClaim operation in ClaimsApi.
+ * @export
+ * @interface ClaimsApiUpdateClaimRequest
+ */
+export interface ClaimsApiUpdateClaimRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ClaimsApiUpdateClaim
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateClaimRequestDto}
+     * @memberof ClaimsApiUpdateClaim
+     */
+    readonly updateClaimRequestDto: UpdateClaimRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimsApiUpdateClaim
+     */
+    readonly authorization?: string;
+}
+/**
+ * ClaimsApi - object-oriented interface
+ * @export
+ * @class ClaimsApi
+ * @extends {BaseAPI}
+ */
+export declare class ClaimsApi extends BaseAPI {
+    /**
+     * This will create a claim in the database
+     * @summary Create the claim
+     * @param {ClaimsApiCreateClaimRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    createClaim(requestParameters: ClaimsApiCreateClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * This will fetch the identified claim from the database by code
+     * @summary Retrieve the claim
+     * @param {ClaimsApiGetClaimRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    getClaim(requestParameters: ClaimsApiGetClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * This will fetch list of claims from the database
+     * @summary Retrieve the claim
+     * @param {ClaimsApiListClaimsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    listClaims(requestParameters?: ClaimsApiListClaimsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * This will update the identified claim in the database
+     * @summary Update the claim
+     * @param {ClaimsApiUpdateClaimRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimsApi
+     */
+    updateClaim(requestParameters: ClaimsApiUpdateClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+}