@emilgroup/commission-sdk-node 1.0.0-beta.4 → 1.0.0-beta.40

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
@@ -57,15 +67,15 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
      * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @param {'createdAt'} [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 {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @param {string} [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}
      */
-    listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This will update commission.
      * @summary Update 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
@@ -116,15 +135,15 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
      * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @param {'createdAt'} [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 {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @param {string} [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}
      */
-    listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
+    listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
     /**
      * This will update commission.
      * @summary Update 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
@@ -175,15 +203,15 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
      * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
-     * @param {'createdAt'} [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 {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+     * @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @param {string} [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}
      */
-    listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
+    listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
     /**
      * This will update commission.
      * @summary Update 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
@@ -284,10 +331,10 @@ export interface CommissionsApiListCommissionsRequest {
     readonly pageToken?: string;
     /**
      * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
+     * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'}
      * @memberof CommissionsApiListCommissions
      */
-    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
+    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode';
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {string}
@@ -296,16 +343,16 @@ export interface CommissionsApiListCommissionsRequest {
     readonly search?: string;
     /**
      * 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 {'createdAt'}
+     * @type {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
      * @memberof CommissionsApiListCommissions
      */
-    readonly order?: 'createdAt';
+    readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
     /**
      * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
-     * @type {'items'}
+     * @type {'items' | 'agreement'}
      * @memberof CommissionsApiListCommissions
      */
-    readonly expand?: 'items';
+    readonly expand?: 'items' | 'agreement';
     /**
      * 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 {string}
@@ -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
@@ -253,10 +301,10 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {string} [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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-         * @param {'createdAt'} [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 {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {string} [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}
@@ -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
@@ -452,10 +521,10 @@ var CommissionsApiFp = function (configuration) {
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {string} [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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-         * @param {'createdAt'} [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 {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {string} [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}
@@ -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
@@ -545,10 +625,10 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {string} [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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-         * @param {'createdAt'} [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 {'items'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
          * @param {string} [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}
@@ -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/api.d.ts

@@ -9,8 +9,11 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+export * from './api/commission-agreement-products-api';
+export * from './api/commission-agreement-rules-api';
 export * from './api/commission-agreement-versions-api';
 export * from './api/commission-agreements-api';
 export * from './api/commission-recipients-api';
+export * from './api/commission-settlements-api';
 export * from './api/commissions-api';
 export * from './api/default-api';

package/dist/api.js

@@ -27,8 +27,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api/commission-agreement-products-api"), exports);
+__exportStar(require("./api/commission-agreement-rules-api"), exports);
 __exportStar(require("./api/commission-agreement-versions-api"), exports);
 __exportStar(require("./api/commission-agreements-api"), exports);
 __exportStar(require("./api/commission-recipients-api"), exports);
+__exportStar(require("./api/commission-settlements-api"), exports);
 __exportStar(require("./api/commissions-api"), exports);
 __exportStar(require("./api/default-api"), exports);

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

@@ -9,6 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
+import { CommissionAgreementVersionClass } from './commission-agreement-version-class';
 /**
  *
  * @export
@@ -34,11 +36,23 @@ export interface CommissionAgreementClass {
      */
     'code': string;
     /**
-     * Current status of the commission agreement (e.g., active, inactive)
+     * Unique number identifier for the commission agreement
+     * @type {string}
+     * @memberof CommissionAgreementClass
+     */
+    'commissionAgreementNumber': string;
+    /**
+     * Current status of the commission agreement (e.g., draft, active, processing, archived)
      * @type {string}
      * @memberof CommissionAgreementClass
      */
     'status': CommissionAgreementClassStatusEnum;
+    /**
+     * Array of commission agreement versions
+     * @type {Array<CommissionAgreementVersionClass>}
+     * @memberof CommissionAgreementClass
+     */
+    'versions'?: Array<CommissionAgreementVersionClass>;
     /**
      * Detailed description of the commission agreement terms and conditions
      * @type {string}
@@ -46,11 +60,17 @@ export interface CommissionAgreementClass {
      */
     'description'?: string;
     /**
-     * Frequency at which commissions are billed (e.g., monthly, quarterly, yearly)
+     * Frequency at which commissions are billed (e.g., immediately, monthly, quarterly, halfYearly, yearly)
      * @type {string}
      * @memberof CommissionAgreementClass
      */
     'billingFrequency'?: CommissionAgreementClassBillingFrequencyEnum;
+    /**
+     * Metadata associated with the commission agreement
+     * @type {CommissionAgreementMetadataDto}
+     * @memberof CommissionAgreementClass
+     */
+    'metadata'?: CommissionAgreementMetadataDto;
     /**
      * Timestamp when the commission agreement was created
      * @type {string}
@@ -77,13 +97,17 @@ export interface CommissionAgreementClass {
     'updatedBy'?: string;
 }
 export declare const CommissionAgreementClassStatusEnum: {
+    readonly Draft: "draft";
     readonly Active: "active";
-    readonly Inactive: "inactive";
+    readonly Processing: "processing";
+    readonly Archived: "archived";
 };
 export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
 export declare const CommissionAgreementClassBillingFrequencyEnum: {
+    readonly Immediately: "immediately";
     readonly Monthly: "monthly";
     readonly Quarterly: "quarterly";
+    readonly HalfYearly: "halfYearly";
     readonly Yearly: "yearly";
 };
 export type CommissionAgreementClassBillingFrequencyEnum = typeof CommissionAgreementClassBillingFrequencyEnum[keyof typeof CommissionAgreementClassBillingFrequencyEnum];

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

@@ -15,11 +15,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommissionAgreementClassBillingFrequencyEnum = exports.CommissionAgreementClassStatusEnum = void 0;
 exports.CommissionAgreementClassStatusEnum = {
+    Draft: 'draft',
     Active: 'active',
-    Inactive: 'inactive'
+    Processing: 'processing',
+    Archived: 'archived'
 };
 exports.CommissionAgreementClassBillingFrequencyEnum = {
+    Immediately: 'immediately',
     Monthly: 'monthly',
     Quarterly: 'quarterly',
+    HalfYearly: 'halfYearly',
     Yearly: 'yearly'
 };

package/dist/models/commission-agreement-metadata-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { CommissionAgreementMetadataPartnerDto } from './commission-agreement-metadata-partner-dto';
+/**
+ *
+ * @export
+ * @interface CommissionAgreementMetadataDto
+ */
+export interface CommissionAgreementMetadataDto {
+    /**
+     * Main partner of the commission agreement
+     * @type {CommissionAgreementMetadataPartnerDto}
+     * @memberof CommissionAgreementMetadataDto
+     */
+    'mainPartner'?: CommissionAgreementMetadataPartnerDto;
+}

package/dist/models/commission-agreement-metadata-dto.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/commission-agreement-metadata-partner-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 CommissionAgreementMetadataPartnerDto
+ */
+export interface CommissionAgreementMetadataPartnerDto {
+    /**
+     * Code of the partner
+     * @type {string}
+     * @memberof CommissionAgreementMetadataPartnerDto
+     */
+    'code': string;
+    /**
+     * Name of the partner
+     * @type {string}
+     * @memberof CommissionAgreementMetadataPartnerDto
+     */
+    'name': string;
+}

package/dist/models/commission-agreement-metadata-partner-dto.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 });