@emilgroup/commission-sdk-node 2.9.1-beta.8 → 2.9.1-beta.80

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 (80) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +4 -4
  4. package/api/commission-agreement-rules-api.ts +20 -6
  5. package/api/commission-settlements-api.ts +8 -8
  6. package/api/commissions-api.ts +376 -0
  7. package/dist/api/commission-agreement-products-api.d.ts +4 -4
  8. package/dist/api/commission-agreement-products-api.js +3 -3
  9. package/dist/api/commission-agreement-rules-api.d.ts +12 -3
  10. package/dist/api/commission-agreement-rules-api.js +12 -6
  11. package/dist/api/commission-settlements-api.d.ts +8 -8
  12. package/dist/api/commission-settlements-api.js +3 -3
  13. package/dist/api/commissions-api.d.ts +220 -0
  14. package/dist/api/commissions-api.js +258 -0
  15. package/dist/models/clawback-config-class.d.ts +6 -0
  16. package/dist/models/clawback-config-dto.d.ts +6 -0
  17. package/dist/models/commission-agreement-class.d.ts +2 -2
  18. package/dist/models/commission-agreement-class.js +1 -1
  19. package/dist/models/commission-agreement-version-class.d.ts +4 -4
  20. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  21. package/dist/models/commission-agreement-version-config-class.js +15 -0
  22. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  23. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  24. package/dist/models/commission-class.d.ts +13 -6
  25. package/dist/models/commission-class.js +2 -1
  26. package/dist/models/commission-creation-config-class.d.ts +43 -0
  27. package/dist/models/commission-creation-config-class.js +20 -0
  28. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  29. package/dist/models/commission-creation-config-dto.js +20 -0
  30. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  31. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  32. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  33. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  34. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  35. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  36. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  37. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  38. package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
  39. package/dist/models/commission-paid-invoice-entry-class.js +22 -0
  40. package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
  41. package/dist/models/create-commission-agreement-request-dto.js +1 -1
  42. package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
  43. package/dist/models/index.d.ts +12 -0
  44. package/dist/models/index.js +12 -0
  45. package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
  46. package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
  47. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  48. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -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 +1 -1
  54. package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
  55. package/dist/models/update-commission-agreement-request-dto.js +1 -1
  56. package/models/clawback-config-class.ts +6 -0
  57. package/models/clawback-config-dto.ts +6 -0
  58. package/models/commission-agreement-class.ts +2 -2
  59. package/models/commission-agreement-version-class.ts +4 -4
  60. package/models/commission-agreement-version-config-class.ts +38 -0
  61. package/models/commission-agreement-version-config-dto.ts +38 -0
  62. package/models/commission-class.ts +14 -7
  63. package/models/commission-creation-config-class.ts +52 -0
  64. package/models/commission-creation-config-dto.ts +52 -0
  65. package/models/commission-creation-invoice-config-class.ts +30 -0
  66. package/models/commission-creation-invoice-config-dto.ts +30 -0
  67. package/models/commission-creation-renewal-config-class.ts +38 -0
  68. package/models/commission-creation-renewal-config-dto.ts +38 -0
  69. package/models/commission-paid-invoice-entry-class.ts +124 -0
  70. package/models/create-commission-agreement-request-dto.ts +5 -5
  71. package/models/create-commission-agreement-version-request-dto.ts +4 -4
  72. package/models/index.ts +12 -0
  73. package/models/list-commission-agreement-versions-response-class.ts +10 -10
  74. package/models/list-commission-agreements-response-class.ts +10 -10
  75. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  76. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  77. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  78. package/models/trigger-due-commission-clawbacks-request-dto.ts +1 -1
  79. package/models/update-commission-agreement-request-dto.ts +2 -2
  80. package/package.json +1 -1
@@ -349,6 +349,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
349
349
  });
350
350
  });
351
351
  },
