@emilgroup/commission-sdk-node 2.9.1-beta.2 → 2.9.1-beta.20

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 (88) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/commissions-api.ts +415 -0
  4. package/dist/api/commissions-api.d.ts +233 -0
  5. package/dist/api/commissions-api.js +321 -0
  6. package/dist/models/clawback-config-class.d.ts +42 -0
  7. package/dist/models/clawback-config-class.js +15 -0
  8. package/dist/models/clawback-config-dto.d.ts +42 -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-agreement-version-config-class.d.ts +32 -0
  12. package/dist/models/commission-agreement-version-config-class.js +15 -0
  13. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  14. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  15. package/dist/models/commission-candidate-class.d.ts +12 -0
  16. package/dist/models/commission-class.d.ts +38 -0
  17. package/dist/models/commission-class.js +8 -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-creation-config-class.d.ts +43 -0
  21. package/dist/models/commission-creation-config-class.js +20 -0
  22. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  23. package/dist/models/commission-creation-config-dto.js +20 -0
  24. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  25. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  26. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  27. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  28. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  29. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  30. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  31. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  32. package/dist/models/commission-estimate-class.d.ts +2 -1
  33. package/dist/models/commission-estimate-class.js +2 -1
  34. package/dist/models/create-commission-agreement-request-dto.d.ts +7 -0
  35. package/dist/models/create-commission-agreement-version-request-dto.d.ts +7 -0
  36. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  37. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  38. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  39. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  40. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  41. package/dist/models/create-commission-clawback-response-class.js +21 -0
  42. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  43. package/dist/models/create-commission-item-request-dto.js +2 -1
  44. package/dist/models/create-commission-request-dto.d.ts +6 -0
  45. package/dist/models/evaluated-commission-class.d.ts +2 -1
  46. package/dist/models/evaluated-commission-class.js +2 -1
  47. package/dist/models/index.d.ts +16 -0
  48. package/dist/models/index.js +16 -0
  49. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  50. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  51. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  52. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  53. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  54. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  55. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  56. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  57. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  58. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  59. package/models/clawback-config-class.ts +48 -0
  60. package/models/clawback-config-dto.ts +48 -0
  61. package/models/commission-agreement-version-class.ts +7 -0
  62. package/models/commission-agreement-version-config-class.ts +38 -0
  63. package/models/commission-agreement-version-config-dto.ts +38 -0
  64. package/models/commission-candidate-class.ts +12 -0
  65. package/models/commission-class.ts +41 -0
  66. package/models/commission-config-dto.ts +3 -2
  67. package/models/commission-creation-config-class.ts +52 -0
  68. package/models/commission-creation-config-dto.ts +52 -0
  69. package/models/commission-creation-invoice-config-class.ts +30 -0
  70. package/models/commission-creation-invoice-config-dto.ts +30 -0
  71. package/models/commission-creation-renewal-config-class.ts +38 -0
  72. package/models/commission-creation-renewal-config-dto.ts +38 -0
  73. package/models/commission-estimate-class.ts +3 -2
  74. package/models/create-commission-agreement-request-dto.ts +7 -0
  75. package/models/create-commission-agreement-version-request-dto.ts +7 -0
  76. package/models/create-commission-candidate-request-dto.ts +16 -3
  77. package/models/create-commission-clawback-request-dto.ts +30 -0
  78. package/models/create-commission-clawback-response-class.ts +52 -0
  79. package/models/create-commission-item-request-dto.ts +3 -2
  80. package/models/create-commission-request-dto.ts +6 -0
  81. package/models/evaluated-commission-class.ts +3 -2
  82. package/models/index.ts +16 -0
  83. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  84. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  85. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  86. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  87. package/models/update-commission-candidate-request-dto.ts +3 -2
  88. 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,127 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
368
421
  });
369
422
  });
370
423
  },
