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

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 (65) hide show
  1. package/.openapi-generator/FILES +7 -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 +240 -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 +136 -13
  11. package/dist/api/commissions-api.js +198 -6
  12. package/dist/models/clawback-config-dto.d.ts +36 -0
  13. package/dist/models/clawback-config-dto.js +15 -0
  14. package/dist/models/commission-agreement-version-class.d.ts +13 -0
  15. package/dist/models/commission-candidate-class.d.ts +12 -0
  16. package/dist/models/commission-class.d.ts +49 -0
  17. package/dist/models/commission-class.js +7 -0
  18. package/dist/models/commission-config-dto.d.ts +2 -1
  19. package/dist/models/commission-config-dto.js +2 -1
  20. package/dist/models/commission-estimate-class.d.ts +2 -1
  21. package/dist/models/commission-estimate-class.js +2 -1
  22. package/dist/models/create-commission-agreement-request-dto.d.ts +13 -0
  23. package/dist/models/create-commission-agreement-version-request-dto.d.ts +13 -0
  24. package/dist/models/create-commission-candidate-request-dto.d.ts +2 -1
  25. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  26. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  27. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  28. package/dist/models/create-commission-clawback-response-class.d.ts +45 -0
  29. package/dist/models/create-commission-clawback-response-class.js +23 -0
  30. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  31. package/dist/models/create-commission-item-request-dto.js +2 -1
  32. package/dist/models/evaluated-commission-class.d.ts +2 -1
  33. package/dist/models/evaluated-commission-class.js +2 -1
  34. package/dist/models/index.d.ts +7 -0
  35. package/dist/models/index.js +7 -0
  36. package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
  37. package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
  38. package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
  39. package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
  40. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  41. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  42. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  43. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  44. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  45. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  46. package/models/clawback-config-dto.ts +42 -0
  47. package/models/commission-agreement-version-class.ts +13 -0
  48. package/models/commission-candidate-class.ts +12 -0
  49. package/models/commission-class.ts +52 -0
  50. package/models/commission-config-dto.ts +3 -2
  51. package/models/commission-estimate-class.ts +3 -2
  52. package/models/create-commission-agreement-request-dto.ts +13 -0
  53. package/models/create-commission-agreement-version-request-dto.ts +13 -0
  54. package/models/create-commission-candidate-request-dto.ts +3 -2
  55. package/models/create-commission-clawback-request-dto.ts +30 -0
  56. package/models/create-commission-clawback-response-class.ts +54 -0
  57. package/models/create-commission-item-request-dto.ts +3 -2
  58. package/models/evaluated-commission-class.ts +3 -2
  59. package/models/index.ts +7 -0
  60. package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
  61. package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
  62. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  63. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  64. package/models/update-commission-candidate-request-dto.ts +3 -2
  65. package/package.json +1 -1
@@ -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
@@ -368,6 +368,55 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
368
368
  });
369
369
  });
370
370
  },
371
+ /**
372
+ * Triggers the commission settlement creation job.
373
+ * @summary Create the commission settlement creation job
374
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
375
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
376
+ * @param {*} [options] Override http request option.
377
+ * @throws {RequiredError}
378
+ */
379
+ triggerCommissionSettlementCreation: function (triggerCommissionSettlementCreationRequestDto, authorization, options) {
380
+ if (options === void 0) { options = {}; }
381
+ return __awaiter(_this, void 0, void 0, function () {
382
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
383
+ return __generator(this, function (_a) {
384
+ switch (_a.label) {
385
+ case 0:
386
+ // verify required parameter 'triggerCommissionSettlementCreationRequestDto' is not null or undefined
387
+ (0, common_1.assertParamExists)('triggerCommissionSettlementCreation', 'triggerCommissionSettlementCreationRequestDto', triggerCommissionSettlementCreationRequestDto);
388
+ localVarPath = "/commissionservice/v1/commission-settlements/commission-settlement-creation/trigger";
389
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
390
+ if (configuration) {
391
+ baseOptions = configuration.baseOptions;
392
+ baseAccessToken = configuration.accessToken;
393
+ }
394
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
395
+ localVarHeaderParameter = {};
396
+ localVarQueryParameter = {};
397
+ // authentication bearer required
398
+ // http bearer authentication required
399
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
400
+ case 1:
401
+ // authentication bearer required
402
+ // http bearer authentication required
403
+ _a.sent();
404
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
405
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
406
+ }
407
+ localVarHeaderParameter['Content-Type'] = 'application/json';
408
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
409
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
410
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
411
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerCommissionSettlementCreationRequestDto, localVarRequestOptions, configuration);
412
+ return [2 /*return*/, {
413
+ url: (0, common_1.toPathString)(localVarUrlObj),
414
+ options: localVarRequestOptions,
415
+ }];
416
+ }
417
+ });
418
+ });
419
+ },
371
420
  /**
372
421
  * This will update commission settlement.
373
422
  * @summary Update the commission settlement
@@ -543,6 +592,27 @@ var CommissionSettlementsApiFp = function (configuration) {
543
592
  });
544
593
  });
545
594
  },
595
+ /**
596
+ * Triggers the commission settlement creation job.
597
+ * @summary Create the commission settlement creation job
598
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
599
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
600
+ * @param {*} [options] Override http request option.
601
+ * @throws {RequiredError}
602
+ */
603
+ triggerCommissionSettlementCreation: function (triggerCommissionSettlementCreationRequestDto, authorization, options) {
604
+ return __awaiter(this, void 0, void 0, function () {
605
+ var localVarAxiosArgs;
606
+ return __generator(this, function (_a) {
607
+ switch (_a.label) {
608
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options)];
609
+ case 1:
610
+ localVarAxiosArgs = _a.sent();
611
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
612
+ }
613
+ });
614
+ });
615
+ },
546
616
  /**
547
617
  * This will update commission settlement.
548
618
  * @summary Update the commission settlement
@@ -637,6 +707,17 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
637
707
  publishCommissionSettlements: function (publishCommissionSettlementsRequestDto, authorization, options) {
638
708
  return localVarFp.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
639
709
  },
710
+ /**
711
+ * Triggers the commission settlement creation job.
712
+ * @summary Create the commission settlement creation job
713
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
714
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
715
+ * @param {*} [options] Override http request option.
716
+ * @throws {RequiredError}
717
+ */
718
+ triggerCommissionSettlementCreation: function (triggerCommissionSettlementCreationRequestDto, authorization, options) {
719
+ return localVarFp.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
720
+ },
640
721
  /**
641
722
  * This will update commission settlement.
642
723
  * @summary Update the commission settlement
@@ -724,6 +805,18 @@ var CommissionSettlementsApi = /** @class */ (function (_super) {
724
805
  var _this = this;
725
806
  return (0, exports.CommissionSettlementsApiFp)(this.configuration).publishCommissionSettlements(requestParameters.publishCommissionSettlementsRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
726
807
  };
808
+ /**
809
+ * Triggers the commission settlement creation job.
810
+ * @summary Create the commission settlement creation job
811
+ * @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
812
+ * @param {*} [options] Override http request option.
813
+ * @throws {RequiredError}
814
+ * @memberof CommissionSettlementsApi
815
+ */
816
+ CommissionSettlementsApi.prototype.triggerCommissionSettlementCreation = function (requestParameters, options) {
817
+ var _this = this;
818
+ return (0, exports.CommissionSettlementsApiFp)(this.configuration).triggerCommissionSettlementCreation(requestParameters.triggerCommissionSettlementCreationRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
819
+ };
727
820
  /**
728
821
  * This will update commission settlement.
729
822
  * @summary Update the commission settlement
@@ -12,12 +12,16 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateCommissionClawbackRequestDto } from '../models';
16
+ import { CreateCommissionClawbackResponseClass } from '../models';
15
17
  import { CreateCommissionRequestDto } from '../models';
16
18
  import { CreateCommissionResponseClass } from '../models';
17
19
  import { EstimateCommissionsRequestDto } from '../models';
18
20
  import { EstimateCommissionsResponseClass } from '../models';
19
21
  import { GetCommissionResponseClass } from '../models';
20
22
  import { ListCommissionsResponseClass } from '../models';
23
+ import { TriggerDueCommissionClawbacksRequestDto } from '../models';
24
+ import { TriggerDueCommissionClawbacksResponseClass } from '../models';
21
25
  import { UpdateCommissionRequestDto } from '../models';
22
26
  import { UpdateCommissionResponseClass } from '../models';
23
27
  /**
@@ -34,6 +38,16 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
34
38
  * @throws {RequiredError}
35
39
  */
36
40
  createCommission: (createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
+ /**
42
+ * Creates a manual clawback for one commission.
43
+ * @summary Create the commission clawback
44
+ * @param {string} code Unique identifier for the object.
45
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
46
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ createCommissionClawback: (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
51
  /**
38
52
  * This will delete commission.
39
53
  * @summary Delete the commission
@@ -68,15 +82,24 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
68
82
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
69
83
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
84
  * @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.
71
- * @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.
85
+ * @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.
72
86
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
73
- * @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.
87
+ * @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.
74
88
  * @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.
75
89
  * @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.
76
90
  * @param {*} [options] Override http request option.
77
91
  * @throws {RequiredError}
78
92
  */
79
- 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<RequestArgs>;
93
+ 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<RequestArgs>;
94
+ /**
95
+ * 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.
96
+ * @summary Create the due commission clawbacks trigger
97
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ triggerDueCommissionClawbacks: (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
103
  /**
81
104
  * This will update commission.
82
105
  * @summary Update the commission
@@ -102,6 +125,16 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
102
125
  * @throws {RequiredError}
103
126
  */
104
127
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionResponseClass>>;
128
+ /**
129
+ * Creates a manual clawback for one commission.
130
+ * @summary Create the commission clawback
131
+ * @param {string} code Unique identifier for the object.
132
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
133
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
134
+ * @param {*} [options] Override http request option.
135
+ * @throws {RequiredError}
136
+ */
137
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>>;
105
138
  /**
106
139
  * This will delete commission.
107
140
  * @summary Delete the commission
@@ -136,15 +169,24 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
136
169
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
170
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
138
171
  * @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.
139
- * @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.
172
+ * @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.
140
173
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
141
- * @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.
174
+ * @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.
142
175
  * @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.
143
176
  * @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.
144
177
  * @param {*} [options] Override http request option.
145
178
  * @throws {RequiredError}
146
179
  */
147
- 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>>;
180
+ 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>>;
181
+ /**
182
+ * 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.
183
+ * @summary Create the due commission clawbacks trigger
184
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
185
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ */
189
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>>;
148
190
  /**
149
191
  * This will update commission.
150
192
  * @summary Update the commission
@@ -170,6 +212,16 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
170
212
  * @throws {RequiredError}
171
213
  */
172
214
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass>;
215
+ /**
216
+ * Creates a manual clawback for one commission.
217
+ * @summary Create the commission clawback
218
+ * @param {string} code Unique identifier for the object.
219
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
220
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
221
+ * @param {*} [options] Override http request option.
222
+ * @throws {RequiredError}
223
+ */
224
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass>;
173
225
  /**
174
226
  * This will delete commission.
175
227
  * @summary Delete the commission
@@ -204,15 +256,24 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
204
256
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
205
257
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
206
258
  * @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.
207
- * @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.
259
+ * @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.
208
260
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
209
- * @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.
261
+ * @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.
210
262
  * @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.
211
263
  * @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.
212
264
  * @param {*} [options] Override http request option.
213
265
  * @throws {RequiredError}
214
266
  */
215
- 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>;
267
+ 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>;
268
+ /**
269
+ * 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.
270
+ * @summary Create the due commission clawbacks trigger
271
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
272
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
273
+ * @param {*} [options] Override http request option.
274
+ * @throws {RequiredError}
275
+ */
276
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass>;
216
277
  /**
217
278
  * This will update commission.
218
279
  * @summary Update the commission
@@ -243,6 +304,31 @@ export interface CommissionsApiCreateCommissionRequest {
243
304
  */
244
305
  readonly authorization?: string;
245
306
  }
307
+ /**
308
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
309
+ * @export
310
+ * @interface CommissionsApiCreateCommissionClawbackRequest
311
+ */
312
+ export interface CommissionsApiCreateCommissionClawbackRequest {
313
+ /**
314
+ * Unique identifier for the object.
315
+ * @type {string}
316
+ * @memberof CommissionsApiCreateCommissionClawback
317
+ */
318
+ readonly code: string;
319
+ /**
320
+ *
321
+ * @type {CreateCommissionClawbackRequestDto}
322
+ * @memberof CommissionsApiCreateCommissionClawback
323
+ */
324
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto;
325
+ /**
326
+ * Bearer Token: provided by the login endpoint under the name accessToken.
327
+ * @type {string}
328
+ * @memberof CommissionsApiCreateCommissionClawback
329
+ */
330
+ readonly authorization?: string;
331
+ }
246
332
  /**
247
333
  * Request parameters for deleteCommission operation in CommissionsApi.
248
334
  * @export
@@ -332,10 +418,10 @@ export interface CommissionsApiListCommissionsRequest {
332
418
  readonly pageToken?: string;
333
419
  /**
334
420
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
335
- * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'}
421
+ * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'}
336
422
  * @memberof CommissionsApiListCommissions
337
423
  */
338
- readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode';
424
+ readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode';
339
425
  /**
340
426
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
341
427
  * @type {string}
@@ -344,10 +430,10 @@ export interface CommissionsApiListCommissionsRequest {
344
430
  readonly search?: string;
345
431
  /**
346
432
  * 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.
347
- * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
433
+ * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
348
434
  * @memberof CommissionsApiListCommissions
349
435
  */
350
- readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
436
+ readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
351
437
  /**
352
438
  * 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.
353
439
  * @type {'items' | 'agreement'}
@@ -361,6 +447,25 @@ export interface CommissionsApiListCommissionsRequest {
361
447
  */
362
448
  readonly filters?: string;
363
449
  }
450
+ /**
451
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
452
+ * @export
453
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
454
+ */
455
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
456
+ /**
457
+ *
458
+ * @type {TriggerDueCommissionClawbacksRequestDto}
459
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
460
+ */
461
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto;
462
+ /**
463
+ * Bearer Token: provided by the login endpoint under the name accessToken.
464
+ * @type {string}
465
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
466
+ */
467
+ readonly authorization?: string;
468
+ }
364
469
  /**
365
470
  * Request parameters for updateCommission operation in CommissionsApi.
366
471
  * @export
@@ -402,6 +507,15 @@ export declare class CommissionsApi extends BaseAPI {
402
507
  * @memberof CommissionsApi
403
508
  */
404
509
  createCommission(requestParameters: CommissionsApiCreateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionResponseClass, any, {}>>;
510
+ /**
511
+ * Creates a manual clawback for one commission.
512
+ * @summary Create the commission clawback
513
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
514
+ * @param {*} [options] Override http request option.
515
+ * @throws {RequiredError}
516
+ * @memberof CommissionsApi
517
+ */
518
+ createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionClawbackResponseClass, any, {}>>;
405
519
  /**
406
520
  * This will delete commission.
407
521
  * @summary Delete the commission
@@ -438,6 +552,15 @@ export declare class CommissionsApi extends BaseAPI {
438
552
  * @memberof CommissionsApi
439
553
  */
440
554
  listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
555
+ /**
556
+ * 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.
557
+ * @summary Create the due commission clawbacks trigger
558
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
559
+ * @param {*} [options] Override http request option.
560
+ * @throws {RequiredError}
561
+ * @memberof CommissionsApi
562
+ */
563
+ triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerDueCommissionClawbacksResponseClass, any, {}>>;
441
564
  /**
442
565
  * This will update commission.
443
566
  * @summary Update the commission