@emilgroup/claim-sdk-node 1.11.0 → 1.17.1

package/dist/api/claim-partner-roles-api.d.ts

@@ -0,0 +1,384 @@
+/**
+ * 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 { CreateClaimPartnerRoleRequestDto } from '../models';
+import { CreateClaimPartnerRoleResponseClass } from '../models';
+import { GetClaimPartnerRoleResponseClass } from '../models';
+import { ListClaimPartnerRolesResponseClass } from '../models';
+import { UpdateClaimPartnerRoleRequestDto } from '../models';
+import { UpdateClaimPartnerRoleResponseClass } from '../models';
+/**
+ * ClaimPartnerRolesApi - axios parameter creator
+ * @export
+ */
+export declare const ClaimPartnerRolesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a claim partner role.
+     * @summary Create the claim partner role
+     * @param {CreateClaimPartnerRoleRequestDto} createClaimPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimPartnerRole: (createClaimPartnerRoleRequestDto: CreateClaimPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the claim partner role. Supply the unique code that was returned when you created the claim partner role and this will delete it.
+     * @summary Delete the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimPartnerRole: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the claim partner role that was previously created. Supply the unique claim partner role code that was returned when you created it and Emil Api will return the corresponding claim partner role information.
+     * @summary Retrieve the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimPartnerRole: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of claim partner roles you have previously created. The claim partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partner roles
+     * @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 {'name' | 'productSlug'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'name' | 'productSlug'} [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' | 'name' | 'productSlug' | '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 {number} [expand] This entity has no expand parameters
+     * @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}
+     */
+    listClaimPartnerRole: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'name' | 'productSlug', search?: 'name' | 'productSlug', order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt', expand?: number, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified claim partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateClaimPartnerRoleRequestDto} updateClaimPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaimPartnerRole: (code: string, updateClaimPartnerRoleRequestDto: UpdateClaimPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ClaimPartnerRolesApi - functional programming interface
+ * @export
+ */
+export declare const ClaimPartnerRolesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a claim partner role.
+     * @summary Create the claim partner role
+     * @param {CreateClaimPartnerRoleRequestDto} createClaimPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimPartnerRole(createClaimPartnerRoleRequestDto: CreateClaimPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateClaimPartnerRoleResponseClass>>;
+    /**
+     * Permanently deletes the claim partner role. Supply the unique code that was returned when you created the claim partner role and this will delete it.
+     * @summary Delete the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimPartnerRole(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the details of the claim partner role that was previously created. Supply the unique claim partner role code that was returned when you created it and Emil Api will return the corresponding claim partner role information.
+     * @summary Retrieve the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimPartnerRole(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClaimPartnerRoleResponseClass>>;
+    /**
+     * Returns a list of claim partner roles you have previously created. The claim partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partner roles
+     * @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 {'name' | 'productSlug'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'name' | 'productSlug'} [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' | 'name' | 'productSlug' | '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 {number} [expand] This entity has no expand parameters
+     * @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}
+     */
+    listClaimPartnerRole(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'name' | 'productSlug', search?: 'name' | 'productSlug', order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt', expand?: number, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListClaimPartnerRolesResponseClass>>;
+    /**
+     * Updates the specified claim partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateClaimPartnerRoleRequestDto} updateClaimPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaimPartnerRole(code: string, updateClaimPartnerRoleRequestDto: UpdateClaimPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateClaimPartnerRoleResponseClass>>;
+};
+/**
+ * ClaimPartnerRolesApi - factory interface
+ * @export
+ */
+export declare const ClaimPartnerRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a claim partner role.
+     * @summary Create the claim partner role
+     * @param {CreateClaimPartnerRoleRequestDto} createClaimPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createClaimPartnerRole(createClaimPartnerRoleRequestDto: CreateClaimPartnerRoleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateClaimPartnerRoleResponseClass>;
+    /**
+     * Permanently deletes the claim partner role. Supply the unique code that was returned when you created the claim partner role and this will delete it.
+     * @summary Delete the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteClaimPartnerRole(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Retrieves the details of the claim partner role that was previously created. Supply the unique claim partner role code that was returned when you created it and Emil Api will return the corresponding claim partner role information.
+     * @summary Retrieve the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getClaimPartnerRole(code: string, authorization?: string, options?: any): AxiosPromise<GetClaimPartnerRoleResponseClass>;
+    /**
+     * Returns a list of claim partner roles you have previously created. The claim partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partner roles
+     * @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 {'name' | 'productSlug'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'name' | 'productSlug'} [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' | 'name' | 'productSlug' | '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 {number} [expand] This entity has no expand parameters
+     * @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}
+     */
+    listClaimPartnerRole(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'name' | 'productSlug', search?: 'name' | 'productSlug', order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt', expand?: number, filters?: any, options?: any): AxiosPromise<ListClaimPartnerRolesResponseClass>;
+    /**
+     * Updates the specified claim partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the claim partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdateClaimPartnerRoleRequestDto} updateClaimPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateClaimPartnerRole(code: string, updateClaimPartnerRoleRequestDto: UpdateClaimPartnerRoleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateClaimPartnerRoleResponseClass>;
+};
+/**
+ * Request parameters for createClaimPartnerRole operation in ClaimPartnerRolesApi.
+ * @export
+ * @interface ClaimPartnerRolesApiCreateClaimPartnerRoleRequest
+ */
+export interface ClaimPartnerRolesApiCreateClaimPartnerRoleRequest {
+    /**
+     *
+     * @type {CreateClaimPartnerRoleRequestDto}
+     * @memberof ClaimPartnerRolesApiCreateClaimPartnerRole
+     */
+    readonly createClaimPartnerRoleRequestDto: CreateClaimPartnerRoleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiCreateClaimPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteClaimPartnerRole operation in ClaimPartnerRolesApi.
+ * @export
+ * @interface ClaimPartnerRolesApiDeleteClaimPartnerRoleRequest
+ */
+export interface ClaimPartnerRolesApiDeleteClaimPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiDeleteClaimPartnerRole
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiDeleteClaimPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getClaimPartnerRole operation in ClaimPartnerRolesApi.
+ * @export
+ * @interface ClaimPartnerRolesApiGetClaimPartnerRoleRequest
+ */
+export interface ClaimPartnerRolesApiGetClaimPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiGetClaimPartnerRole
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiGetClaimPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listClaimPartnerRole operation in ClaimPartnerRolesApi.
+ * @export
+ * @interface ClaimPartnerRolesApiListClaimPartnerRoleRequest
+ */
+export interface ClaimPartnerRolesApiListClaimPartnerRoleRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    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 ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {'name' | 'productSlug'}
+     * @memberof ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly filter?: '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 {'name' | 'productSlug'}
+     * @memberof ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly search?: 'name' | 'productSlug';
+    /**
+     * 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' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt'}
+     * @memberof ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt';
+    /**
+     * This entity has no expand parameters
+     * @type {number}
+     * @memberof ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly expand?: number;
+    /**
+     * 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 ClaimPartnerRolesApiListClaimPartnerRole
+     */
+    readonly filters?: any;
+}
+/**
+ * Request parameters for updateClaimPartnerRole operation in ClaimPartnerRolesApi.
+ * @export
+ * @interface ClaimPartnerRolesApiUpdateClaimPartnerRoleRequest
+ */
+export interface ClaimPartnerRolesApiUpdateClaimPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiUpdateClaimPartnerRole
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateClaimPartnerRoleRequestDto}
+     * @memberof ClaimPartnerRolesApiUpdateClaimPartnerRole
+     */
+    readonly updateClaimPartnerRoleRequestDto: UpdateClaimPartnerRoleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ClaimPartnerRolesApiUpdateClaimPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * ClaimPartnerRolesApi - object-oriented interface
+ * @export
+ * @class ClaimPartnerRolesApi
+ * @extends {BaseAPI}
+ */
+export declare class ClaimPartnerRolesApi extends BaseAPI {
+    /**
+     * This will create a claim partner role.
+     * @summary Create the claim partner role
+     * @param {ClaimPartnerRolesApiCreateClaimPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnerRolesApi
+     */
+    createClaimPartnerRole(requestParameters: ClaimPartnerRolesApiCreateClaimPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateClaimPartnerRoleResponseClass, any>>;
+    /**
+     * Permanently deletes the claim partner role. Supply the unique code that was returned when you created the claim partner role and this will delete it.
+     * @summary Delete the claim partner role
+     * @param {ClaimPartnerRolesApiDeleteClaimPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnerRolesApi
+     */
+    deleteClaimPartnerRole(requestParameters: ClaimPartnerRolesApiDeleteClaimPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the details of the claim partner role that was previously created. Supply the unique claim partner role code that was returned when you created it and Emil Api will return the corresponding claim partner role information.
+     * @summary Retrieve the claim partner role
+     * @param {ClaimPartnerRolesApiGetClaimPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnerRolesApi
+     */
+    getClaimPartnerRole(requestParameters: ClaimPartnerRolesApiGetClaimPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetClaimPartnerRoleResponseClass, any>>;
+    /**
+     * Returns a list of claim partner roles you have previously created. The claim partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List claim partner roles
+     * @param {ClaimPartnerRolesApiListClaimPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnerRolesApi
+     */
+    listClaimPartnerRole(requestParameters?: ClaimPartnerRolesApiListClaimPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListClaimPartnerRolesResponseClass, any>>;
+    /**
+     * Updates the specified claim partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the claim partner role
+     * @param {ClaimPartnerRolesApiUpdateClaimPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClaimPartnerRolesApi
+     */
+    updateClaimPartnerRole(requestParameters: ClaimPartnerRolesApiUpdateClaimPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateClaimPartnerRoleResponseClass, any>>;
+}