@emilgroup/commission-sdk-node 2.9.0 → 2.9.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-versions-api.ts +12 -12
  4. package/api/commission-settlements-api.ts +107 -0
  5. package/api/commissions-api.ts +13 -13
  6. package/dist/api/commission-agreement-versions-api.d.ts +12 -12
  7. package/dist/api/commission-agreement-versions-api.js +9 -9
  8. package/dist/api/commission-settlements-api.d.ts +57 -0
  9. package/dist/api/commission-settlements-api.js +93 -0
  10. package/dist/api/commissions-api.d.ts +13 -13
  11. package/dist/api/commissions-api.js +6 -6
  12. package/dist/models/commission-agreement-version-class.d.ts +6 -0
  13. package/dist/models/commission-class.d.ts +6 -0
  14. package/dist/models/create-commission-agreement-request-dto.d.ts +6 -0
  15. package/dist/models/create-commission-agreement-version-request-dto.d.ts +6 -0
  16. package/dist/models/index.d.ts +2 -0
  17. package/dist/models/index.js +2 -0
  18. package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
  19. package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
  20. package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
  21. package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
  22. package/models/commission-agreement-version-class.ts +6 -0
  23. package/models/commission-class.ts +6 -0
  24. package/models/create-commission-agreement-request-dto.ts +6 -0
  25. package/models/create-commission-agreement-version-request-dto.ts +6 -0
  26. package/models/index.ts +2 -0
  27. package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
  28. package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
  29. package/package.json +1 -1
@@ -81,6 +81,8 @@ models/patch-commission-agreement-status-request-dto.ts
81
81
  models/patch-commission-agreement-status-response-class.ts
82
82
  models/publish-commission-settlements-request-dto.ts
83
83
  models/publish-commission-settlements-response-class.ts
84
+ models/trigger-commission-settlement-creation-request-dto.ts
85
+ models/trigger-commission-settlement-creation-response-class.ts
84
86
  models/update-commission-agreement-product-request-dto.ts
85
87
  models/update-commission-agreement-product-response-class.ts
86
88
  models/update-commission-agreement-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/commission-sdk-node@2.9.0 --save
20
+ npm install @emilgroup/commission-sdk-node@2.9.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk-node@2.9.0
24
+ yarn add @emilgroup/commission-sdk-node@2.9.1-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -188,11 +188,11 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
189
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
190
  * @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.
191
- * @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>
191
+ * @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>
192
192
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
193
- * @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>
193
+ * @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>
194
194
  * @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>
195
- * @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>
195
+ * @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>
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
@@ -311,11 +311,11 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
311
311
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
312
312
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
313
313
  * @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.
314
- * @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>
314
+ * @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>
315
315
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
316
- * @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>
316
+ * @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>
317
317
  * @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>
318
- * @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>
318
+ * @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>
319
319
  * @param {*} [options] Override http request option.
320
320
  * @throws {RequiredError}
321
321
  */
@@ -373,11 +373,11 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
373
373
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
374
374
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
375
375
  * @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.
376
- * @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>
376
+ * @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>
377
377
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
378
- * @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>
378
+ * @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>
379
379
  * @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>
380
- * @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>
380
+ * @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>
381
381
  * @param {*} [options] Override http request option.
382
382
  * @throws {RequiredError}
383
383
  */
@@ -485,7 +485,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
485
485
  readonly pageToken?: string
486
486
 
487
487
  /**
488
- * 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>
488
+ * 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>
489
489
  * @type {string}
490
490
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
491
491
  */
@@ -499,7 +499,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
499
499
  readonly search?: string
500
500
 
501
501
  /**
502
- * 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>
502
+ * 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>
503
503
  * @type {string}
504
504
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
505
505
  */
@@ -513,7 +513,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
513
513
  readonly expand?: string
514
514
 
515
515
  /**
516
- * 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>
516
+ * 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>
517
517
  * @type {string}
518
518
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
519
519
  */
@@ -33,6 +33,10 @@ import { PublishCommissionSettlementsRequestDto } from '../models';
33
33
  // @ts-ignore
34
34
  import { PublishCommissionSettlementsResponseClass } from '../models';
35
35
  // @ts-ignore
36
+ import { TriggerCommissionSettlementCreationRequestDto } from '../models';
37
+ // @ts-ignore
38
+ import { TriggerCommissionSettlementCreationResponseClass } from '../models';
39
+ // @ts-ignore
36
40
  import { UpdateCommissionSettlementRequestDto } from '../models';
