@emilgroup/commission-sdk-node 1.0.0-beta.37 → 1.0.0-beta.38

package/.openapi-generator/FILES

@@ -27,6 +27,7 @@ models/commission-agreement-version-class.ts
 models/commission-class.ts
 models/commission-conditions-dto.ts
 models/commission-config-dto.ts
+models/commission-estimate-class.ts
 models/commission-item-class.ts
 models/commission-recipient-class.ts
 models/commission-settlement-class.ts
@@ -45,6 +46,7 @@ models/create-commission-request-dto.ts
 models/create-commission-response-class.ts
 models/create-commission-settlement-request-dto.ts
 models/create-commission-settlement-response-class.ts
+models/estimate-commissions-response-class.ts
 models/evaluate-commission-agreement-rule-request-dto.ts
 models/evaluate-commission-agreement-rule-response-class.ts
 models/evaluated-commission-class.ts

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/commission-sdk-node@1.0.0-beta.37 --save
+npm install @emilgroup/commission-sdk-node@1.0.0-beta.38 --save
 ```
 or 
 ```
-yarn add @emilgroup/commission-sdk-node@1.0.0-beta.37
+yarn add @emilgroup/commission-sdk-node@1.0.0-beta.38
 ```
 
 And then you can import `CommissionApi`.

package/api/commissions-api.ts

@@ -25,6 +25,8 @@ import { CreateCommissionRequestDto } from '../models';
 // @ts-ignore
 import { CreateCommissionResponseClass } from '../models';
 // @ts-ignore
+import { EstimateCommissionsResponseClass } from '../models';
+// @ts-ignore
 import { GetCommissionResponseClass } from '../models';
 // @ts-ignore
 import { ListCommissionsResponseClass } from '../models';
@@ -125,6 +127,51 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This will estimate commissions for a given policy.
+         * @summary Retrieve the estimate commissions
+         * @param {string} policyCode 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}
+         */
+        estimateCommission: async (policyCode: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'policyCode' is not null or undefined
+            assertParamExists('estimateCommission', 'policyCode', policyCode)
+            const localVarPath = `/commissionservice/v1/commissions/estimate/{policyCode}`
+                .replace(`{${"policyCode"}}`, encodeURIComponent(String(policyCode)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -347,6 +394,18 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCommission(code, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * This will estimate commissions for a given policy.
+         * @summary Retrieve the estimate commissions
+         * @param {string} policyCode 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}
+         */
+        async estimateCommission(policyCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EstimateCommissionsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.estimateCommission(policyCode, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * This will get commission.
          * @summary Retrieve the commission
@@ -423,6 +482,17 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
         deleteCommission(code: string, authorization?: string, options?: any): AxiosPromise<void> {
             return localVarFp.deleteCommission(code, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * This will estimate commissions for a given policy.
+         * @summary Retrieve the estimate commissions
+         * @param {string} policyCode 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}
+         */
+        estimateCommission(policyCode: string, authorization?: string, options?: any): AxiosPromise<EstimateCommissionsResponseClass> {
+            return localVarFp.estimateCommission(policyCode, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * This will get commission.
          * @summary Retrieve the commission
@@ -509,6 +579,27 @@ export interface CommissionsApiDeleteCommissionRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for estimateCommission operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiEstimateCommissionRequest
+ */
+export interface CommissionsApiEstimateCommissionRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionsApiEstimateCommission
+     */
+    readonly policyCode: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiEstimateCommission
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for getCommission operation in CommissionsApi.
  * @export
@@ -659,6 +750,18 @@ export class CommissionsApi extends BaseAPI {
         return CommissionsApiFp(this.configuration).deleteCommission(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * This will estimate commissions for a given policy.
+     * @summary Retrieve the estimate commissions
+     * @param {CommissionsApiEstimateCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    public estimateCommission(requestParameters: CommissionsApiEstimateCommissionRequest, options?: AxiosRequestConfig) {
+        return CommissionsApiFp(this.configuration).estimateCommission(requestParameters.policyCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * This will get commission.
      * @summary Retrieve the commission

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

@@ -14,6 +14,7 @@ import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { CreateCommissionRequestDto } from '../models';
 import { CreateCommissionResponseClass } from '../models';
+import { EstimateCommissionsResponseClass } from '../models';
 import { GetCommissionResponseClass } from '../models';
 import { ListCommissionsResponseClass } from '../models';
 import { UpdateCommissionRequestDto } from '../models';
@@ -41,6 +42,15 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
      * @throws {RequiredError}
      */
     deleteCommission: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will estimate commissions for a given policy.
+     * @summary Retrieve the estimate commissions
+     * @param {string} policyCode 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}
+     */
+    estimateCommission: (policyCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This will get commission.
      * @summary Retrieve the commission
@@ -100,6 +110,15 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteCommission(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will estimate commissions for a given policy.
+     * @summary Retrieve the estimate commissions
+     * @param {string} policyCode 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}
+     */
+    estimateCommission(policyCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EstimateCommissionsResponseClass>>;
     /**
      * This will get commission.
      * @summary Retrieve the commission
@@ -159,6 +178,15 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
      * @throws {RequiredError}
      */
     deleteCommission(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will estimate commissions for a given policy.
+     * @summary Retrieve the estimate commissions
+     * @param {string} policyCode 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}
+     */
+    estimateCommission(policyCode: string, authorization?: string, options?: any): AxiosPromise<EstimateCommissionsResponseClass>;
     /**
      * This will get commission.
      * @summary Retrieve the commission
@@ -233,6 +261,25 @@ export interface CommissionsApiDeleteCommissionRequest {
      */
     readonly authorization?: string;
 }
+/**
+ * Request parameters for estimateCommission operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiEstimateCommissionRequest
+ */
+export interface CommissionsApiEstimateCommissionRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionsApiEstimateCommission
+     */
+    readonly policyCode: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiEstimateCommission
+     */
+    readonly authorization?: string;
+}
 /**
  * Request parameters for getCommission operation in CommissionsApi.
  * @export
@@ -363,6 +410,15 @@ export declare class CommissionsApi extends BaseAPI {
      * @memberof CommissionsApi
      */
     deleteCommission(requestParameters: CommissionsApiDeleteCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will estimate commissions for a given policy.
+     * @summary Retrieve the estimate commissions
+     * @param {CommissionsApiEstimateCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    estimateCommission(requestParameters: CommissionsApiEstimateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EstimateCommissionsResponseClass, any, {}>>;
     /**
      * This will get commission.
      * @summary Retrieve the commission

package/dist/api/commissions-api.js

@@ -193,6 +193,54 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * This will estimate commissions for a given policy.
+         * @summary Retrieve the estimate commissions
+         * @param {string} policyCode 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}
+         */
+        estimateCommission: function (policyCode, authorization, options) {
+            if (options === void 0) { options = {}; }
+            return __awaiter(_this, void 0, void 0, function () {
+                var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            // verify required parameter 'policyCode' is not null or undefined
+                            (0, common_1.assertParamExists)('estimateCommission', 'policyCode', policyCode);
+                            localVarPath = "/commissionservice/v1/commissions/estimate/{policyCode}"
+                                .replace("{".concat("policyCode", "}"), encodeURIComponent(String(policyCode)));
+                            localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                                baseAccessToken = configuration.accessToken;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication bearer required
+                            // http bearer authentication required
+                            return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
+                        case 1:
+                            // authentication bearer required
+                            // http bearer authentication required
+                            _a.sent();
+                            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
         /**
          * This will get commission.
          * @summary Retrieve the commission
@@ -424,6 +472,27 @@ var CommissionsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * This will estimate commissions for a given policy.
+         * @summary Retrieve the estimate commissions
+         * @param {string} policyCode 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}
+         */
+        estimateCommission: function (policyCode, authorization, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.estimateCommission(policyCode, authorization, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
         /**
          * This will get commission.
          * @summary Retrieve the commission
@@ -527,6 +596,17 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
         deleteCommission: function (code, authorization, options) {
             return localVarFp.deleteCommission(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * This will estimate commissions for a given policy.
+         * @summary Retrieve the estimate commissions
+         * @param {string} policyCode 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}
+         */
+        estimateCommission: function (policyCode, authorization, options) {
+            return localVarFp.estimateCommission(policyCode, authorization, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * This will get commission.
          * @summary Retrieve the commission
@@ -606,6 +686,18 @@ var CommissionsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.CommissionsApiFp)(this.configuration).deleteCommission(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * This will estimate commissions for a given policy.
+     * @summary Retrieve the estimate commissions
+     * @param {CommissionsApiEstimateCommissionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    CommissionsApi.prototype.estimateCommission = function (requestParameters, options) {
+        var _this = this;
+        return (0, exports.CommissionsApiFp)(this.configuration).estimateCommission(requestParameters.policyCode, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * This will get commission.
      * @summary Retrieve the commission

package/dist/models/commission-estimate-class.d.ts

@@ -0,0 +1,59 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.
+ */
+/**
+ *
+ * @export
+ * @interface CommissionEstimateClass
+ */
+export interface CommissionEstimateClass {
+    /**
+     * The name of the commission estimate
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'name': string;
+    /**
+     * A detailed description of the commission estimate
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'description': string;
+    /**
+     * The estimated commission amount in the smallest currency unit (e.g., cents)
+     * @type {number}
+     * @memberof CommissionEstimateClass
+     */
+    'amount': number;
+    /**
+     * Type of commission. Valid values: sales, maintenance, other
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'type': CommissionEstimateClassTypeEnum;
+    /**
+     * Commission group indicating whether this is for the first year or following years
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'group': CommissionEstimateClassGroupEnum;
+}
+export declare const CommissionEstimateClassTypeEnum: {
+    readonly Sales: "sales";
+    readonly Maintenance: "maintenance";
+    readonly Other: "other";
+};
+export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];
+export declare const CommissionEstimateClassGroupEnum: {
+    readonly FirstYear: "firstYear";
+    readonly FollowingYears: "followingYears";
+};
+export type CommissionEstimateClassGroupEnum = typeof CommissionEstimateClassGroupEnum[keyof typeof CommissionEstimateClassGroupEnum];

package/dist/models/commission-estimate-class.js

@@ -0,0 +1,25 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionEstimateClassGroupEnum = exports.CommissionEstimateClassTypeEnum = void 0;
+exports.CommissionEstimateClassTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+};
+exports.CommissionEstimateClassGroupEnum = {
+    FirstYear: 'firstYear',
+    FollowingYears: 'followingYears'
+};

package/dist/models/estimate-commissions-response-class.d.ts

@@ -0,0 +1,73 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionEstimateClass } from './commission-estimate-class';
+/**
+ *
+ * @export
+ * @interface EstimateCommissionsResponseClass
+ */
+export interface EstimateCommissionsResponseClass {
+    /**
+     * The unique code of the policy for which commissions are being estimated
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'policyCode': string;
+    /**
+     * The unique number of the policy
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'policyNumber': string;
+    /**
+     * The unique code of the partner associated with the policy
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'partnerCode': string;
+    /**
+     * The unique number of the partner
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'partnerNumber': string;
+    /**
+     * The total estimated commission amount in the smallest currency unit (e.g., cents). This is the sum of all commission estimates
+     * @type {number}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'totalAmount': number;
+    /**
+     * A detailed description explaining the commission estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'description': string;
+    /**
+     * The version identifier of the commission agreement being used for this estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * The code of the commission agreement rule that was used for this estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissionAgreementRuleCode': string;
+    /**
+     * An array of individual commission estimates that make up the total commission. Each estimate represents a specific commission component with its own amount, type, and group
+     * @type {Array<CommissionEstimateClass>}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissions': Array<CommissionEstimateClass>;
+}

package/dist/models/estimate-commissions-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/index.d.ts

@@ -9,6 +9,7 @@ export * from './commission-agreement-version-class';
 export * from './commission-class';
 export * from './commission-conditions-dto';
 export * from './commission-config-dto';
+export * from './commission-estimate-class';
 export * from './commission-item-class';
 export * from './commission-recipient-class';
 export * from './commission-settlement-class';
@@ -27,6 +28,7 @@ export * from './create-commission-request-dto';
 export * from './create-commission-response-class';
 export * from './create-commission-settlement-request-dto';
 export * from './create-commission-settlement-response-class';
+export * from './estimate-commissions-response-class';
 export * from './evaluate-commission-agreement-rule-request-dto';
 export * from './evaluate-commission-agreement-rule-response-class';
 export * from './evaluated-commission-class';

package/dist/models/index.js

@@ -25,6 +25,7 @@ __exportStar(require("./commission-agreement-version-class"), exports);
 __exportStar(require("./commission-class"), exports);
 __exportStar(require("./commission-conditions-dto"), exports);
 __exportStar(require("./commission-config-dto"), exports);
+__exportStar(require("./commission-estimate-class"), exports);
 __exportStar(require("./commission-item-class"), exports);
 __exportStar(require("./commission-recipient-class"), exports);
 __exportStar(require("./commission-settlement-class"), exports);
@@ -43,6 +44,7 @@ __exportStar(require("./create-commission-request-dto"), exports);
 __exportStar(require("./create-commission-response-class"), exports);
 __exportStar(require("./create-commission-settlement-request-dto"), exports);
 __exportStar(require("./create-commission-settlement-response-class"), exports);
+__exportStar(require("./estimate-commissions-response-class"), exports);
 __exportStar(require("./evaluate-commission-agreement-rule-request-dto"), exports);
 __exportStar(require("./evaluate-commission-agreement-rule-response-class"), exports);
 __exportStar(require("./evaluated-commission-class"), exports);

package/models/commission-estimate-class.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionEstimateClass
+ */
+export interface CommissionEstimateClass {
+    /**
+     * The name of the commission estimate
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'name': string;
+    /**
+     * A detailed description of the commission estimate
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'description': string;
+    /**
+     * The estimated commission amount in the smallest currency unit (e.g., cents)
+     * @type {number}
+     * @memberof CommissionEstimateClass
+     */
+    'amount': number;
+    /**
+     * Type of commission. Valid values: sales, maintenance, other
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'type': CommissionEstimateClassTypeEnum;
+    /**
+     * Commission group indicating whether this is for the first year or following years
+     * @type {string}
+     * @memberof CommissionEstimateClass
+     */
+    'group': CommissionEstimateClassGroupEnum;
+}
+
+export const CommissionEstimateClassTypeEnum = {
+    Sales: 'sales',
+    Maintenance: 'maintenance',
+    Other: 'other'
+} as const;
+
+export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];
+export const CommissionEstimateClassGroupEnum = {
+    FirstYear: 'firstYear',
+    FollowingYears: 'followingYears'
+} as const;
+
+export type CommissionEstimateClassGroupEnum = typeof CommissionEstimateClassGroupEnum[keyof typeof CommissionEstimateClassGroupEnum];
+
+

package/models/estimate-commissions-response-class.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CommissionEstimateClass } from './commission-estimate-class';
+
+/**
+ * 
+ * @export
+ * @interface EstimateCommissionsResponseClass
+ */
+export interface EstimateCommissionsResponseClass {
+    /**
+     * The unique code of the policy for which commissions are being estimated
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'policyCode': string;
+    /**
+     * The unique number of the policy
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'policyNumber': string;
+    /**
+     * The unique code of the partner associated with the policy
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'partnerCode': string;
+    /**
+     * The unique number of the partner
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'partnerNumber': string;
+    /**
+     * The total estimated commission amount in the smallest currency unit (e.g., cents). This is the sum of all commission estimates
+     * @type {number}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'totalAmount': number;
+    /**
+     * A detailed description explaining the commission estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'description': string;
+    /**
+     * The version identifier of the commission agreement being used for this estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * The code of the commission agreement rule that was used for this estimation
+     * @type {string}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissionAgreementRuleCode': string;
+    /**
+     * An array of individual commission estimates that make up the total commission. Each estimate represents a specific commission component with its own amount, type, and group
+     * @type {Array<CommissionEstimateClass>}
+     * @memberof EstimateCommissionsResponseClass
+     */
+    'commissions': Array<CommissionEstimateClass>;
+}
+

package/models/index.ts

@@ -9,6 +9,7 @@ export * from './commission-agreement-version-class';
 export * from './commission-class';
 export * from './commission-conditions-dto';
 export * from './commission-config-dto';
+export * from './commission-estimate-class';
 export * from './commission-item-class';
 export * from './commission-recipient-class';
 export * from './commission-settlement-class';
@@ -27,6 +28,7 @@ export * from './create-commission-request-dto';
 export * from './create-commission-response-class';
 export * from './create-commission-settlement-request-dto';
 export * from './create-commission-settlement-response-class';
+export * from './estimate-commissions-response-class';
 export * from './evaluate-commission-agreement-rule-request-dto';
 export * from './evaluate-commission-agreement-rule-response-class';
 export * from './evaluated-commission-class';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/commission-sdk-node",
-  "version": "1.0.0-beta.37",
+  "version": "1.0.0-beta.38",
   "description": "OpenAPI client for @emilgroup/commission-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [