@emilgroup/commission-sdk 2.10.1-beta.3 → 2.10.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
@@ -141,6 +141,59 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
141
141
  });
142
142
  });
143
143
  },
144
+ /**
145
+ * Creates a manual clawback for one commission.
146
+ * @summary Create the commission clawback
147
+ * @param {string} code Unique identifier for the object.
148
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
149
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
154
+ if (options === void 0) { options = {}; }
155
+ return __awaiter(_this, void 0, void 0, function () {
156
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
157
+ return __generator(this, function (_a) {
158
+ switch (_a.label) {
159
+ case 0:
160
+ // verify required parameter 'code' is not null or undefined
161
+ (0, common_1.assertParamExists)('createCommissionClawback', 'code', code);
162
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
163
+ (0, common_1.assertParamExists)('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto);
164
+ localVarPath = "/commissionservice/v1/commissions/{code}/clawbacks"
165
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
166
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
167
+ if (configuration) {
168
+ baseOptions = configuration.baseOptions;
169
+ baseAccessToken = configuration.accessToken;
170
+ }
171
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
172
+ localVarHeaderParameter = {};
173
+ localVarQueryParameter = {};
174
+ // authentication bearer required
175
+ // http bearer authentication required
176
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
177
+ case 1:
178
+ // authentication bearer required
179
+ // http bearer authentication required
180
+ _a.sent();
181
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
182
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
183
+ }
184
+ localVarHeaderParameter['Content-Type'] = 'application/json';
185
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
186
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
187
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
188
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createCommissionClawbackRequestDto, localVarRequestOptions, configuration);
189
+ return [2 /*return*/, {
190
+ url: (0, common_1.toPathString)(localVarUrlObj),
191
+ options: localVarRequestOptions,
192
+ }];
193
+ }
194
+ });
195
+ });
196
+ },
144
197
  /**
145
198
  * This will delete commission.
146
199
  * @summary Delete the commission
@@ -298,9 +351,9 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
298
351
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
299
352
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
300
353
  * @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.
301
- * @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.
354
+ * @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.
302
355
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
303
- * @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.
356
+ * @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.
304
357
  * @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.
305
358
  * @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.
306
359
  * @param {*} [options] Override http request option.
@@ -364,6 +417,55 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
364
417
  });
365
418
  });
366
419
  },
420
+ /**
421
+ * 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.
422
+ * @summary Create the due commission clawbacks trigger
423
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
424
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
425
+ * @param {*} [options] Override http request option.
426
+ * @throws {RequiredError}
427
+ */
428
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
429
+ if (options === void 0) { options = {}; }
430
+ return __awaiter(_this, void 0, void 0, function () {
431
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
432
+ return __generator(this, function (_a) {
433
+ switch (_a.label) {
434
+ case 0:
435
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
436
+ (0, common_1.assertParamExists)('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto);
437
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/trigger-due";
438
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
439
+ if (configuration) {
440
+ baseOptions = configuration.baseOptions;
441
+ baseAccessToken = configuration.accessToken;
442
+ }
443
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
444
+ localVarHeaderParameter = {};
445
+ localVarQueryParameter = {};
446
+ // authentication bearer required
447
+ // http bearer authentication required
448
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
449
+ case 1:
450
+ // authentication bearer required
451
+ // http bearer authentication required
452
+ _a.sent();
453
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
454
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
455
+ }
456
+ localVarHeaderParameter['Content-Type'] = 'application/json';
457
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
458
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
459
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
460
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration);
461
+ return [2 /*return*/, {
462
+ url: (0, common_1.toPathString)(localVarUrlObj),
463
+ options: localVarRequestOptions,
464
+ }];
465
+ }
466
+ });
467
+ });
468
+ },
367
469
  /**
368
470
  * This will update commission.
369
471
  * @summary Update the commission
@@ -448,6 +550,28 @@ var CommissionsApiFp = function (configuration) {
448
550
  });
449
551
  });
450
552
  },
553
+ /**
554
+ * Creates a manual clawback for one commission.
555
+ * @summary Create the commission clawback
556
+ * @param {string} code Unique identifier for the object.
557
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
558
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
559
+ * @param {*} [options] Override http request option.
560
+ * @throws {RequiredError}
561
+ */
562
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
563
+ return __awaiter(this, void 0, void 0, function () {
564
+ var localVarAxiosArgs;
565
+ return __generator(this, function (_a) {
566
+ switch (_a.label) {
567
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options)];
568
+ case 1:
569
+ localVarAxiosArgs = _a.sent();
570
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
571
+ }
572
+ });
573
+ });
574
+ },
451
575
  /**
452
576
  * This will delete commission.
453
577
  * @summary Delete the commission
@@ -518,9 +642,9 @@ var CommissionsApiFp = function (configuration) {
518
642
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
519
643
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
520
644
  * @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.
521
- * @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.
645
+ * @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.
522
646
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
523
- * @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.
647
+ * @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.
524
648
  * @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.
525
649
  * @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.
526
650
  * @param {*} [options] Override http request option.
@@ -539,6 +663,27 @@ var CommissionsApiFp = function (configuration) {
539
663
  });
540
664
  });
541
665
  },
666
+ /**
667
+ * 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.
668
+ * @summary Create the due commission clawbacks trigger
669
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
670
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
671
+ * @param {*} [options] Override http request option.
672
+ * @throws {RequiredError}
673
+ */
674
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
675
+ return __awaiter(this, void 0, void 0, function () {
676
+ var localVarAxiosArgs;
677
+ return __generator(this, function (_a) {
678
+ switch (_a.label) {
679
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options)];
680
+ case 1:
681
+ localVarAxiosArgs = _a.sent();
682
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
683
+ }
684
+ });
685
+ });
686
+ },
542
687
  /**
543
688
  * This will update commission.
544
689
  * @summary Update the commission
@@ -582,6 +727,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
582
727
  createCommission: function (createCommissionRequestDto, authorization, options) {
583
728
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
584
729
  },
730
+ /**
731
+ * Creates a manual clawback for one commission.
732
+ * @summary Create the commission clawback
733
+ * @param {string} code Unique identifier for the object.
734
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
735
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
736
+ * @param {*} [options] Override http request option.
737
+ * @throws {RequiredError}
738
+ */
739
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
740
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
741
+ },
585
742
  /**
586
743
  * This will delete commission.
587
744
  * @summary Delete the commission
@@ -622,9 +779,9 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
622
779
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
623
780
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
624
781
  * @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.
625
- * @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.
782
+ * @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.
626
783
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
627
- * @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.
784
+ * @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.
628
785
  * @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.
629
786
  * @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.
630
787
  * @param {*} [options] Override http request option.
@@ -633,6 +790,17 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
633
790
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
634
791
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
635
792
  },
793
+ /**
794
+ * 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.
795
+ * @summary Create the due commission clawbacks trigger
796
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
797
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
798
+ * @param {*} [options] Override http request option.
799
+ * @throws {RequiredError}
800
+ */
801
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
802
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
803
+ },
636
804
  /**
637
805
  * This will update commission.
638
806
  * @summary Update the commission
@@ -671,6 +839,18 @@ var CommissionsApi = /** @class */ (function (_super) {
671
839
  var _this = this;
672
840
  return (0, exports.CommissionsApiFp)(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
673
841
  };
842
+ /**
843
+ * Creates a manual clawback for one commission.
844
+ * @summary Create the commission clawback
845
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
846
+ * @param {*} [options] Override http request option.
847
+ * @throws {RequiredError}
848
+ * @memberof CommissionsApi
849
+ */
850
+ CommissionsApi.prototype.createCommissionClawback = function (requestParameters, options) {
851
+ var _this = this;
852
+ return (0, exports.CommissionsApiFp)(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
853
+ };
674
854
  /**
675
855
  * This will delete commission.
676
856
  * @summary Delete the commission
@@ -720,6 +900,18 @@ var CommissionsApi = /** @class */ (function (_super) {
720
900
  if (requestParameters === void 0) { requestParameters = {}; }
721
901
  return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
722
902
  };
903
+ /**
904
+ * 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.
905
+ * @summary Create the due commission clawbacks trigger
906
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
907
+ * @param {*} [options] Override http request option.
908
+ * @throws {RequiredError}
909
+ * @memberof CommissionsApi
910
+ */
911
+ CommissionsApi.prototype.triggerDueCommissionClawbacks = function (requestParameters, options) {
912
+ var _this = this;
913
+ return (0, exports.CommissionsApiFp)(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
914
+ };
723
915
  /**
724
916
  * This will update commission.
725
917
  * @summary Update the commission
@@ -0,0 +1,36 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ClawbackConfigDto
16
+ */
17
+ export interface ClawbackConfigDto {
18
+ /**
19
+ * Allow manual commission clawback creation.
20
+ * @type {object}
21
+ * @memberof ClawbackConfigDto
22
+ */
23
+ 'manual': object;
24
+ /**
25
+ * Allow automatic commission clawback creation for policy termination and withdrawal.
26
+ * @type {object}
27
+ * @memberof ClawbackConfigDto
28
+ */
29
+ 'policyCancellation': object;
30
+ /**
31
+ * Allow automatic commission clawback creation for intermediary switches.
32
+ * @type {object}
33
+ * @memberof ClawbackConfigDto
34
+ */
35
+ 'intermediarySwitched': object;
36
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL CommissionService
6
+ * The EMIL CommissionService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { ClawbackConfigDto } from './clawback-config-dto';
12
13
  import { CommissionAgreementClass } from './commission-agreement-class';
13
14
  import { CommissionAgreementProductClass } from './commission-agreement-product-class';
14
15
  /**
@@ -53,6 +54,18 @@ export interface CommissionAgreementVersionClass {
53
54
  * @memberof CommissionAgreementVersionClass
54
55
  */
55
56
  'endDate'?: string;
57
+ /**
58
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
59
+ * @type {string}
60
+ * @memberof CommissionAgreementVersionClass
61
+ */
62
+ 'settlementCreationDate'?: string;
63
+ /**
64
+ * Version-scoped clawback creation configuration.
65
+ * @type {ClawbackConfigDto}
66
+ * @memberof CommissionAgreementVersionClass
67
+ */
68
+ 'clawbackConfig': ClawbackConfigDto;
56
69
  /**
57
70
  * Description explaining what changed in this version or version notes
58
71
  * @type {string}
@@ -63,6 +63,18 @@ export interface CommissionCandidateClass {
63
63
  * @memberof CommissionCandidateClass
64
64
  */
65
65
  'policyRenewalDate'?: string;
66
+ /**
67
+ * Exclusive end of the period the commission will be created for
68
+ * @type {string}
69
+ * @memberof CommissionCandidateClass
70
+ */
71
+ 'commissionPeriodTo'?: string;
72
+ /**
73
+ * Expected invoice entry count in the commission period, used as the pro rata denominator
74
+ * @type {number}
75
+ * @memberof CommissionCandidateClass
76
+ */
77
+ 'expectedInvoiceEntryCount'?: number;
66
78
  /**
67
79
  * Time at which the object was created.
68
80
  * @type {string}
@@ -95,12 +95,54 @@ export interface CommissionClass {
95
95
  * @memberof CommissionClass
96
96
  */
97
97
  'status': string;
98
+ /**
99
+ * The latest date when the commission became open.
100
+ * @type {string}
101
+ * @memberof CommissionClass
102
+ */
103
+ 'openedAt'?: string;
98
104
  /**
99
105
  * The code of the settlement this commission is associated with
100
106
  * @type {string}
101
107
  * @memberof CommissionClass
102
108
  */
103
109
  'settlementCode'?: string;
110
+ /**
111
+ * The source invoice code for invoice-driven commissions
112
+ * @type {string}
113
+ * @memberof CommissionClass
114
+ */
115
+ 'invoiceCode'?: string;
116
+ /**
117
+ * Start of the period the commission was originally created for
118
+ * @type {string}
119
+ * @memberof CommissionClass
120
+ */
121
+ 'commissionPeriodFrom'?: string;
122
+ /**
123
+ * Exclusive end of the period the commission was originally created for
124
+ * @type {string}
125
+ * @memberof CommissionClass
126
+ */
127
+ 'commissionPeriodTo'?: string;
128
+ /**
129
+ * Expected invoice entry count in the commission period, used as the pro rata denominator
130
+ * @type {number}
131
+ * @memberof CommissionClass
132
+ */
133
+ 'expectedInvoiceEntryCount'?: number;
134
+ /**
135
+ * For clawback commissions, the original commission being clawed back
136
+ * @type {string}
137
+ * @memberof CommissionClass
138
+ */
139
+ 'originalCommissionCode'?: string;
140
+ /**
141
+ * The trigger type that created this clawback commission
142
+ * @type {string}
143
+ * @memberof CommissionClass
144
+ */
145
+ 'clawbackTriggerType'?: CommissionClassClawbackTriggerTypeEnum;
104
146
  /**
105
147
  * Time at which the object was created.
106
148
  * @type {string}
@@ -132,3 +174,10 @@ export interface CommissionClass {
132
174
  */
133
175
  'items': Array<CommissionItemClass>;
134
176
  }
177
+ export declare const CommissionClassClawbackTriggerTypeEnum: {
178
+ readonly Manual: "manual";
179
+ readonly PolicyTermination: "policy_termination";
180
+ readonly PolicyWithdrawal: "policy_withdrawal";
181
+ readonly IntermediarySwitched: "intermediary_switched";
182
+ };
183
+ export type CommissionClassClawbackTriggerTypeEnum = typeof CommissionClassClawbackTriggerTypeEnum[keyof typeof CommissionClassClawbackTriggerTypeEnum];
@@ -13,3 +13,10 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CommissionClassClawbackTriggerTypeEnum = void 0;
17
+ exports.CommissionClassClawbackTriggerTypeEnum = {
18
+ Manual: 'manual',
19
+ PolicyTermination: 'policy_termination',
20
+ PolicyWithdrawal: 'policy_withdrawal',
21
+ IntermediarySwitched: 'intermediary_switched'
22
+ };
@@ -17,7 +17,7 @@ import { CommissionConditionsDto } from './commission-conditions-dto';
17
17
  */
18
18
  export interface CommissionConfigDto {
19
19
  /**
20
- * Type of commission (e.g., sales, maintenance, other)
20
+ * Type of commission (e.g., sales, maintenance, other, clawback)
21
21
  * @type {string}
22
22
  * @memberof CommissionConfigDto
23
23
  */
@@ -45,6 +45,7 @@ export declare const CommissionConfigDtoTypeEnum: {
45
45
  readonly Sales: "sales";
46
46
  readonly Maintenance: "maintenance";
47
47
  readonly Other: "other";
48
+ readonly Clawback: "clawback";
48
49
  };
49
50
  export type CommissionConfigDtoTypeEnum = typeof CommissionConfigDtoTypeEnum[keyof typeof CommissionConfigDtoTypeEnum];
50
51
  export declare const CommissionConfigDtoCurrencyEnum: {
@@ -17,7 +17,8 @@ exports.CommissionConfigDtoCurrencyEnum = exports.CommissionConfigDtoTypeEnum =
17
17
  exports.CommissionConfigDtoTypeEnum = {
18
18
  Sales: 'sales',
19
19
  Maintenance: 'maintenance',
20
- Other: 'other'
20
+ Other: 'other',
21
+ Clawback: 'clawback'
21
22
  };
22
23
  exports.CommissionConfigDtoCurrencyEnum = {
23
24
  Eur: 'EUR',
@@ -34,7 +34,7 @@ export interface CommissionEstimateClass {
34
34
  */
35
35
  'amount': number;
36
36
  /**
37
- * Type of commission. Valid values: sales, maintenance, other
37
+ * Type of commission. Valid values: sales, maintenance, other, clawback
38
38
  * @type {string}
39
39
  * @memberof CommissionEstimateClass
40
40
  */
@@ -50,6 +50,7 @@ export declare const CommissionEstimateClassTypeEnum: {
50
50
  readonly Sales: "sales";
51
51
  readonly Maintenance: "maintenance";
52
52
  readonly Other: "other";
53
+ readonly Clawback: "clawback";
53
54
  };
54
55
  export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];
55
56
  export declare const CommissionEstimateClassGroupEnum: {
@@ -17,7 +17,8 @@ exports.CommissionEstimateClassGroupEnum = exports.CommissionEstimateClassTypeEn
17
17
  exports.CommissionEstimateClassTypeEnum = {
18
18
  Sales: 'sales',
19
19
  Maintenance: 'maintenance',
20
- Other: 'other'
20
+ Other: 'other',
21
+ Clawback: 'clawback'
21
22
  };
22
23
  exports.CommissionEstimateClassGroupEnum = {
23
24
  FirstYear: 'firstYear',
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { ClawbackConfigDto } from './clawback-config-dto';
12
13
  import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
13
14
  /**
14
15
  *
@@ -64,6 +65,18 @@ export interface CreateCommissionAgreementRequestDto {
64
65
  * @memberof CreateCommissionAgreementRequestDto
65
66
  */
66
67
  'endDate'?: string;
68
+ /**
69
+ * Date when commission settlement creation should start for this agreement. Treated as a date-only schedule value.
70
+ * @type {string}
71
+ * @memberof CreateCommissionAgreementRequestDto
72
+ */
73
+ 'settlementCreationDate'?: string;
74
+ /**
75
+ * Initial version clawback creation configuration. Missing config defaults to all triggers disabled.
76
+ * @type {ClawbackConfigDto}
77
+ * @memberof CreateCommissionAgreementRequestDto
78
+ */
79
+ 'clawbackConfig'?: ClawbackConfigDto;
67
80
  }
68
81
  export declare const CreateCommissionAgreementRequestDtoBillingFrequencyEnum: {
69
82
  readonly Immediately: "immediately";
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { ClawbackConfigDto } from './clawback-config-dto';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -33,10 +34,22 @@ export interface CreateCommissionAgreementVersionRequestDto {
33
34
  * @memberof CreateCommissionAgreementVersionRequestDto
34
35
  */
35
36
  'endDate'?: string;
37
+ /**
38
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
39
+ * @type {string}
40
+ * @memberof CreateCommissionAgreementVersionRequestDto
41
+ */
42
+ 'settlementCreationDate'?: string;
36
43
  /**
37
44
  * Description explaining what changed in this version or version notes
38
45
  * @type {string}
39
46
  * @memberof CreateCommissionAgreementVersionRequestDto
40
47
  */
41
48
  'versionDescription'?: string;
49
+ /**
50
+ * Version-scoped clawback creation configuration. Missing config defaults to all triggers disabled.
51
+ * @type {ClawbackConfigDto}
52
+ * @memberof CreateCommissionAgreementVersionRequestDto
53
+ */
54
+ 'clawbackConfig'?: ClawbackConfigDto;
42
55
  }
@@ -34,7 +34,7 @@ export interface CreateCommissionCandidateRequestDto {
34
34
  */
35
35
  'candidateType': CreateCommissionCandidateRequestDtoCandidateTypeEnum;
36
36
  /**
37
- * The type of commission. Valid values: sales, maintenance, other
37
+ * The type of commission. Valid values: sales, maintenance, other, clawback
38
38
  * @type {string}
39
39
  * @memberof CreateCommissionCandidateRequestDto
40
40
  */
@@ -61,5 +61,6 @@ export declare const CreateCommissionCandidateRequestDtoCommissionTypeEnum: {
61
61
  readonly Sales: "sales";
62
62
  readonly Maintenance: "maintenance";
63
63
  readonly Other: "other";
64
+ readonly Clawback: "clawback";
64
65
  };
65
66
  export type CreateCommissionCandidateRequestDtoCommissionTypeEnum = typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum];
@@ -21,5 +21,6 @@ exports.CreateCommissionCandidateRequestDtoCandidateTypeEnum = {
21
21
  exports.CreateCommissionCandidateRequestDtoCommissionTypeEnum = {
22
22
  Sales: 'sales',
23
23
  Maintenance: 'maintenance',
24
- Other: 'other'
24
+ Other: 'other',
25
+ Clawback: 'clawback'
25
26
  };
@@ -0,0 +1,24 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CreateCommissionClawbackRequestDto
16
+ */
17
+ export interface CreateCommissionClawbackRequestDto {
18
+ /**
19
+ * Optional business effective date for the clawback calculation. If omitted, server processing time is used.
20
+ * @type {string}
21
+ * @memberof CreateCommissionClawbackRequestDto
22
+ */
23
+ 'effectiveDate'?: string;
24
+ }