424
+ /**
425
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
426
+ * @summary List scheduled commission clawback triggers
427
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
428
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
429
+ * @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.
430
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
431
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
432
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt</i>
433
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
434
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
435
+ * @param {*} [options] Override http request option.
436
+ * @throws {RequiredError}
437
+ */
438
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
439
+ if (options === void 0) { options = {}; }
440
+ return __awaiter(_this, void 0, void 0, function () {
441
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
442
+ return __generator(this, function (_a) {
443
+ switch (_a.label) {
444
+ case 0:
445
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/scheduled-triggers";
446
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
447
+ if (configuration) {
448
+ baseOptions = configuration.baseOptions;
449
+ baseAccessToken = configuration.accessToken;
450
+ }
451
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
452
+ localVarHeaderParameter = {};
453
+ localVarQueryParameter = {};
454
+ // authentication bearer required
455
+ // http bearer authentication required
456
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
457
+ case 1:
458
+ // authentication bearer required
459
+ // http bearer authentication required
460
+ _a.sent();
461
+ if (pageSize !== undefined) {
462
+ localVarQueryParameter['pageSize'] = pageSize;
463
+ }
464
+ if (pageToken !== undefined) {
465
+ localVarQueryParameter['pageToken'] = pageToken;
466
+ }
467
+ if (filter !== undefined) {
468
+ localVarQueryParameter['filter'] = filter;
469
+ }
470
+ if (search !== undefined) {
471
+ localVarQueryParameter['search'] = search;
472
+ }
473
+ if (order !== undefined) {
474
+ localVarQueryParameter['order'] = order;
475
+ }
476
+ if (expand !== undefined) {
477
+ localVarQueryParameter['expand'] = expand;
478
+ }
479
+ if (filters !== undefined) {
480
+ localVarQueryParameter['filters'] = filters;
481
+ }
482
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
483
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
484
+ }
485
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
486
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
487
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
488
+ return [2 /*return*/, {
489
+ url: (0, common_1.toPathString)(localVarUrlObj),
490
+ options: localVarRequestOptions,
491
+ }];
492
+ }
493
+ });
494
+ });
495
+ },
496
+ /**
497
+ * 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.
498
+ * @summary Create the due commission clawbacks trigger
499
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
500
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
501
+ * @param {*} [options] Override http request option.
502
+ * @throws {RequiredError}
503
+ */
504
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
505
+ if (options === void 0) { options = {}; }
506
+ return __awaiter(_this, void 0, void 0, function () {
507
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
508
+ return __generator(this, function (_a) {
509
+ switch (_a.label) {
510
+ case 0:
511
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
512
+ (0, common_1.assertParamExists)('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto);
513
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/trigger-due";
514
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
515
+ if (configuration) {
516
+ baseOptions = configuration.baseOptions;
517
+ baseAccessToken = configuration.accessToken;
518
+ }
519
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
520
+ localVarHeaderParameter = {};
521
+ localVarQueryParameter = {};
522
+ // authentication bearer required
523
+ // http bearer authentication required
524
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
525
+ case 1:
526
+ // authentication bearer required
527
+ // http bearer authentication required
528
+ _a.sent();
529
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
530
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
531
+ }
532
+ localVarHeaderParameter['Content-Type'] = 'application/json';
533
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
534
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
535
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
536
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration);
537
+ return [2 /*return*/, {
538
+ url: (0, common_1.toPathString)(localVarUrlObj),
539
+ options: localVarRequestOptions,
540
+ }];
541
+ }
542
+ });
543
+ });
544
+ },
371
545
  /**
372
546
  * This will update commission.
373
547
  * @summary Update the commission
@@ -452,6 +626,28 @@ var CommissionsApiFp = function (configuration) {
452
626
  });
453
627
  });
454
628
  },
629
+ /**
630
+ * Creates a manual clawback for one commission.
631
+ * @summary Create the commission clawback
632
+ * @param {string} code Unique identifier for the object.
633
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
634
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
635
+ * @param {*} [options] Override http request option.
636
+ * @throws {RequiredError}
637
+ */
638
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
639
+ return __awaiter(this, void 0, void 0, function () {
640
+ var localVarAxiosArgs;
641
+ return __generator(this, function (_a) {
642
+ switch (_a.label) {
643
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options)];
644
+ case 1:
645
+ localVarAxiosArgs = _a.sent();
646
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
647
+ }
648
+ });
649
+ });
650
+ },
455
651
  /**
456
652
  * This will delete commission.
457
653
  * @summary Delete the commission
@@ -543,6 +739,54 @@ var CommissionsApiFp = function (configuration) {
543
739
  });
544
740
  });
545
741
  },
742
+ /**
743
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
744
+ * @summary List scheduled commission clawback triggers
745
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
746
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
747
+ * @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.
748
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
749
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
750
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt</i>
751
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
752
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
753
+ * @param {*} [options] Override http request option.
754
+ * @throws {RequiredError}
755
+ */
756
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
757
+ return __awaiter(this, void 0, void 0, function () {
758
+ var localVarAxiosArgs;
759
+ return __generator(this, function (_a) {
760
+ switch (_a.label) {
761
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
762
+ case 1:
763
+ localVarAxiosArgs = _a.sent();
764
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
765
+ }
766
+ });
767
+ });
768
+ },
769
+ /**
770
+ * 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.
771
+ * @summary Create the due commission clawbacks trigger
772
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
773
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
774
+ * @param {*} [options] Override http request option.
775
+ * @throws {RequiredError}
776
+ */
777
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
778
+ return __awaiter(this, void 0, void 0, function () {
779
+ var localVarAxiosArgs;
780
+ return __generator(this, function (_a) {
781
+ switch (_a.label) {
782
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options)];
783
+ case 1:
784
+ localVarAxiosArgs = _a.sent();
785
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
786
+ }
787
+ });
788
+ });
789
+ },
546
790
  /**
547
791
  * This will update commission.
548
792
  * @summary Update the commission
@@ -586,6 +830,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
586
830
  createCommission: function (createCommissionRequestDto, authorization, options) {
587
831
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
588
832
  },
833
+ /**
834
+ * Creates a manual clawback for one commission.
835
+ * @summary Create the commission clawback
836
+ * @param {string} code Unique identifier for the object.
837
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
838
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
839
+ * @param {*} [options] Override http request option.
840
+ * @throws {RequiredError}
841
+ */
842
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
843
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
844
+ },
589
845
  /**
590
846
  * This will delete commission.
591
847
  * @summary Delete the commission
@@ -637,6 +893,34 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
637
893
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
638
894
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
639
895
  },
896
+ /**
897
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
898
+ * @summary List scheduled commission clawback triggers
899
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
900
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
901
+ * @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.
902
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
903
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
904
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt</i>
905
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
906
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
907
+ * @param {*} [options] Override http request option.
908
+ * @throws {RequiredError}
909
+ */
910
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
911
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
912
+ },
913
+ /**
914
+ * 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.
915
+ * @summary Create the due commission clawbacks trigger
916
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
917
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
918
+ * @param {*} [options] Override http request option.
919
+ * @throws {RequiredError}
920
+ */
921
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
922
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
923
+ },
640
924
  /**
641
925
  * This will update commission.
642
926
  * @summary Update the commission
@@ -675,6 +959,18 @@ var CommissionsApi = /** @class */ (function (_super) {
675
959
  var _this = this;
676
960
  return (0, exports.CommissionsApiFp)(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
677
961
  };
962
+ /**
963
+ * Creates a manual clawback for one commission.
964
+ * @summary Create the commission clawback
965
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
966
+ * @param {*} [options] Override http request option.
967
+ * @throws {RequiredError}
968
+ * @memberof CommissionsApi
969
+ */
970
+ CommissionsApi.prototype.createCommissionClawback = function (requestParameters, options) {
971
+ var _this = this;
972
+ return (0, exports.CommissionsApiFp)(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
973
+ };
678
974
  /**
679
975
  * This will delete commission.
680
976
  * @summary Delete the commission
@@ -724,6 +1020,31 @@ var CommissionsApi = /** @class */ (function (_super) {
724
1020
  if (requestParameters === void 0) { requestParameters = {}; }
725
1021
  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
1022
  };
1023
+ /**
1024
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1025
+ * @summary List scheduled commission clawback triggers
1026
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1027
+ * @param {*} [options] Override http request option.
1028
+ * @throws {RequiredError}
1029
+ * @memberof CommissionsApi
1030
+ */
1031
+ CommissionsApi.prototype.listScheduledCommissionClawbackTriggers = function (requestParameters, options) {
1032
+ var _this = this;
1033
+ if (requestParameters === void 0) { requestParameters = {}; }
1034
+ return (0, exports.CommissionsApiFp)(this.configuration).listScheduledCommissionClawbackTriggers(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); });
1035
+ };
1036
+ /**
1037
+ * 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.
1038
+ * @summary Create the due commission clawbacks trigger
1039
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1040
+ * @param {*} [options] Override http request option.
1041
+ * @throws {RequiredError}
1042
+ * @memberof CommissionsApi
1043
+ */
1044
+ CommissionsApi.prototype.triggerDueCommissionClawbacks = function (requestParameters, options) {
1045
+ var _this = this;
1046
+ return (0, exports.CommissionsApiFp)(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1047
+ };
727
1048
  /**
728
1049
  * This will update commission.
729
1050
  * @summary Update the commission
@@ -0,0 +1,42 @@
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
+ /**
37
+ * Allow automatic commission clawback creation for reopened invoices.
38
+ * @type {boolean}
39
+ * @memberof ClawbackConfigClass
40
+ */
41
+ 'invoiceReopened': boolean;
42
+ }
@@ -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,42 @@
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
+ /**
37
+ * Allow automatic commission clawback creation for reopened invoices.
38
+ * @type {boolean}
39
+ * @memberof ClawbackConfigDto
40
+ */
41
+ 'invoiceReopened': boolean;
42
+ }
@@ -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 });
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import { CommissionAgreementClass } from './commission-agreement-class';
13
13
  import { CommissionAgreementProductClass } from './commission-agreement-product-class';
