@emilgroup/commission-sdk 2.10.1-beta.2 → 2.10.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
@@ -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
@@ -364,6 +417,127 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
364
417
  });
365
418
  });
366
419
  },
420
+ /**
421
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
422
+ * @summary List scheduled commission clawback triggers
423
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
424
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
425
+ * @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.
426
+ * @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>
427
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
428
+ * @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>
429
+ * @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/>
430
+ * @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>
431
+ * @param {*} [options] Override http request option.
432
+ * @throws {RequiredError}
433
+ */
434
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
435
+ if (options === void 0) { options = {}; }
436
+ return __awaiter(_this, void 0, void 0, function () {
437
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
438
+ return __generator(this, function (_a) {
439
+ switch (_a.label) {
440
+ case 0:
441
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/scheduled-triggers";
442
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
443
+ if (configuration) {
444
+ baseOptions = configuration.baseOptions;
445
+ baseAccessToken = configuration.accessToken;
446
+ }
447
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, 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 (pageSize !== undefined) {
458
+ localVarQueryParameter['pageSize'] = pageSize;
459
+ }
460
+ if (pageToken !== undefined) {
461
+ localVarQueryParameter['pageToken'] = pageToken;
462
+ }
463
+ if (filter !== undefined) {
464
+ localVarQueryParameter['filter'] = filter;
465
+ }
466
+ if (search !== undefined) {
467
+ localVarQueryParameter['search'] = search;
468
+ }
469
+ if (order !== undefined) {
470
+ localVarQueryParameter['order'] = order;
471
+ }
472
+ if (expand !== undefined) {
473
+ localVarQueryParameter['expand'] = expand;
474
+ }
475
+ if (filters !== undefined) {
476
+ localVarQueryParameter['filters'] = filters;
477
+ }
478
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
479
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
480
+ }
481
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
482
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
483
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
484
+ return [2 /*return*/, {
485
+ url: (0, common_1.toPathString)(localVarUrlObj),
486
+ options: localVarRequestOptions,
487
+ }];
488
+ }
489
+ });
490
+ });
491
+ },
492
+ /**
493
+ * 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.
494
+ * @summary Create the due commission clawbacks trigger
495
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
496
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
+ * @param {*} [options] Override http request option.
498
+ * @throws {RequiredError}
499
+ */
500
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
501
+ if (options === void 0) { options = {}; }
502
+ return __awaiter(_this, void 0, void 0, function () {
503
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
504
+ return __generator(this, function (_a) {
505
+ switch (_a.label) {
506
+ case 0:
507
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
508
+ (0, common_1.assertParamExists)('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto);
509
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/trigger-due";
510
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
511
+ if (configuration) {
512
+ baseOptions = configuration.baseOptions;
513
+ baseAccessToken = configuration.accessToken;
514
+ }
515
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
516
+ localVarHeaderParameter = {};
517
+ localVarQueryParameter = {};
518
+ // authentication bearer required
519
+ // http bearer authentication required
520
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
521
+ case 1:
522
+ // authentication bearer required
523
+ // http bearer authentication required
524
+ _a.sent();
525
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
526
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
527
+ }
528
+ localVarHeaderParameter['Content-Type'] = 'application/json';
529
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
530
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
531
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
532
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration);
533
+ return [2 /*return*/, {
534
+ url: (0, common_1.toPathString)(localVarUrlObj),
535
+ options: localVarRequestOptions,
536
+ }];
537
+ }
538
+ });
539
+ });
540
+ },
367
541
  /**
368
542
  * This will update commission.
369
543
  * @summary Update the commission
@@ -448,6 +622,28 @@ var CommissionsApiFp = function (configuration) {
448
622
  });
449
623
  });
450
624
  },
625
+ /**
626
+ * Creates a manual clawback for one commission.
627
+ * @summary Create the commission clawback
628
+ * @param {string} code Unique identifier for the object.
629
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
630
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
631
+ * @param {*} [options] Override http request option.
632
+ * @throws {RequiredError}
633
+ */
634
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
635
+ return __awaiter(this, void 0, void 0, function () {
636
+ var localVarAxiosArgs;
637
+ return __generator(this, function (_a) {
638
+ switch (_a.label) {
639
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options)];
640
+ case 1:
641
+ localVarAxiosArgs = _a.sent();
642
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
643
+ }
644
+ });
645
+ });
646
+ },
451
647
  /**
452
648
  * This will delete commission.
453
649
  * @summary Delete the commission
@@ -539,6 +735,54 @@ var CommissionsApiFp = function (configuration) {
539
735
  });
540
736
  });
541
737
  },
738
+ /**
739
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
740
+ * @summary List scheduled commission clawback triggers
741
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
742
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
743
+ * @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.
744
+ * @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>
745
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
746
+ * @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>
747
+ * @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/>
748
+ * @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>
749
+ * @param {*} [options] Override http request option.
750
+ * @throws {RequiredError}
751
+ */
752
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
753
+ return __awaiter(this, void 0, void 0, function () {
754
+ var localVarAxiosArgs;
755
+ return __generator(this, function (_a) {
756
+ switch (_a.label) {
757
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
758
+ case 1:
759
+ localVarAxiosArgs = _a.sent();
760
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
761
+ }
762
+ });
763
+ });
764
+ },
765
+ /**
766
+ * 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.
767
+ * @summary Create the due commission clawbacks trigger
768
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
769
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
770
+ * @param {*} [options] Override http request option.
771
+ * @throws {RequiredError}
772
+ */
773
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
774
+ return __awaiter(this, void 0, void 0, function () {
775
+ var localVarAxiosArgs;
776
+ return __generator(this, function (_a) {
777
+ switch (_a.label) {
778
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options)];
779
+ case 1:
780
+ localVarAxiosArgs = _a.sent();
781
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
782
+ }
783
+ });
784
+ });
785
+ },
542
786
  /**
543
787
  * This will update commission.
544
788
  * @summary Update the commission
@@ -582,6 +826,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
582
826
  createCommission: function (createCommissionRequestDto, authorization, options) {
583
827
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
584
828
  },
829
+ /**
830
+ * Creates a manual clawback for one commission.
831
+ * @summary Create the commission clawback
832
+ * @param {string} code Unique identifier for the object.
833
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
834
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
835
+ * @param {*} [options] Override http request option.
836
+ * @throws {RequiredError}
837
+ */
838
+ createCommissionClawback: function (code, createCommissionClawbackRequestDto, authorization, options) {
839
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
840
+ },
585
841
  /**
586
842
  * This will delete commission.
587
843
  * @summary Delete the commission
@@ -633,6 +889,34 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
633
889
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
634
890
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
635
891
  },
892
+ /**
893
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
894
+ * @summary List scheduled commission clawback triggers
895
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
896
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
897
+ * @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.
898
+ * @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>
899
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
900
+ * @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>
901
+ * @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/>
902
+ * @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>
903
+ * @param {*} [options] Override http request option.
904
+ * @throws {RequiredError}
905
+ */
906
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
907
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
908
+ },
909
+ /**
910
+ * 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.
911
+ * @summary Create the due commission clawbacks trigger
912
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
913
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
914
+ * @param {*} [options] Override http request option.
915
+ * @throws {RequiredError}
916
+ */
917
+ triggerDueCommissionClawbacks: function (triggerDueCommissionClawbacksRequestDto, authorization, options) {
918
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
919
+ },
636
920
  /**
637
921
  * This will update commission.
638
922
  * @summary Update the commission
@@ -671,6 +955,18 @@ var CommissionsApi = /** @class */ (function (_super) {
671
955
  var _this = this;
672
956
  return (0, exports.CommissionsApiFp)(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
673
957
  };
958
+ /**
959
+ * Creates a manual clawback for one commission.
960
+ * @summary Create the commission clawback
961
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
962
+ * @param {*} [options] Override http request option.
963
+ * @throws {RequiredError}
964
+ * @memberof CommissionsApi
965
+ */
966
+ CommissionsApi.prototype.createCommissionClawback = function (requestParameters, options) {
967
+ var _this = this;
968
+ return (0, exports.CommissionsApiFp)(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
969
+ };
674
970
  /**
675
971
  * This will delete commission.
676
972
  * @summary Delete the commission
@@ -720,6 +1016,31 @@ var CommissionsApi = /** @class */ (function (_super) {
720
1016
  if (requestParameters === void 0) { requestParameters = {}; }
721
1017
  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
1018
  };
1019
+ /**
1020
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1021
+ * @summary List scheduled commission clawback triggers
1022
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1023
+ * @param {*} [options] Override http request option.
1024
+ * @throws {RequiredError}
1025
+ * @memberof CommissionsApi
1026
+ */
1027
+ CommissionsApi.prototype.listScheduledCommissionClawbackTriggers = function (requestParameters, options) {
1028
+ var _this = this;
1029
+ if (requestParameters === void 0) { requestParameters = {}; }
1030
+ 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); });
1031
+ };
1032
+ /**
1033
+ * 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.
1034
+ * @summary Create the due commission clawbacks trigger
1035
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1036
+ * @param {*} [options] Override http request option.
1037
+ * @throws {RequiredError}
1038
+ * @memberof CommissionsApi
1039
+ */
1040
+ CommissionsApi.prototype.triggerDueCommissionClawbacks = function (requestParameters, options) {
1041
+ var _this = this;
1042
+ return (0, exports.CommissionsApiFp)(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1043
+ };
723
1044
  /**
724
1045
  * This will update commission.
725
1046
  * @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}