352
+ /**
353
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
354
+ * @summary List commission paid invoice entries
355
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
357
+ * @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.
358
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
359
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
360
+ * @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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
361
+ * @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/>
362
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
367
+ if (options === void 0) { options = {}; }
368
+ return __awaiter(_this, void 0, void 0, function () {
369
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
370
+ return __generator(this, function (_a) {
371
+ switch (_a.label) {
372
+ case 0:
373
+ localVarPath = "/commissionservice/v1/commissions/paid-invoice-entries";
374
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
375
+ if (configuration) {
376
+ baseOptions = configuration.baseOptions;
377
+ baseAccessToken = configuration.accessToken;
378
+ }
379
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
380
+ localVarHeaderParameter = {};
381
+ localVarQueryParameter = {};
382
+ // authentication bearer required
383
+ // http bearer authentication required
384
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
385
+ case 1:
386
+ // authentication bearer required
387
+ // http bearer authentication required
388
+ _a.sent();
389
+ if (pageSize !== undefined) {
390
+ localVarQueryParameter['pageSize'] = pageSize;
391
+ }
392
+ if (pageToken !== undefined) {
393
+ localVarQueryParameter['pageToken'] = pageToken;
394
+ }
395
+ if (filter !== undefined) {
396
+ localVarQueryParameter['filter'] = filter;
397
+ }
398
+ if (search !== undefined) {
399
+ localVarQueryParameter['search'] = search;
400
+ }
401
+ if (order !== undefined) {
402
+ localVarQueryParameter['order'] = order;
403
+ }
404
+ if (expand !== undefined) {
405
+ localVarQueryParameter['expand'] = expand;
406
+ }
407
+ if (filters !== undefined) {
408
+ localVarQueryParameter['filters'] = filters;
409
+ }
410
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
411
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
412
+ }
413
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
414
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
415
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
416
+ return [2 /*return*/, {
417
+ url: (0, common_1.toPathString)(localVarUrlObj),
418
+ options: localVarRequestOptions,
419
+ }];
420
+ }
421
+ });
422
+ });
423
+ },
352
424
  /**
353
425
  * Retrieves a list of commissions.
354
426
  * @summary List commissions
@@ -421,6 +493,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
421
493
  });
422
494
  });
423
495
  },
496
+ /**
497
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
498
+ * @summary List scheduled commission clawback triggers
499
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
500
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
501
+ * @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.
502
+ * @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>
503
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
504
+ * @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>
505
+ * @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/>
506
+ * @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>
507
+ * @param {*} [options] Override http request option.
508
+ * @throws {RequiredError}
509
+ */
510
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
511
+ if (options === void 0) { options = {}; }
512
+ return __awaiter(_this, void 0, void 0, function () {
513
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
514
+ return __generator(this, function (_a) {
515
+ switch (_a.label) {
516
+ case 0:
517
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/scheduled-triggers";
518
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
519
+ if (configuration) {
520
+ baseOptions = configuration.baseOptions;
521
+ baseAccessToken = configuration.accessToken;
522
+ }
523
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
524
+ localVarHeaderParameter = {};
525
+ localVarQueryParameter = {};
526
+ // authentication bearer required
527
+ // http bearer authentication required
528
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
529
+ case 1:
530
+ // authentication bearer required
531
+ // http bearer authentication required
532
+ _a.sent();
533
+ if (pageSize !== undefined) {
534
+ localVarQueryParameter['pageSize'] = pageSize;
535
+ }
536
+ if (pageToken !== undefined) {
537
+ localVarQueryParameter['pageToken'] = pageToken;
538
+ }
539
+ if (filter !== undefined) {
540
+ localVarQueryParameter['filter'] = filter;
541
+ }
542
+ if (search !== undefined) {
543
+ localVarQueryParameter['search'] = search;
544
+ }
545
+ if (order !== undefined) {
546
+ localVarQueryParameter['order'] = order;
547
+ }
548
+ if (expand !== undefined) {
549
+ localVarQueryParameter['expand'] = expand;
550
+ }
551
+ if (filters !== undefined) {
552
+ localVarQueryParameter['filters'] = filters;
553
+ }
554
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
555
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
556
+ }
557
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
558
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
559
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
560
+ return [2 /*return*/, {
561
+ url: (0, common_1.toPathString)(localVarUrlObj),
562
+ options: localVarRequestOptions,
563
+ }];
564
+ }
565
+ });
566
+ });
567
+ },
424
568
  /**
425
569
  * 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
570
  * @summary Create the due commission clawbacks trigger
@@ -640,6 +784,33 @@ var CommissionsApiFp = function (configuration) {
640
784
  });
641
785
  });
642
786
  },
787
+ /**
788
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
789
+ * @summary List commission paid invoice entries
790
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
791
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
792
+ * @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.
793
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
794
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
795
+ * @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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
796
+ * @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/>
797
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
798
+ * @param {*} [options] Override http request option.
799
+ * @throws {RequiredError}
800
+ */
801
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
802
+ return __awaiter(this, void 0, void 0, function () {
803
+ var localVarAxiosArgs;
804
+ return __generator(this, function (_a) {
805
+ switch (_a.label) {
806
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
807
+ case 1:
808
+ localVarAxiosArgs = _a.sent();
809
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
810
+ }
811
+ });
812
+ });
813
+ },
643
814
  /**
644
815
  * Retrieves a list of commissions.
645
816
  * @summary List commissions
@@ -667,6 +838,33 @@ var CommissionsApiFp = function (configuration) {
667
838
  });
668
839
  });
669
840
  },
841
+ /**
842
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
843
+ * @summary List scheduled commission clawback triggers
844
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
845
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
846
+ * @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.
847
+ * @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>
848
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
849
+ * @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>
850
+ * @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/>
851
+ * @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>
852
+ * @param {*} [options] Override http request option.
853
+ * @throws {RequiredError}
854
+ */
855
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
856
+ return __awaiter(this, void 0, void 0, function () {
857
+ var localVarAxiosArgs;
858
+ return __generator(this, function (_a) {
859
+ switch (_a.label) {
860
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
861
+ case 1:
862
+ localVarAxiosArgs = _a.sent();
863
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
864
+ }
865
+ });
866
+ });
867
+ },
670
868
  /**
671
869
  * 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
870
  * @summary Create the due commission clawbacks trigger
@@ -777,6 +975,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
777
975
  getCommission: function (code, expand, authorization, options) {
778
976
  return localVarFp.getCommission(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
779
977
  },
978
+ /**
979
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
980
+ * @summary List commission paid invoice entries
981
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
982
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
983
+ * @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.
984
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
985
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
986
+ * @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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
987
+ * @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/>
988
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
989
+ * @param {*} [options] Override http request option.
990
+ * @throws {RequiredError}
991
+ */
992
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
993
+ return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
994
+ },
780
995
  /**
781
996
  * Retrieves a list of commissions.
782
997
  * @summary List commissions
@@ -794,6 +1009,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
794
1009
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
795
1010
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
796
1011
  },
1012
+ /**
1013
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1014
+ * @summary List scheduled commission clawback triggers
1015
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
1016
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1017
+ * @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.
1018
+ * @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>
1019
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
1020
+ * @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>
1021
+ * @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/>
1022
+ * @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>
1023
+ * @param {*} [options] Override http request option.
1024
+ * @throws {RequiredError}
1025
+ */
1026
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
1027
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
1028
+ },
797
1029
  /**
798
1030
  * 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
1031
  * @summary Create the due commission clawbacks trigger
@@ -891,6 +1123,19 @@ var CommissionsApi = /** @class */ (function (_super) {
891
1123
  var _this = this;
892
1124
  return (0, exports.CommissionsApiFp)(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
893
1125
  };
1126
+ /**
1127
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
1128
+ * @summary List commission paid invoice entries
1129
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
1130
+ * @param {*} [options] Override http request option.
1131
+ * @throws {RequiredError}
1132
+ * @memberof CommissionsApi
1133
+ */
1134
+ CommissionsApi.prototype.listCommissionPaidInvoiceEntries = function (requestParameters, options) {
1135
+ var _this = this;
1136
+ if (requestParameters === void 0) { requestParameters = {}; }
1137
+ return (0, exports.CommissionsApiFp)(this.configuration).listCommissionPaidInvoiceEntries(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); });
1138
+ };
894
1139
  /**
895
1140
  * Retrieves a list of commissions.
896
1141
  * @summary List commissions
@@ -904,6 +1149,19 @@ var CommissionsApi = /** @class */ (function (_super) {
904
1149
  if (requestParameters === void 0) { requestParameters = {}; }
905
1150
  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); });
