@emilgroup/commission-sdk-node 2.9.1-beta.3 → 2.9.1-beta.6

package/api/commissions-api.ts

@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
+import { CreateCommissionClawbackRequestDto } from '../models';
+// @ts-ignore
+import { CreateCommissionClawbackResponseClass } from '../models';
+// @ts-ignore
 import { CreateCommissionRequestDto } from '../models';
 // @ts-ignore
 import { CreateCommissionResponseClass } from '../models';
@@ -33,6 +37,10 @@ import { GetCommissionResponseClass } from '../models';
 // @ts-ignore
 import { ListCommissionsResponseClass } from '../models';
 // @ts-ignore
+import { TriggerDueCommissionClawbacksRequestDto } from '../models';
+// @ts-ignore
+import { TriggerDueCommissionClawbacksResponseClass } from '../models';
+// @ts-ignore
 import { UpdateCommissionRequestDto } from '../models';
 // @ts-ignore
 import { UpdateCommissionResponseClass } from '../models';
@@ -93,6 +101,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Creates a manual clawback for one commission.
+         * @summary Create the commission clawback
+         * @param {string} code Unique identifier for the object.
+         * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCommissionClawback: async (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('createCommissionClawback', 'code', code)
+            // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
+            assertParamExists('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto)
+            const localVarPath = `/commissionservice/v1/commissions/{code}/clawbacks`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // 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: 'POST', ...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);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createCommissionClawbackRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * This will delete commission.
          * @summary Delete the commission
@@ -243,15 +302,15 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
          * @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' | 'commissionAgreementNumber' | '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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | '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 {'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 {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | '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: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/commissionservice/v1/commissions`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -313,6 +372,53 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+         * @summary Create the due commission clawbacks trigger
+         * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
+            assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
+            const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
+            // 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: 'POST', ...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);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * This will update commission.
          * @summary Update the commission
@@ -386,6 +492,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Creates a manual clawback for one commission.
+         * @summary Create the commission clawback
+         * @param {string} code Unique identifier for the object.
+         * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * This will delete commission.
          * @summary Delete the commission
@@ -429,18 +548,30 @@ export const CommissionsApiFp = function(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' | 'commissionAgreementNumber' | '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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | '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 {'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 {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | '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}
          */
-        async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
+        async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+         * @summary Create the due commission clawbacks trigger
+         * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
         /**
          * This will update commission.
          * @summary Update the commission
@@ -475,6 +606,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
         createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
             return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Creates a manual clawback for one commission.
+         * @summary Create the commission clawback
+         * @param {string} code Unique identifier for the object.
+         * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
+            return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * This will delete commission.
          * @summary Delete the commission
@@ -515,17 +658,28 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
          * @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' | 'commissionAgreementNumber' | '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 {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | '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 {'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 {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | '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' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
+        listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
             return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+         * @summary Create the due commission clawbacks trigger
+         * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
+            return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * This will update commission.
          * @summary Update the commission
@@ -562,6 +716,34 @@ export interface CommissionsApiCreateCommissionRequest {
     readonly authorization?: string
 }
 
+/**
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiCreateCommissionClawbackRequest
+ */
+export interface CommissionsApiCreateCommissionClawbackRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionsApiCreateCommissionClawback
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {CreateCommissionClawbackRequestDto}
+     * @memberof CommissionsApiCreateCommissionClawback
+     */
+    readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiCreateCommissionClawback
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for deleteCommission operation in CommissionsApi.
  * @export
@@ -661,10 +843,10 @@ export interface CommissionsApiListCommissionsRequest {
 
     /**
      * 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' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'}
+     * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'}
      * @memberof CommissionsApiListCommissions
      */
-    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'
+    readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'
 
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -675,10 +857,10 @@ export interface CommissionsApiListCommissionsRequest {
 
     /**
      * 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 {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
+     * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
      * @memberof CommissionsApiListCommissions
      */
-    readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
+    readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | '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.
@@ -695,6 +877,27 @@ export interface CommissionsApiListCommissionsRequest {
     readonly filters?: string
 }
 
+/**
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
+ * @export
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
+ */
+export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
+    /**
+     * 
+     * @type {TriggerDueCommissionClawbacksRequestDto}
+     * @memberof CommissionsApiTriggerDueCommissionClawbacks
+     */
+    readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionsApiTriggerDueCommissionClawbacks
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for updateCommission operation in CommissionsApi.
  * @export
@@ -742,6 +945,18 @@ export class CommissionsApi extends BaseAPI {
         return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Creates a manual clawback for one commission.
+     * @summary Create the commission clawback
+     * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
+        return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * This will delete commission.
      * @summary Delete the commission
@@ -790,6 +1005,18 @@ export class CommissionsApi extends BaseAPI {
         return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
+     * @summary Create the due commission clawbacks trigger
+     * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionsApi
+     */
+    public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
+        return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * This will update commission.
      * @summary Update the commission

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

@@ -55,11 +55,11 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (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=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, agreementCode, startDate, endDate, createdAt</i>
+     * @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-     * @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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</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: agreements<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, agreementCode, startDate, endDate, createdAt</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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -104,11 +104,11 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
      * @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 {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, agreementCode, startDate, endDate, createdAt</i>
+     * @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-     * @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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</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: agreements<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, agreementCode, startDate, endDate, createdAt</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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -153,11 +153,11 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
      * @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 {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, agreementCode, startDate, endDate, createdAt</i>
+     * @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-     * @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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</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: agreements<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, agreementCode, startDate, endDate, createdAt</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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -251,7 +251,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
      */
     readonly pageToken?: string;
     /**
-     * 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, agreementCode, startDate, endDate, createdAt</i>
+     * 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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @type {string}
      * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
      */
@@ -263,7 +263,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
      */
     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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</i>
      * @type {string}
      * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
      */
@@ -275,7 +275,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
      */
     readonly expand?: string;
     /**
-     * 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, agreementCode, startDate, endDate, createdAt</i>
+     * 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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
      * @type {string}
      * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
      */

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

@@ -253,11 +253,11 @@ var CommissionAgreementVersionsApiAxiosParamCreator = 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 {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, agreementCode, startDate, endDate, createdAt</i>
+         * @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-         * @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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</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: agreements<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, agreementCode, startDate, endDate, createdAt</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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -399,11 +399,11 @@ var CommissionAgreementVersionsApiFp = 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 {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, agreementCode, startDate, endDate, createdAt</i>
+         * @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-         * @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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</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: agreements<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, agreementCode, startDate, endDate, createdAt</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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -470,11 +470,11 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
          * @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 {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, agreementCode, startDate, endDate, createdAt</i>
+         * @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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
-         * @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: code, createdAt, startDate, endDate</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: code, createdAt, startDate, endDate, settlementCreationDate</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: agreements<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, agreementCode, startDate, endDate, createdAt</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, agreementCode, startDate, endDate, settlementCreationDate, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */