@emilgroup/insurance-sdk-node 1.52.0 → 1.53.0

package/dist/api/commission-agreement-versions-api.d.ts

@@ -0,0 +1,337 @@
+/**
+ * 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 { CreateCommissionAgreementVersionRequestDto } from '../models';
+import { CreateCommissionAgreementVersionResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetCommissionAgreementVersionResponseClass } from '../models';
+import { ListCommissionAgreementVersionsResponseClass } from '../models';
+/**
+ * CommissionAgreementVersionsApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create the commission agreement version.
+     * @summary Create the Commission agreement version
+     * @param {string} code
+     * @param {CreateCommissionAgreementVersionRequestDto} createCommissionAgreementVersionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreementVersion: (code: string, createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the commission agreement version. Supply the unique code that was returned when you created the commission agreement version and this will delete it.
+     * @summary Delete the commission agreement version
+     * @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}
+     */
+    deleteCommissionAgreementVersion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the commission agreement version that was previously created. Supply the unique commission agreement version code        that was returned when you created it and Emil Api will return the corresponding commission agreement version information.
+     * @summary Retrieve the commission agreement version
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionAgreementVersion: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of commission agreement versions you have previously created.          The commission agreement versions are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission agreement versions
+     * @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, description, 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: versionDescription, 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, description, commissionAgreementId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionAgreementVersionsApi - functional programming interface
+ * @export
+ */
+export declare const CommissionAgreementVersionsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create the commission agreement version.
+     * @summary Create the Commission agreement version
+     * @param {string} code
+     * @param {CreateCommissionAgreementVersionRequestDto} createCommissionAgreementVersionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreementVersion(code: string, createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementVersionResponseClass>>;
+    /**
+     * Permanently deletes the commission agreement version. Supply the unique code that was returned when you created the commission agreement version and this will delete it.
+     * @summary Delete the commission agreement version
+     * @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}
+     */
+    deleteCommissionAgreementVersion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the commission agreement version that was previously created. Supply the unique commission agreement version code        that was returned when you created it and Emil Api will return the corresponding commission agreement version information.
+     * @summary Retrieve the commission agreement version
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionAgreementVersion(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementVersionResponseClass>>;
+    /**
+     * Returns a list of commission agreement versions you have previously created.          The commission agreement versions are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission agreement versions
+     * @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, description, 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: versionDescription, 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, description, commissionAgreementId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementVersionsResponseClass>>;
+};
+/**
+ * CommissionAgreementVersionsApi - factory interface
+ * @export
+ */
+export declare const CommissionAgreementVersionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create the commission agreement version.
+     * @summary Create the Commission agreement version
+     * @param {string} code
+     * @param {CreateCommissionAgreementVersionRequestDto} createCommissionAgreementVersionRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionAgreementVersion(code: string, createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementVersionResponseClass>;
+    /**
+     * Permanently deletes the commission agreement version. Supply the unique code that was returned when you created the commission agreement version and this will delete it.
+     * @summary Delete the commission agreement version
+     * @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}
+     */
+    deleteCommissionAgreementVersion(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the commission agreement version that was previously created. Supply the unique commission agreement version code        that was returned when you created it and Emil Api will return the corresponding commission agreement version information.
+     * @summary Retrieve the commission agreement version
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionAgreementVersion(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementVersionResponseClass>;
+    /**
+     * Returns a list of commission agreement versions you have previously created.          The commission agreement versions are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission agreement versions
+     * @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, description, 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: versionDescription, 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, description, commissionAgreementId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass>;
+};
+/**
+ * Request parameters for createCommissionAgreementVersion operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest
+ */
+export interface CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiCreateCommissionAgreementVersion
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {CreateCommissionAgreementVersionRequestDto}
+     * @memberof CommissionAgreementVersionsApiCreateCommissionAgreementVersion
+     */
+    readonly createCommissionAgreementVersionRequestDto: CreateCommissionAgreementVersionRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiCreateCommissionAgreementVersion
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommissionAgreementVersion operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest
+ */
+export interface CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiDeleteCommissionAgreementVersion
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiDeleteCommissionAgreementVersion
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommissionAgreementVersion operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest
+ */
+export interface CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiGetCommissionAgreementVersion
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiGetCommissionAgreementVersion
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiGetCommissionAgreementVersion
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissionAgreementVersions operation in CommissionAgreementVersionsApi.
+ * @export
+ * @interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest
+ */
+export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    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, description, commissionAgreementId&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    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: versionDescription, code&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    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 CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    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 CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    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, description, commissionAgreementId&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
+     */
+    readonly filters?: string;
+}
+/**
+ * CommissionAgreementVersionsApi - object-oriented interface
+ * @export
+ * @class CommissionAgreementVersionsApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionAgreementVersionsApi extends BaseAPI {
+    /**
+     * This will create the commission agreement version.
+     * @summary Create the Commission agreement version
+     * @param {CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    createCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiCreateCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementVersionResponseClass, any>>;
+    /**
+     * Permanently deletes the commission agreement version. Supply the unique code that was returned when you created the commission agreement version and this will delete it.
+     * @summary Delete the commission agreement version
+     * @param {CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    deleteCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiDeleteCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the commission agreement version that was previously created. Supply the unique commission agreement version code        that was returned when you created it and Emil Api will return the corresponding commission agreement version information.
+     * @summary Retrieve the commission agreement version
+     * @param {CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    getCommissionAgreementVersion(requestParameters: CommissionAgreementVersionsApiGetCommissionAgreementVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementVersionResponseClass, any>>;
+    /**
+     * Returns a list of commission agreement versions you have previously created.          The commission agreement versions are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * @summary List commission agreement versions
+     * @param {CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionAgreementVersionsApi
+     */
+    listCommissionAgreementVersions(requestParameters?: CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementVersionsResponseClass, any>>;
+}