37
41
  // @ts-ignore
38
42
  import { UpdateCommissionSettlementResponseClass } from '../models';
@@ -313,6 +317,53 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
313
317
  options: localVarRequestOptions,
314
318
  };
315
319
  },
320
+ /**
321
+ * Triggers the commission settlement creation job.
322
+ * @summary Create the commission settlement creation job
323
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
324
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
325
+ * @param {*} [options] Override http request option.
326
+ * @throws {RequiredError}
327
+ */
328
+ triggerCommissionSettlementCreation: async (triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
329
+ // verify required parameter 'triggerCommissionSettlementCreationRequestDto' is not null or undefined
330
+ assertParamExists('triggerCommissionSettlementCreation', 'triggerCommissionSettlementCreationRequestDto', triggerCommissionSettlementCreationRequestDto)
331
+ const localVarPath = `/commissionservice/v1/commission-settlements/commission-settlement-creation/trigger`;
332
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
333
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
334
+ let baseOptions;
335
+ let baseAccessToken;
336
+ if (configuration) {
337
+ baseOptions = configuration.baseOptions;
338
+ baseAccessToken = configuration.accessToken;
339
+ }
340
+
341
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
342
+ const localVarHeaderParameter = {} as any;
343
+ const localVarQueryParameter = {} as any;
344
+
345
+ // authentication bearer required
346
+ // http bearer authentication required
347
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
348
+
349
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
350
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
351
+ }
352
+
353
+
354
+
355
+ localVarHeaderParameter['Content-Type'] = 'application/json';
356
+
357
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
358
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
359
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
360
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerCommissionSettlementCreationRequestDto, localVarRequestOptions, configuration)
361
+
362
+ return {
363
+ url: toPathString(localVarUrlObj),
364
+ options: localVarRequestOptions,
365
+ };
366
+ },
316
367
  /**
317
368
  * This will update commission settlement.
318
369
  * @summary Update the commission settlement
@@ -441,6 +492,18 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
441
492
  const localVarAxiosArgs = await localVarAxiosParamCreator.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options);
442
493
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
443
494
  },
495
+ /**
496
+ * Triggers the commission settlement creation job.
497
+ * @summary Create the commission settlement creation job
498
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
499
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
500
+ * @param {*} [options] Override http request option.
501
+ * @throws {RequiredError}
502
+ */
503
+ async triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerCommissionSettlementCreationResponseClass>> {
504
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options);
505
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
506
+ },
444
507
  /**
445
508
  * This will update commission settlement.
446
509
  * @summary Update the commission settlement
@@ -526,6 +589,17 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
526
589
  publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass> {
527
590
  return localVarFp.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options).then((request) => request(axios, basePath));
528
591
  },
592
+ /**
593
+ * Triggers the commission settlement creation job.
594
+ * @summary Create the commission settlement creation job
595
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
596
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
597
+ * @param {*} [options] Override http request option.
598
+ * @throws {RequiredError}
599
+ */
600
+ triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerCommissionSettlementCreationResponseClass> {
601
+ return localVarFp.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options).then((request) => request(axios, basePath));
602
+ },
529
603
  /**
530
604
  * This will update commission settlement.
531
605
  * @summary Update the commission settlement
@@ -695,6 +769,27 @@ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
695
769
  readonly authorization?: string
696
770
  }
697
771
 
772
+ /**
773
+ * Request parameters for triggerCommissionSettlementCreation operation in CommissionSettlementsApi.
774
+ * @export
775
+ * @interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest
776
+ */
777
+ export interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest {
778
+ /**
779
+ *
780
+ * @type {TriggerCommissionSettlementCreationRequestDto}
781
+ * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
782
+ */
783
+ readonly triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto
784
+
785
+ /**
786
+ * Bearer Token: provided by the login endpoint under the name accessToken.
787
+ * @type {string}
788
+ * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
789
+ */
790
+ readonly authorization?: string
791
+ }
792
+
698
793
  /**
699
794
  * Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
700
795
  * @export
@@ -790,6 +885,18 @@ export class CommissionSettlementsApi extends BaseAPI {
790
885
  return CommissionSettlementsApiFp(this.configuration).publishCommissionSettlements(requestParameters.publishCommissionSettlementsRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
791
886
  }
792
887
 
888
+ /**
889
+ * Triggers the commission settlement creation job.
890
+ * @summary Create the commission settlement creation job
891
+ * @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
892
+ * @param {*} [options] Override http request option.
893
+ * @throws {RequiredError}
894
+ * @memberof CommissionSettlementsApi
895
+ */
896
+ public triggerCommissionSettlementCreation(requestParameters: CommissionSettlementsApiTriggerCommissionSettlementCreationRequest, options?: AxiosRequestConfig) {
897
+ return CommissionSettlementsApiFp(this.configuration).triggerCommissionSettlementCreation(requestParameters.triggerCommissionSettlementCreationRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
898
+ }
899
+
793
900
  /**
794
901
  * This will update commission settlement.
795
902
  * @summary Update the commission settlement
@@ -243,15 +243,15 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
243
243
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
244
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
245
  * @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.
246
- * @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.
246
+ * @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.
247
247
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
248
- * @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.
248
+ * @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.
249
249
  * @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.
250
250
  * @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.
251
251
  * @param {*} [options] Override http request option.
252
252
  * @throws {RequiredError}
253
253
  */
254
- 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> => {
254
+ 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> => {
255
255
  const localVarPath = `/commissionservice/v1/commissions`;
256
256
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
257
257
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -429,15 +429,15 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
429
429
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
430
430
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
431
431
  * @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.
432
- * @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.
432
+ * @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.
433
433
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
434
- * @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.
434
+ * @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.
435
435
  * @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.
436
436
  * @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.
437
437
  * @param {*} [options] Override http request option.
438
438
  * @throws {RequiredError}
439
439
  */
440
- 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>> {
440
+ 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>> {
441
441
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
442
442
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
443
443
  },
@@ -515,15 +515,15 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
515
515
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
516
516
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
517
517
  * @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.
518
- * @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.
518
+ * @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.
519
519
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
520
- * @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.
520
+ * @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.
521
521
  * @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.
522
522
  * @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.
523
523
  * @param {*} [options] Override http request option.
524
524
  * @throws {RequiredError}
525
525
  */
526
- 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> {
526
+ 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> {
527
527
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
528
528
  },
529
529
  /**
@@ -661,10 +661,10 @@ export interface CommissionsApiListCommissionsRequest {
661
661
 
662
662
  /**
663
663
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
664
- * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'}
664
+ * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'}
665
665
  * @memberof CommissionsApiListCommissions
666
666
  */
667
- readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'
667
+ readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'
668
668
 
669
669
  /**
670
670
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
@@ -675,10 +675,10 @@ export interface CommissionsApiListCommissionsRequest {
675
675
 
676
676
  /**
677
677
  * 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.
678
- * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
678
+ * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
679
679
  * @memberof CommissionsApiListCommissions
680
680
  */
681
- readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
681
+ readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
682
682
 
683
683
  /**
684
684
  * 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.
@@ -55,11 +55,11 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
55
55
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
56
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
57
57
  * @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.
58
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
58
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
59
59
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
60
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
60
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
61
61
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
62
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
62
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
63
63
  * @param {*} [options] Override http request option.
64
64
  * @throws {RequiredError}
65
65
  */
@@ -104,11 +104,11 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
104
104
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
105
105
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
106
106
  * @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.
107
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
107
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
108
108
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
109
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
109
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
110
110
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
111
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
111
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
112
112
  * @param {*} [options] Override http request option.
113
113
  * @throws {RequiredError}
114
114
  */
@@ -153,11 +153,11 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
153
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
154
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
155
155
  * @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.
156
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
156
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
157
157
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
158
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
158
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
159
159
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
160
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
160
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
161
161
  * @param {*} [options] Override http request option.
162
162
  * @throws {RequiredError}
163
163
  */
@@ -251,7 +251,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
251
251
  */
252
252
  readonly pageToken?: string;
253
253
  /**
254
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
254
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
255
255
  * @type {string}
256
256
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
257
257
  */
@@ -263,7 +263,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
263
263
  */
264
264
  readonly search?: string;
265
265
  /**
266
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
266
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
267
267
  * @type {string}
268
268
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
269
269
  */
@@ -275,7 +275,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
275
275
  */
276
276
  readonly expand?: string;
277
277
  /**
278
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
278
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
279
279
  * @type {string}
280
280
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
281
281
  */
@@ -253,11 +253,11 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
253
253
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
254
254
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
255
255
  * @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.
256
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
256
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
257
257
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
258
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
258
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
259
259
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
260
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
260
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
261
261
  * @param {*} [options] Override http request option.
262
262
  * @throws {RequiredError}
263
263
  */
@@ -399,11 +399,11 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
399
399
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
400
400
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
401
401
  * @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.
402
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
402
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
403
403
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
404
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
404
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
405
405
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
406
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
406
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
407
407
  * @param {*} [options] Override http request option.
408
408
  * @throws {RequiredError}
409
409
  */
@@ -470,11 +470,11 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
470
470
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
471
471
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
472
472
  * @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.
473
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
473
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
474
474
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
475
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
475
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
476
476
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
477
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
477
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
478
478
  * @param {*} [options] Override http request option.
479
479
  * @throws {RequiredError}
480
480
  */
@@ -18,6 +18,8 @@ import { GetCommissionSettlementResponseClass } from '../models';
18
18
  import { ListCommissionSettlementsResponseClass } from '../models';
19
19
  import { PublishCommissionSettlementsRequestDto } from '../models';
20
20
  import { PublishCommissionSettlementsResponseClass } from '../models';
21
+ import { TriggerCommissionSettlementCreationRequestDto } from '../models';
22
+ import { TriggerCommissionSettlementCreationResponseClass } from '../models';
21
23
  import { UpdateCommissionSettlementRequestDto } from '../models';
22
24
  import { UpdateCommissionSettlementResponseClass } from '../models';
23
25
  /**
@@ -77,6 +79,15 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
77
79
  * @throws {RequiredError}
78
80
  */
79
81
  publishCommissionSettlements: (publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ * Triggers the commission settlement creation job.
84
+ * @summary Create the commission settlement creation job
85
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
86
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ triggerCommissionSettlementCreation: (triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
91
  /**
81
92
  * This will update commission settlement.
82
93
  * @summary Update the commission settlement
@@ -145,6 +156,15 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
145
156
  * @throws {RequiredError}
146
157
  */
147
158
  publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublishCommissionSettlementsResponseClass>>;
159
+ /**
160
+ * Triggers the commission settlement creation job.
161
+ * @summary Create the commission settlement creation job
162
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
163
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ */
167
+ triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerCommissionSettlementCreationResponseClass>>;
148
168
  /**
149
169
  * This will update commission settlement.
150
170
  * @summary Update the commission settlement
@@ -213,6 +233,15 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
213
233
  * @throws {RequiredError}
214
234
  */
215
235
  publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass>;
236
+ /**
237
+ * Triggers the commission settlement creation job.
238
+ * @summary Create the commission settlement creation job
239
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
240
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
241
+ * @param {*} [options] Override http request option.
242
+ * @throws {RequiredError}
243
+ */
244
+ triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerCommissionSettlementCreationResponseClass>;
216
245
  /**
217
246
  * This will update commission settlement.
218
247
  * @summary Update the commission settlement
@@ -361,6 +390,25 @@ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
361
390
  */
362
391
  readonly authorization?: string;
363
392
  }
393
+ /**
394
+ * Request parameters for triggerCommissionSettlementCreation operation in CommissionSettlementsApi.
395
+ * @export
396
+ * @interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest
397
+ */
398
+ export interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest {
399
+ /**
400
+ *
401
+ * @type {TriggerCommissionSettlementCreationRequestDto}
402
+ * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
403
+ */
404
+ readonly triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto;
405
+ /**
406
+ * Bearer Token: provided by the login endpoint under the name accessToken.
407
+ * @type {string}
408
+ * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
409
+ */
410
+ readonly authorization?: string;
411
+ }
364
412
  /**
365
413
  * Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
366
414
  * @export
@@ -438,6 +486,15 @@ export declare class CommissionSettlementsApi extends BaseAPI {
438
486
  * @memberof CommissionSettlementsApi
439
487
  */
440
488
  publishCommissionSettlements(requestParameters: CommissionSettlementsApiPublishCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublishCommissionSettlementsResponseClass, any, {}>>;
489
+ /**
490
+ * Triggers the commission settlement creation job.
491
+ * @summary Create the commission settlement creation job
492
+ * @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
493
+ * @param {*} [options] Override http request option.
494
+ * @throws {RequiredError}
495
+ * @memberof CommissionSettlementsApi
496
+ */
497
+ triggerCommissionSettlementCreation(requestParameters: CommissionSettlementsApiTriggerCommissionSettlementCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerCommissionSettlementCreationResponseClass, any, {}>>;
441
498
  /**
442
499
  * This will update commission settlement.
443
500
  * @summary Update the commission settlement