@emilgroup/insurance-sdk-node 1.52.0 → 1.54.0

package/dist/api/commission-recipients-api.d.ts

@@ -0,0 +1,394 @@
+/**
+ * EMIL InsuranceService
+ * The EMIL InsuranceService 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 { CreateCommissionRecipientRequestDto } from '../models';
+import { CreateCommissionRecipientResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetCommissionRecipientResponseClass } from '../models';
+import { ListCommissionRecipientsResponseClass } from '../models';
+import { UpdateCommissionRecipientRequestDto } from '../models';
+import { UpdateCommissionRecipientResponseClass } from '../models';
+/**
+ * CommissionRecipientsApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionRecipientsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create the commission recipient.
+     * @summary Create the Commission recipient
+     * @param {string} code
+     * @param {CreateCommissionRecipientRequestDto} createCommissionRecipientRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionRecipient: (code: string, createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the commission recipient. Supply the unique code that was returned when you created the commission recipient and this will delete it.
+     * @summary Delete the commission recipient
+     * @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}
+     */
+    deleteCommissionRecipient: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the commission recipient that was previously created. Supply the unique commission recipient code      that was returned when you created it and Emil Api will return the corresponding commission recipient information.
+     * @summary Retrieve the commission recipient
+     * @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}
+     */
+    getCommissionRecipient: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of commission recipients you have previously created.          The commission recipients are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission recipients
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: displayName, partnerCode, code&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionRecipients: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified commission recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the commission recipient
+     * @param {string} code
+     * @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionRecipient: (code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionRecipientsApi - functional programming interface
+ * @export
+ */
+export declare const CommissionRecipientsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create the commission recipient.
+     * @summary Create the Commission recipient
+     * @param {string} code
+     * @param {CreateCommissionRecipientRequestDto} createCommissionRecipientRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionRecipient(code: string, createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionRecipientResponseClass>>;
+    /**
+     * Permanently deletes the commission recipient. Supply the unique code that was returned when you created the commission recipient and this will delete it.
+     * @summary Delete the commission recipient
+     * @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}
+     */
+    deleteCommissionRecipient(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the commission recipient that was previously created. Supply the unique commission recipient code      that was returned when you created it and Emil Api will return the corresponding commission recipient information.
+     * @summary Retrieve the commission recipient
+     * @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}
+     */
+    getCommissionRecipient(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionRecipientResponseClass>>;
+    /**
+     * Returns a list of commission recipients you have previously created.          The commission recipients are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission recipients
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: displayName, partnerCode, code&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionRecipientsResponseClass>>;
+    /**
+     * Updates the specified commission recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the commission recipient
+     * @param {string} code
+     * @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionRecipientResponseClass>>;
+};
+/**
+ * CommissionRecipientsApi - factory interface
+ * @export
+ */
+export declare const CommissionRecipientsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create the commission recipient.
+     * @summary Create the Commission recipient
+     * @param {string} code
+     * @param {CreateCommissionRecipientRequestDto} createCommissionRecipientRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionRecipient(code: string, createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionRecipientResponseClass>;
+    /**
+     * Permanently deletes the commission recipient. Supply the unique code that was returned when you created the commission recipient and this will delete it.
+     * @summary Delete the commission recipient
+     * @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}
+     */
+    deleteCommissionRecipient(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the commission recipient that was previously created. Supply the unique commission recipient code      that was returned when you created it and Emil Api will return the corresponding commission recipient information.
+     * @summary Retrieve the commission recipient
+     * @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}
+     */
+    getCommissionRecipient(code: string, authorization?: string, options?: any): AxiosPromise<GetCommissionRecipientResponseClass>;
+    /**
+     * Returns a list of commission recipients you have previously created.          The commission recipients are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission recipients
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
+     * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: displayName, partnerCode, code&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionRecipients(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionRecipientsResponseClass>;
+    /**
+     * Updates the specified commission recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the commission recipient
+     * @param {string} code
+     * @param {UpdateCommissionRecipientRequestDto} updateCommissionRecipientRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionRecipient(code: string, updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionRecipientResponseClass>;
+};
+/**
+ * Request parameters for createCommissionRecipient operation in CommissionRecipientsApi.
+ * @export
+ * @interface CommissionRecipientsApiCreateCommissionRecipientRequest
+ */
+export interface CommissionRecipientsApiCreateCommissionRecipientRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionRecipientsApiCreateCommissionRecipient
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {CreateCommissionRecipientRequestDto}
+     * @memberof CommissionRecipientsApiCreateCommissionRecipient
+     */
+    readonly createCommissionRecipientRequestDto: CreateCommissionRecipientRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionRecipientsApiCreateCommissionRecipient
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommissionRecipient operation in CommissionRecipientsApi.
+ * @export
+ * @interface CommissionRecipientsApiDeleteCommissionRecipientRequest
+ */
+export interface CommissionRecipientsApiDeleteCommissionRecipientRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionRecipientsApiDeleteCommissionRecipient
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionRecipientsApiDeleteCommissionRecipient
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommissionRecipient operation in CommissionRecipientsApi.
+ * @export
+ * @interface CommissionRecipientsApiGetCommissionRecipientRequest
+ */
+export interface CommissionRecipientsApiGetCommissionRecipientRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionRecipientsApiGetCommissionRecipient
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionRecipientsApiGetCommissionRecipient
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissionRecipients operation in CommissionRecipientsApi.
+ * @export
+ * @interface CommissionRecipientsApiListCommissionRecipientsRequest
+ */
+export interface CommissionRecipientsApiListCommissionRecipientsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly filter?: string;
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: displayName, partnerCode, code&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly search?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, partnerCode, displayName, commissionAgreementId&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionRecipientsApiListCommissionRecipients
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateCommissionRecipient operation in CommissionRecipientsApi.
+ * @export
+ * @interface CommissionRecipientsApiUpdateCommissionRecipientRequest
+ */
+export interface CommissionRecipientsApiUpdateCommissionRecipientRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionRecipientsApiUpdateCommissionRecipient
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateCommissionRecipientRequestDto}
+     * @memberof CommissionRecipientsApiUpdateCommissionRecipient
+     */
+    readonly updateCommissionRecipientRequestDto: UpdateCommissionRecipientRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionRecipientsApiUpdateCommissionRecipient
+     */
+    readonly authorization?: string;
+}
+/**
+ * CommissionRecipientsApi - object-oriented interface
+ * @export
+ * @class CommissionRecipientsApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionRecipientsApi extends BaseAPI {
+    /**
+     * This will create the commission recipient.
+     * @summary Create the Commission recipient
+     * @param {CommissionRecipientsApiCreateCommissionRecipientRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionRecipientsApi
+     */
+    createCommissionRecipient(requestParameters: CommissionRecipientsApiCreateCommissionRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionRecipientResponseClass, any>>;
+    /**
+     * Permanently deletes the commission recipient. Supply the unique code that was returned when you created the commission recipient and this will delete it.
+     * @summary Delete the commission recipient
+     * @param {CommissionRecipientsApiDeleteCommissionRecipientRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionRecipientsApi
+     */
+    deleteCommissionRecipient(requestParameters: CommissionRecipientsApiDeleteCommissionRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the commission recipient that was previously created. Supply the unique commission recipient code      that was returned when you created it and Emil Api will return the corresponding commission recipient information.
+     * @summary Retrieve the commission recipient
+     * @param {CommissionRecipientsApiGetCommissionRecipientRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionRecipientsApi
+     */
+    getCommissionRecipient(requestParameters: CommissionRecipientsApiGetCommissionRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionRecipientResponseClass, any>>;
+    /**
+     * Returns a list of commission recipients you have previously created.          The commission recipients are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission recipients
+     * @param {CommissionRecipientsApiListCommissionRecipientsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionRecipientsApi
+     */
+    listCommissionRecipients(requestParameters?: CommissionRecipientsApiListCommissionRecipientsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionRecipientsResponseClass, any>>;
+    /**
+     * Updates the specified commission recipient by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the commission recipient
+     * @param {CommissionRecipientsApiUpdateCommissionRecipientRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionRecipientsApi
+     */
+    updateCommissionRecipient(requestParameters: CommissionRecipientsApiUpdateCommissionRecipientRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionRecipientResponseClass, any>>;
+}