@emilgroup/claim-sdk-node 1.11.0 → 1.17.1

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

@@ -0,0 +1,327 @@
+/**
+ * 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 { CreateClaimPartnerRequestDto } from '../models';
+import { CreateClaimPartnerResponseClass } from '../models';
+import { GetClaimPartnerResponseClass } from '../models';
+import { ListClaimPartnersResponseClass } from '../models';
+/**
+ * ClaimPartnersApi - axios parameter creator
+ * @export
+ */
+export declare const ClaimPartnersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a claim partner.
+     * @summary Create the claim partner
+     * @param {string} claimCode Unique identifier for the claim object.
+     * @param {CreateClaimPartnerRequestDto} createClaimPartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimPartner: (claimCode: string, createClaimPartnerRequestDto: CreateClaimPartnerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the claim partner. Supply the unique id that was returned when you created the claim partner and this will delete it.
+     * @summary Delete the claim partner
+     * @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}
+     */
+    deleteClaimPartner: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the claim partner that was previously created. Supply the unique claim partner id that was returned when you created it and Emil Api will return the corresponding claim partner information.
+     * @summary Retrieve the claim partner
+     * @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}
+     */
+    getClaimPartnerRole: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of claim partners you have previously created. The claim partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partners
+     * @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 {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'} [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 {'id' | 'createdAt' | 'updatedAt'} [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 {'role' | 'partner'} [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}
+     */
+    listClaimPartners: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode', search?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode', order?: 'id' | 'createdAt' | 'updatedAt', expand?: 'role' | 'partner', filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ClaimPartnersApi - functional programming interface
+ * @export
+ */
+export declare const ClaimPartnersApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a claim partner.
+     * @summary Create the claim partner
+     * @param {string} claimCode Unique identifier for the claim object.
+     * @param {CreateClaimPartnerRequestDto} createClaimPartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimPartner(claimCode: string, createClaimPartnerRequestDto: CreateClaimPartnerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateClaimPartnerResponseClass>>;
+    /**
+     * Permanently deletes the claim partner. Supply the unique id that was returned when you created the claim partner and this will delete it.
+     * @summary Delete the claim partner
+     * @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}
+     */
+    deleteClaimPartner(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the details of the claim partner that was previously created. Supply the unique claim partner id that was returned when you created it and Emil Api will return the corresponding claim partner information.
+     * @summary Retrieve the claim partner
+     * @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}
+     */
+    getClaimPartnerRole(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClaimPartnerResponseClass>>;
+    /**
+     * Returns a list of claim partners you have previously created. The claim partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partners
+     * @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 {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'} [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 {'id' | 'createdAt' | 'updatedAt'} [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 {'role' | 'partner'} [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}
+     */
+    listClaimPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode', search?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode', order?: 'id' | 'createdAt' | 'updatedAt', expand?: 'role' | 'partner', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListClaimPartnersResponseClass>>;
+};
+/**
+ * ClaimPartnersApi - factory interface
+ * @export
+ */
+export declare const ClaimPartnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a claim partner.
+     * @summary Create the claim partner
+     * @param {string} claimCode Unique identifier for the claim object.
+     * @param {CreateClaimPartnerRequestDto} createClaimPartnerRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimPartner(claimCode: string, createClaimPartnerRequestDto: CreateClaimPartnerRequestDto, authorization?: string, options?: any): AxiosPromise<CreateClaimPartnerResponseClass>;
+    /**
+     * Permanently deletes the claim partner. Supply the unique id that was returned when you created the claim partner and this will delete it.
+     * @summary Delete the claim partner
+     * @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}
+     */
+    deleteClaimPartner(id: number, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves the details of the claim partner that was previously created. Supply the unique claim partner id that was returned when you created it and Emil Api will return the corresponding claim partner information.
+     * @summary Retrieve the claim partner
+     * @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}
+     */
+    getClaimPartnerRole(id: number, authorization?: string, options?: any): AxiosPromise<GetClaimPartnerResponseClass>;
+    /**
+     * Returns a list of claim partners you have previously created. The claim partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partners
+     * @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 {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'} [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 {'id' | 'createdAt' | 'updatedAt'} [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 {'role' | 'partner'} [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}
+     */
+    listClaimPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode', search?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode', order?: 'id' | 'createdAt' | 'updatedAt', expand?: 'role' | 'partner', filters?: any, options?: any): AxiosPromise<ListClaimPartnersResponseClass>;
+};
+/**
+ * Request parameters for createClaimPartner operation in ClaimPartnersApi.
+ * @export
+ * @interface ClaimPartnersApiCreateClaimPartnerRequest
+ */
+export interface ClaimPartnersApiCreateClaimPartnerRequest {
+    /**
+     * Unique identifier for the claim object.
+     * @type {string}
+     * @memberof ClaimPartnersApiCreateClaimPartner
+     */
+    readonly claimCode: string;
+    /**
+     *
+     * @type {CreateClaimPartnerRequestDto}
+     * @memberof ClaimPartnersApiCreateClaimPartner
+     */
+    readonly createClaimPartnerRequestDto: CreateClaimPartnerRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnersApiCreateClaimPartner
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteClaimPartner operation in ClaimPartnersApi.
+ * @export
+ * @interface ClaimPartnersApiDeleteClaimPartnerRequest
+ */
+export interface ClaimPartnersApiDeleteClaimPartnerRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ClaimPartnersApiDeleteClaimPartner
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnersApiDeleteClaimPartner
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getClaimPartnerRole operation in ClaimPartnersApi.
+ * @export
+ * @interface ClaimPartnersApiGetClaimPartnerRoleRequest
+ */
+export interface ClaimPartnersApiGetClaimPartnerRoleRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ClaimPartnersApiGetClaimPartnerRole
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnersApiGetClaimPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listClaimPartners operation in ClaimPartnersApi.
+ * @export
+ * @interface ClaimPartnersApiListClaimPartnersRequest
+ */
+export interface ClaimPartnersApiListClaimPartnersRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnersApiListClaimPartners
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof ClaimPartnersApiListClaimPartners
+     */
+    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 ClaimPartnersApiListClaimPartners
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'}
+     * @memberof ClaimPartnersApiListClaimPartners
+     */
+    readonly filter?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode';
+    /**
+     * 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 {'partnerCode' | 'claimPartnerRoleCode' | 'claimCode'}
+     * @memberof ClaimPartnersApiListClaimPartners
+     */
+    readonly search?: 'partnerCode' | 'claimPartnerRoleCode' | 'claimCode';
+    /**
+     * 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 {'id' | 'createdAt' | 'updatedAt'}
+     * @memberof ClaimPartnersApiListClaimPartners
+     */
+    readonly order?: 'id' | 'createdAt' | 'updatedAt';
+    /**
+     * 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 {'role' | 'partner'}
+     * @memberof ClaimPartnersApiListClaimPartners
+     */
+    readonly expand?: 'role' | 'partner';
+    /**
+     * 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 ClaimPartnersApiListClaimPartners
+     */
+    readonly filters?: any;
+}
+/**
+ * ClaimPartnersApi - object-oriented interface
+ * @export
+ * @class ClaimPartnersApi
+ * @extends {BaseAPI}
+ */
+export declare class ClaimPartnersApi extends BaseAPI {
+    /**
+     * This will create a claim partner.
+     * @summary Create the claim partner
+     * @param {ClaimPartnersApiCreateClaimPartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnersApi
+     */
+    createClaimPartner(requestParameters: ClaimPartnersApiCreateClaimPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateClaimPartnerResponseClass, any>>;
+    /**
+     * Permanently deletes the claim partner. Supply the unique id that was returned when you created the claim partner and this will delete it.
+     * @summary Delete the claim partner
+     * @param {ClaimPartnersApiDeleteClaimPartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnersApi
+     */
+    deleteClaimPartner(requestParameters: ClaimPartnersApiDeleteClaimPartnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the details of the claim partner that was previously created. Supply the unique claim partner id that was returned when you created it and Emil Api will return the corresponding claim partner information.
+     * @summary Retrieve the claim partner
+     * @param {ClaimPartnersApiGetClaimPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnersApi
+     */
+    getClaimPartnerRole(requestParameters: ClaimPartnersApiGetClaimPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetClaimPartnerResponseClass, any>>;
+    /**
+     * Returns a list of claim partners you have previously created. The claim partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partners
+     * @param {ClaimPartnersApiListClaimPartnersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnersApi
+     */
+    listClaimPartners(requestParameters?: ClaimPartnersApiListClaimPartnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListClaimPartnersResponseClass, any>>;
+}