14
+ import { CommissionAgreementVersionConfigClass } from './commission-agreement-version-config-class';
14
15
  /**
15
16
  *
16
17
  * @export
@@ -59,6 +60,12 @@ export interface CommissionAgreementVersionClass {
59
60
  * @memberof CommissionAgreementVersionClass
60
61
  */
61
62
  'settlementCreationDate'?: string;
63
+ /**
64
+ * Version-scoped agreement configuration.
65
+ * @type {CommissionAgreementVersionConfigClass}
66
+ * @memberof CommissionAgreementVersionClass
67
+ */
68
+ 'config': CommissionAgreementVersionConfigClass;
62
69
  /**
63
70
  * Description explaining what changed in this version or version notes
64
71
  * @type {string}
@@ -0,0 +1,32 @@
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
+ import { ClawbackConfigClass } from './clawback-config-class';
13
+ import { CommissionCreationConfigClass } from './commission-creation-config-class';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface CommissionAgreementVersionConfigClass
18
+ */
19
+ export interface CommissionAgreementVersionConfigClass {
20
+ /**
21
+ * Controls which clawback triggers are enabled for this commission agreement version. Missing values are treated as disabled by default.
22
+ * @type {ClawbackConfigClass}
23
+ * @memberof CommissionAgreementVersionConfigClass
24
+ */
25
+ 'clawback'?: ClawbackConfigClass;
26
+ /**
27
+ * Controls when recurring commission work is created for this commission agreement version. Missing values are treated as renewal mode by default.
28
+ * @type {CommissionCreationConfigClass}
29
+ * @memberof CommissionAgreementVersionConfigClass
30
+ */
31
+ 'commissionCreation'?: CommissionCreationConfigClass;
32
+ }
@@ -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,32 @@
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
+ import { ClawbackConfigDto } from './clawback-config-dto';
13
+ import { CommissionCreationConfigDto } from './commission-creation-config-dto';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface CommissionAgreementVersionConfigDto
18
+ */
19
+ export interface CommissionAgreementVersionConfigDto {
20
+ /**
21
+ * Controls which clawback triggers are enabled for this commission agreement version. Missing values are treated as disabled by default.
22
+ * @type {ClawbackConfigDto}
23
+ * @memberof CommissionAgreementVersionConfigDto
24
+ */
25
+ 'clawback'?: ClawbackConfigDto;
26
+ /**
27
+ * Controls when recurring commission work is created for this commission agreement version. Missing values are treated as renewal mode by default.
28
+ * @type {CommissionCreationConfigDto}
29
+ * @memberof CommissionAgreementVersionConfigDto
30
+ */
31
+ 'commissionCreation'?: CommissionCreationConfigDto;
32
+ }
@@ -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 });
@@ -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}