906
1151
  };
1152
+ /**
1153
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1154
+ * @summary List scheduled commission clawback triggers
1155
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1156
+ * @param {*} [options] Override http request option.
1157
+ * @throws {RequiredError}
1158
+ * @memberof CommissionsApi
1159
+ */
1160
+ CommissionsApi.prototype.listScheduledCommissionClawbackTriggers = function (requestParameters, options) {
1161
+ var _this = this;
1162
+ if (requestParameters === void 0) { requestParameters = {}; }
1163
+ 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); });
1164
+ };
907
1165
  /**
908
1166
  * 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
1167
  * @summary Create the due commission clawbacks trigger
@@ -33,4 +33,10 @@ export interface ClawbackConfigClass {
33
33
  * @memberof ClawbackConfigClass
34
34
  */
35
35
  'intermediarySwitched': boolean;
36
+ /**
37
+ * Allow automatic commission clawback creation for reopened invoices.
38
+ * @type {boolean}
39
+ * @memberof ClawbackConfigClass
40
+ */
41
+ 'invoiceReopened': boolean;
36
42
  }
@@ -33,4 +33,10 @@ export interface ClawbackConfigDto {
33
33
  * @memberof ClawbackConfigDto
34
34
  */
35
35
  'intermediarySwitched': boolean;
36
+ /**
37
+ * Allow automatic commission clawback creation for reopened invoices.
38
+ * @type {boolean}
39
+ * @memberof ClawbackConfigDto
40
+ */
41
+ 'invoiceReopened': boolean;
36
42
  }
