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

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 (58) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/commissions-api.ts +227 -0
  4. package/dist/api/commissions-api.d.ts +123 -0
  5. package/dist/api/commissions-api.js +192 -0
  6. package/dist/models/clawback-config-class.d.ts +36 -0
  7. package/dist/models/clawback-config-class.js +15 -0
  8. package/dist/models/clawback-config-dto.d.ts +36 -0
  9. package/dist/models/clawback-config-dto.js +15 -0
  10. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  11. package/dist/models/commission-candidate-class.d.ts +12 -0
  12. package/dist/models/commission-class.d.ts +43 -0
  13. package/dist/models/commission-class.js +7 -0
  14. package/dist/models/commission-config-dto.d.ts +2 -1
  15. package/dist/models/commission-config-dto.js +2 -1
  16. package/dist/models/commission-estimate-class.d.ts +2 -1
  17. package/dist/models/commission-estimate-class.js +2 -1
  18. package/dist/models/create-commission-agreement-request-dto.d.ts +7 -0
  19. package/dist/models/create-commission-agreement-version-request-dto.d.ts +7 -0
  20. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  21. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  22. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  23. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  24. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  25. package/dist/models/create-commission-clawback-response-class.js +21 -0
  26. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  27. package/dist/models/create-commission-item-request-dto.js +2 -1
  28. package/dist/models/create-commission-request-dto.d.ts +6 -0
  29. package/dist/models/evaluated-commission-class.d.ts +2 -1
  30. package/dist/models/evaluated-commission-class.js +2 -1
  31. package/dist/models/index.d.ts +6 -0
  32. package/dist/models/index.js +6 -0
  33. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  34. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  35. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  36. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  37. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  38. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  39. package/models/clawback-config-class.ts +42 -0
  40. package/models/clawback-config-dto.ts +42 -0
  41. package/models/commission-agreement-version-class.ts +7 -0
  42. package/models/commission-candidate-class.ts +12 -0
  43. package/models/commission-class.ts +46 -0
  44. package/models/commission-config-dto.ts +3 -2
  45. package/models/commission-estimate-class.ts +3 -2
  46. package/models/create-commission-agreement-request-dto.ts +7 -0
  47. package/models/create-commission-agreement-version-request-dto.ts +7 -0
  48. package/models/create-commission-candidate-request-dto.ts +16 -3
  49. package/models/create-commission-clawback-request-dto.ts +30 -0
  50. package/models/create-commission-clawback-response-class.ts +52 -0
  51. package/models/create-commission-item-request-dto.ts +3 -2
  52. package/models/create-commission-request-dto.ts +6 -0
  53. package/models/evaluated-commission-class.ts +3 -2
  54. package/models/index.ts +6 -0
  55. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  56. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  57. package/models/update-commission-candidate-request-dto.ts +3 -2
  58. package/package.json +1 -1
@@ -145,6 +145,59 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
145
145
  });
146
146
  });
147
147
  },
