@emilgroup/commission-sdk-node 2.9.1-beta.1 → 2.9.1-beta.103

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

@@ -59,7 +59,7 @@ export declare const CommissionAgreementProductsApiAxiosParamCreator: (configura
      * @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 {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
      * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
-     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
      * @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.<br/>       <br/>       <i>Allowed values: version<i>
      * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
      * @param {*} [options] Override http request option.
@@ -118,7 +118,7 @@ export declare const CommissionAgreementProductsApiFp: (configuration?: Configur
      * @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 {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
      * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
-     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
      * @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.<br/>       <br/>       <i>Allowed values: version<i>
      * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
      * @param {*} [options] Override http request option.
@@ -177,7 +177,7 @@ export declare const CommissionAgreementProductsApiFactory: (configuration?: Con
      * @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 {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
      * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
-     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
      * @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.<br/>       <br/>       <i>Allowed values: version<i>
      * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
      * @param {*} [options] Override http request option.
@@ -295,7 +295,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
      */
     readonly search?: string;
     /**
-     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
      * @type {string}
      * @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
      */

package/dist/api/commission-agreement-products-api.js

@@ -255,7 +255,7 @@ var CommissionAgreementProductsApiAxiosParamCreator = function (configuration) {
          * @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 {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
          * @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.<br/>       <br/>       <i>Allowed values: version<i>
          * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {*} [options] Override http request option.
@@ -454,7 +454,7 @@ var CommissionAgreementProductsApiFp = function (configuration) {
          * @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 {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
          * @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.<br/>       <br/>       <i>Allowed values: version<i>
          * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {*} [options] Override http request option.
@@ -547,7 +547,7 @@ var CommissionAgreementProductsApiFactory = function (configuration, basePath, a
          * @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 {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, productSlug</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
          * @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.<br/>       <br/>       <i>Allowed values: version<i>
          * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
          * @param {*} [options] Override http request option.

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

@@ -67,10 +67,11 @@ export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuratio
      * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
      * @summary Retrieve the commission agreement rule evaluation default data
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvaluationDefaultData: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getEvaluationDefaultData: (authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves a list of commission agreement rules.
      * @summary List commission agreement rules
@@ -143,10 +144,11 @@ export declare const CommissionAgreementRulesApiFp: (configuration?: Configurati
      * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
      * @summary Retrieve the commission agreement rule evaluation default data
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvaluationDefaultData(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
+    getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
     /**
      * Retrieves a list of commission agreement rules.
      * @summary List commission agreement rules
@@ -219,10 +221,11 @@ export declare const CommissionAgreementRulesApiFactory: (configuration?: Config
      * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
      * @summary Retrieve the commission agreement rule evaluation default data
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getEvaluationDefaultData(authorization?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
+    getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
     /**
      * Retrieves a list of commission agreement rules.
      * @summary List commission agreement rules
@@ -343,6 +346,12 @@ export interface CommissionAgreementRulesApiGetEvaluationDefaultDataRequest {
      * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
      */
     readonly authorization?: string;
+    /**
+     * Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
+     * @type {string}
+     * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
+     */
+    readonly commissionAgreementProductCode?: string;
 }
 /**
  * Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.

package/dist/api/commission-agreement-rules-api.js

@@ -300,10 +300,11 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
          * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
          * @summary Retrieve the commission agreement rule evaluation default data
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvaluationDefaultData: function (authorization, options) {
+        getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -326,6 +327,9 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
+                            if (commissionAgreementProductCode !== undefined) {
+                                localVarQueryParameter['commissionAgreementProductCode'] = commissionAgreementProductCode;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -564,15 +568,16 @@ var CommissionAgreementRulesApiFp = function (configuration) {
          * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
          * @summary Retrieve the commission agreement rule evaluation default data
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvaluationDefaultData: function (authorization, options) {
+        getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, 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.getEvaluationDefaultData(authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -688,11 +693,12 @@ var CommissionAgreementRulesApiFactory = function (configuration, basePath, axio
          * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
          * @summary Retrieve the commission agreement rule evaluation default data
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getEvaluationDefaultData: function (authorization, options) {
-            return localVarFp.getEvaluationDefaultData(authorization, options).then(function (request) { return request(axios, basePath); });
+        getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
+            return localVarFp.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Retrieves a list of commission agreement rules.
@@ -796,7 +802,7 @@ var CommissionAgreementRulesApi = /** @class */ (function (_super) {
     CommissionAgreementRulesApi.prototype.getEvaluationDefaultData = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.CommissionAgreementRulesApiFp)(this.configuration).getEvaluationDefaultData(requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.CommissionAgreementRulesApiFp)(this.configuration).getEvaluationDefaultData(requestParameters.authorization, requestParameters.commissionAgreementProductCode, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Retrieves a list of commission agreement rules.

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

@@ -61,7 +61,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @param {'commissions'} [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.
@@ -69,7 +69,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * This will publish multiple commission settlements.
      * @summary Create the commission settlement publish
@@ -138,7 +138,7 @@ export declare const CommissionSettlementsApiFp: (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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @param {'commissions'} [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.
@@ -146,7 +146,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
+    listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
     /**
      * This will publish multiple commission settlements.
      * @summary Create the commission settlement publish
@@ -215,7 +215,7 @@ export declare const CommissionSettlementsApiFactory: (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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @param {'commissions'} [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.
@@ -223,7 +223,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
+    listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
     /**
      * This will publish multiple commission settlements.
      * @summary Create the commission settlement publish
@@ -342,10 +342,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
     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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
+     * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
      * @memberof CommissionSettlementsApiListCommissionSettlements
      */
-    readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
+    readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode';
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {string}

package/dist/api/commission-settlements-api.js

@@ -253,7 +253,7 @@ var CommissionSettlementsApiAxiosParamCreator = 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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
          * @param {'commissions'} [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.
@@ -550,7 +550,7 @@ var CommissionSettlementsApiFp = 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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
          * @param {'commissions'} [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.
@@ -685,7 +685,7 @@ var CommissionSettlementsApiFactory = 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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [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 {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
          * @param {'commissions'} [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.