@@ -60,7 +60,7 @@ export interface CommissionAgreementClass {
60
60
  */
61
61
  'description'?: string;
62
62
  /**
63
- * Frequency at which commissions are billed (e.g., immediately, monthly, quarterly, halfYearly, yearly)
63
+ * Frequency at which commissions are billed (e.g., manual, monthly, quarterly, halfYearly, yearly)
64
64
  * @type {string}
65
65
  * @memberof CommissionAgreementClass
66
66
  */
@@ -104,7 +104,7 @@ export declare const CommissionAgreementClassStatusEnum: {
104
104
  };
105
105
  export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
106
106
  export declare const CommissionAgreementClassBillingFrequencyEnum: {
107
- readonly Immediately: "immediately";
107
+ readonly Manual: "manual";
108
108
  readonly Monthly: "monthly";
109
109
  readonly Quarterly: "quarterly";
110
110
  readonly HalfYearly: "halfYearly";
@@ -21,7 +21,7 @@ exports.CommissionAgreementClassStatusEnum = {
21
21
  Archived: 'archived'
22
22
  };
23
23
  exports.CommissionAgreementClassBillingFrequencyEnum = {
24
- Immediately: 'immediately',
24
+ Manual: 'manual',
25
25
  Monthly: 'monthly',
26
26
  Quarterly: 'quarterly',
27
27
  HalfYearly: 'halfYearly',
@@ -9,9 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { ClawbackConfigClass } from './clawback-config-class';
13
12
  import { CommissionAgreementClass } from './commission-agreement-class';
14
13
  import { CommissionAgreementProductClass } from './commission-agreement-product-class';
14
+ import { CommissionAgreementVersionConfigClass } from './commission-agreement-version-config-class';
15
15
  /**
16
16
  *
17
17
  * @export
@@ -61,11 +61,11 @@ export interface CommissionAgreementVersionClass {
61
61
  */
62
62
  'settlementCreationDate'?: string;
63
63
  /**
64
- * Version-scoped clawback creation configuration.
65
- * @type {ClawbackConfigClass}
64
+ * Version-scoped agreement configuration.
65
+ * @type {CommissionAgreementVersionConfigClass}
66
66
  * @memberof CommissionAgreementVersionClass
67
67
  */
68
- 'clawbackConfig': ClawbackConfigClass;
68
+ 'config': CommissionAgreementVersionConfigClass;
69
69
  /**
70
70
  * Description explaining what changed in this version or version notes
71
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 });
@@ -59,6 +59,12 @@ export interface CommissionClass {
59
59
  * @memberof CommissionClass
60
60
  */
61
61
  'commissionAgreementNumber': string;
62
+ /**
63
+ * The code of the commission agreement being used for this commission, stable across all of the agreement\'s versions
64
+ * @type {string}
65
+ * @memberof CommissionClass
66
+ */
67
+ 'commissionAgreementCode': string;
62
68
  /**
63
69
  * The unique code or identifier of the partner associated with this commission
64
70
  * @type {string}
@@ -107,12 +113,6 @@ export interface CommissionClass {
107
113
  * @memberof CommissionClass
108
114
  */
109
115
  'settlementCode'?: string;
110
- /**
111
- * The source invoice code for invoice-driven commissions
112
- * @type {string}
113
- * @memberof CommissionClass
114
- */
115
- 'invoiceCode'?: string;
116
116
  /**
117
117
  * Start of the period the commission was originally created for
118
118
  * @type {string}
@@ -143,6 +143,12 @@ export interface CommissionClass {
143
143
  * @memberof CommissionClass
144
144
  */
145
145
  'clawbackTriggerType'?: CommissionClassClawbackTriggerTypeEnum;
146
+ /**
147
+ * Whether the commission was created manually through the REST API rather than by the system. Manual commissions are clawed back in full, system commissions are clawed back using pro rata
148
+ * @type {boolean}
149
+ * @memberof CommissionClass
150
+ */
151
+ 'manual': boolean;
146
152
  /**
147
153
  * Time at which the object was created.
148
154
  * @type {string}
@@ -179,5 +185,6 @@ export declare const CommissionClassClawbackTriggerTypeEnum: {
179
185
  readonly PolicyTermination: "policy_termination";
180
186
  readonly PolicyWithdrawal: "policy_withdrawal";
181
187
  readonly IntermediarySwitched: "intermediary_switched";
188
+ readonly InvoiceReopened: "invoice_reopened";
182
189
  };
183
190
  export type CommissionClassClawbackTriggerTypeEnum = typeof CommissionClassClawbackTriggerTypeEnum[keyof typeof CommissionClassClawbackTriggerTypeEnum];
@@ -18,5 +18,6 @@ exports.CommissionClassClawbackTriggerTypeEnum = {
18
18
  Manual: 'manual',
19
19
  PolicyTermination: 'policy_termination',
20
20
  PolicyWithdrawal: 'policy_withdrawal',
21
- IntermediarySwitched: 'intermediary_switched'
21
+ IntermediarySwitched: 'intermediary_switched',
22
+ InvoiceReopened: 'invoice_reopened'
22
23
  };
@@ -0,0 +1,43 @@
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 { CommissionCreationInvoiceConfigClass } from './commission-creation-invoice-config-class';
13
+ import { CommissionCreationRenewalConfigClass } from './commission-creation-renewal-config-class';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface CommissionCreationConfigClass
18
+ */
19
+ export interface CommissionCreationConfigClass {
20
+ /**
21
+ * Determines which event drives recurring commission creation: renewal dates or paid invoices.
22
+ * @type {string}
23
+ * @memberof CommissionCreationConfigClass
24
+ */
25
+ 'mode': CommissionCreationConfigClassModeEnum;
26
+ /**
27
+ * Required when mode is renewal. Defines whether commission work is created only at renewal or yearly inside long policy periods.
28
+ * @type {CommissionCreationRenewalConfigClass}
29
+ * @memberof CommissionCreationConfigClass
30
+ */
31
+ 'renewal'?: CommissionCreationRenewalConfigClass;
32
+ /**
33
+ * Required when mode is invoice. Defines how many paid invoices must be counted before commission work is created.
34
+ * @type {CommissionCreationInvoiceConfigClass}
35
+ * @memberof CommissionCreationConfigClass
36
+ */
37
+ 'invoice'?: CommissionCreationInvoiceConfigClass;
38
+ }
39
+ export declare const CommissionCreationConfigClassModeEnum: {
40
+ readonly Renewal: "renewal";
41
+ readonly Invoice: "invoice";
42
+ };
43
+ export type CommissionCreationConfigClassModeEnum = typeof CommissionCreationConfigClassModeEnum[keyof typeof CommissionCreationConfigClassModeEnum];
@@ -0,0 +1,20 @@
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 });
16
+ exports.CommissionCreationConfigClassModeEnum = void 0;
17
+ exports.CommissionCreationConfigClassModeEnum = {
18
+ Renewal: 'renewal',
19
+ Invoice: 'invoice'
20
+ };