148
+ /**
149
+ * Creates a manual clawback for one commission.
150
+ * @summary Create the commission clawback
151
+ * @param {string} code Unique identifier for the object.
152
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
153
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
158
+ if (options === void 0) { options = {}; }
159
+ return __awaiter(_this, void 0, void 0, function () {
160
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
161
+ return __generator(this, function (_a) {
162
+ switch (_a.label) {
163
+ case 0:
164
+ // verify required parameter 'code' is not null or undefined
165
+ (0, common_1.assertParamExists)('createCommissionClawback', 'code', code);
166
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
167
+ (0, common_1.assertParamExists)('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto);
168
+ localVarPath = "/commissionservice/v1/commissions/{code}/clawbacks"
169
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
170
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
171
+ if (configuration) {
172
+ baseOptions = configuration.baseOptions;
173
+ baseAccessToken = configuration.accessToken;
174
+ }
175
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
176
+ localVarHeaderParameter = {};
177
+ localVarQueryParameter = {};
178
+ // authentication bearer required
179
+ // http bearer authentication required
180
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
181
+ case 1:
182
+ // authentication bearer required
183
+ // http bearer authentication required
184
+ _a.sent();
185
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
186
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
187
+ }
188
+ localVarHeaderParameter['Content-Type'] = 'application/json';
189
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
190
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
191
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
192
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createCommissionClawbackRequestDto, localVarRequestOptions, configuration);
193
+ return [2 /*return*/, {
194
+ url: (0, common_1.toPathString)(localVarUrlObj),
195
+ options: localVarRequestOptions,
196
+ }];
197
+ }
198
+ });
199
+ });
200
+ },
148
201
  /**
149
202
  * This will delete commission.
150
203
  * @summary Delete the commission
@@ -368,6 +421,55 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
368
421
  });
369
422
  });
370
423
  },
424
+ /**
425
+ * 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.
426
+ * @summary Create the due commission clawbacks trigger
427
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
428
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ */
432
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
433
+ if (options === void 0) { options = {}; }
434
+ return __awaiter(_this, void 0, void 0, function () {
435
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
436
+ return __generator(this, function (_a) {
437
+ switch (_a.label) {
438
+ case 0:
439
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
440
+ (0, common_1.assertParamExists)('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto);
441
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/trigger-due";
442
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
443
+ if (configuration) {
444
+ baseOptions = configuration.baseOptions;
445
+ baseAccessToken = configuration.accessToken;
446
+ }
447
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
448
+ localVarHeaderParameter = {};
449
+ localVarQueryParameter = {};
450
+ // authentication bearer required
451
+ // http bearer authentication required
452
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
453
+ case 1:
454
+ // authentication bearer required
455
+ // http bearer authentication required
456
+ _a.sent();
457
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
458
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
459
+ }
460
+ localVarHeaderParameter['Content-Type'] = 'application/json';
461
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
462
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
463
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
464
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration);
465
+ return [2 /*return*/, {
466
+ url: (0, common_1.toPathString)(localVarUrlObj),
467
+ options: localVarRequestOptions,
468
+ }];
469
+ }
470
+ });
471
+ });
472
+ },
371
473
  /**
372
474
  * This will update commission.
373
475
  * @summary Update the commission
@@ -452,6 +554,28 @@ var CommissionsApiFp = function (configuration) {
452
554
  });
453
555
  });
454
556
  },
557
+ /**
558
+ * Creates a manual clawback for one commission.
559
+ * @summary Create the commission clawback
560
+ * @param {string} code Unique identifier for the object.
561
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
562
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
563
+ * @param {*} [options] Override http request option.
564
+ * @throws {RequiredError}
565
+ */
566
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
567
+ return __awaiter(this, void 0, void 0, function () {
568
+ var localVarAxiosArgs;
569
+ return __generator(this, function (_a) {
570
+ switch (_a.label) {
571
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options)];
572
+ case 1:
573
+ localVarAxiosArgs = _a.sent();
574
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
575
+ }
576
+ });
577
+ });
578
+ },
455
579
  /**
456
580
  * This will delete commission.
457
581
  * @summary Delete the commission
@@ -543,6 +667,27 @@ var CommissionsApiFp = function (configuration) {
543
667
  });
544
668
  });
545
669
  },
670
+ /**
671
+ * 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.
672
+ * @summary Create the due commission clawbacks trigger
673
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
674
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
675
+ * @param {*} [options] Override http request option.
676
+ * @throws {RequiredError}
677
+ */
678
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
679
+ return __awaiter(this, void 0, void 0, function () {
680
+ var localVarAxiosArgs;
681
+ return __generator(this, function (_a) {
682
+ switch (_a.label) {
683
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options)];
684
+ case 1:
685
+ localVarAxiosArgs = _a.sent();
686
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
687
+ }
688
+ });
689
+ });
690
+ },
546
691
  /**
547
692
  * This will update commission.
548
693
  * @summary Update the commission
@@ -586,6 +731,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
586
731
  createCommission: function (createCommissionRequestDto, authorization, options) {
587
732
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
588
733
  },
734
+ /**
735
+ * Creates a manual clawback for one commission.
736
+ * @summary Create the commission clawback
737
+ * @param {string} code Unique identifier for the object.
738
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
739
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
740
+ * @param {*} [options] Override http request option.
741
+ * @throws {RequiredError}
742
+ */
743
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
744
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
745
+ },
589
746
  /**
590
747
  * This will delete commission.
591
748
  * @summary Delete the commission
@@ -637,6 +794,17 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
637
794
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
638
795
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
639
796
  },
797
+ /**
798
+ * 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.
799
+ * @summary Create the due commission clawbacks trigger
800
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
801
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
802
+ * @param {*} [options] Override http request option.
803
+ * @throws {RequiredError}
804
+ */
805
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
806
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
807
+ },
640
808
  /**
641
809
  * This will update commission.
642
810
  * @summary Update the commission
@@ -675,6 +843,18 @@ var CommissionsApi = /** @class */ (function (_super) {
675
843
  var _this = this;
676
844
  return (0, exports.CommissionsApiFp)(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
677
845
  };
846
+ /**
847
+ * Creates a manual clawback for one commission.
848
+ * @summary Create the commission clawback
849
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
850
+ * @param {*} [options] Override http request option.
851
+ * @throws {RequiredError}
852
+ * @memberof CommissionsApi
853
+ */
854
+ CommissionsApi.prototype.createCommissionClawback = function (requestParameters, options) {
855
+ var _this = this;
856
+ return (0, exports.CommissionsApiFp)(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
857
+ };
678
858
  /**
679
859
  * This will delete commission.
680
860
  * @summary Delete the commission
@@ -724,6 +904,18 @@ var CommissionsApi = /** @class */ (function (_super) {
724
904
  if (requestParameters === void 0) { requestParameters = {}; }
725
905
  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); });
726
906
  };
907
+ /**
908
+ * 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.
909
+ * @summary Create the due commission clawbacks trigger
910
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
911
+ * @param {*} [options] Override http request option.
912
+ * @throws {RequiredError}
913
+ * @memberof CommissionsApi
914
+ */
915
+ CommissionsApi.prototype.triggerDueCommissionClawbacks = function (requestParameters, options) {
916
+ var _this = this;
917
+ return (0, exports.CommissionsApiFp)(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
918
+ };
727
919
  /**
728
920
  * This will update commission.
729
921
  * @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 ClawbackConfigClass
16
+ */
17
+ export interface ClawbackConfigClass {
18
+ /**
19
+ * Allow manual commission clawback creation.
20
+ * @type {boolean}
21
+ * @memberof ClawbackConfigClass
22
+ */
23
+ 'manual': boolean;
24
+ /**
25
+ * Allow automatic commission clawback creation for policy termination and withdrawal.
26
+ * @type {boolean}
27
+ * @memberof ClawbackConfigClass
28
+ */
29
+ 'policyCancellation': boolean;
30
+ /**
31
+ * Allow automatic commission clawback creation for intermediary switches.
32
+ * @type {boolean}
33
+ * @memberof ClawbackConfigClass
34
+ */
35
+ 'intermediarySwitched': boolean;
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 });
@@ -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 {boolean}
21
+ * @memberof ClawbackConfigDto
22
+ */
23
+ 'manual': boolean;
24
+ /**
25
+ * Allow automatic commission clawback creation for policy termination and withdrawal.
26
+ * @type {boolean}
27
+ * @memberof ClawbackConfigDto
28
+ */
29
+ 'policyCancellation': boolean;
30
+ /**
31
+ * Allow automatic commission clawback creation for intermediary switches.
32
+ * @type {boolean}
33
+ * @memberof ClawbackConfigDto
34
+ */
35
+ 'intermediarySwitched': boolean;
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 { ClawbackConfigClass } from './clawback-config-class';
12
13
  import { CommissionAgreementClass } from './commission-agreement-class';
13
14
  import { CommissionAgreementProductClass } from './commission-agreement-product-class';
14
15
  /**
@@ -59,6 +60,12 @@ export interface CommissionAgreementVersionClass {
59
60
  * @memberof CommissionAgreementVersionClass
60
61
  */
61
62
  'settlementCreationDate'?: string;
63
+ /**
64
+ * Version-scoped clawback creation configuration.
65
+ * @type {ClawbackConfigClass}
66
+ * @memberof CommissionAgreementVersionClass
67
+ */
68
+ 'clawbackConfig': ClawbackConfigClass;
62
69
  /**
63
70
  * Description explaining what changed in this version or version notes
64
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}
@@ -107,6 +107,42 @@ export interface CommissionClass {
107
107
  * @memberof CommissionClass
108
108
  */
109
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;
110
146
  /**
111
147
  * Time at which the object was created.
112
148
  * @type {string}
@@ -138,3 +174,10 @@ export interface CommissionClass {
138
174
  */
139
175
  'items': Array<CommissionItemClass>;
140
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
  *
@@ -70,6 +71,12 @@ export interface CreateCommissionAgreementRequestDto {
70
71
  * @memberof CreateCommissionAgreementRequestDto
71
72
  */
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;
73
80
  }
74
81
  export declare const CreateCommissionAgreementRequestDtoBillingFrequencyEnum: {
75
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
@@ -45,4 +46,10 @@ export interface CreateCommissionAgreementVersionRequestDto {
45
46
  * @memberof CreateCommissionAgreementVersionRequestDto
46
47
  */
47
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;
48
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
  */
@@ -46,11 +46,23 @@ export interface CreateCommissionCandidateRequestDto {
46
46
  */
47
47
  'commissionCode'?: string;
48
48
  /**
49
- * The date of the next policy renewal for this commission candidate
49
+ * The date of the next policy renewal for this commission candidate. Required when renewal clawback metadata is provided.
50
50
  * @type {string}
51
51
  * @memberof CreateCommissionCandidateRequestDto
52
52
  */
53
53
  'policyRenewalDate'?: string;
54
+ /**
55
+ * Exclusive end of the commission period. If provided, policyRenewalDate and expectedInvoiceEntryCount must also be provided.
56
+ * @type {string}
57
+ * @memberof CreateCommissionCandidateRequestDto
58
+ */
59
+ 'commissionPeriodTo'?: string;
60
+ /**
61
+ * Expected invoice entry count in the commission period. If provided, policyRenewalDate and commissionPeriodTo must also be provided.
62
+ * @type {number}
63
+ * @memberof CreateCommissionCandidateRequestDto
64
+ */
65
+ 'expectedInvoiceEntryCount'?: number;
54
66
  }
55
67
  export declare const CreateCommissionCandidateRequestDtoCandidateTypeEnum: {
56
68
  readonly Initial: "initial";
@@ -61,5 +73,6 @@ export declare const CreateCommissionCandidateRequestDtoCommissionTypeEnum: {
61
73
  readonly Sales: "sales";
62
74
  readonly Maintenance: "maintenance";
63
75
  readonly Other: "other";
76
+ readonly Clawback: "clawback";
64
77
  };
65
78
  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
+ }
@@ -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 });