@emilgroup/commission-sdk 2.10.1-beta.6 → 2.10.1-beta.60

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 (85) hide show
  1. package/.openapi-generator/FILES +13 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-rules-api.ts +20 -6
  4. package/api/commission-settlements-api.ts +8 -8
  5. package/api/commissions-api.ts +376 -0
  6. package/dist/api/commission-agreement-rules-api.d.ts +12 -3
  7. package/dist/api/commission-agreement-rules-api.js +12 -6
  8. package/dist/api/commission-settlements-api.d.ts +8 -8
  9. package/dist/api/commission-settlements-api.js +3 -3
  10. package/dist/api/commissions-api.d.ts +220 -0
  11. package/dist/api/commissions-api.js +258 -0
  12. package/dist/models/clawback-config-class.d.ts +42 -0
  13. package/dist/models/clawback-config-class.js +15 -0
  14. package/dist/models/clawback-config-dto.d.ts +12 -6
  15. package/dist/models/commission-agreement-class.d.ts +2 -2
  16. package/dist/models/commission-agreement-class.js +1 -1
  17. package/dist/models/commission-agreement-version-class.d.ts +4 -4
  18. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  19. package/dist/models/commission-agreement-version-config-class.js +15 -0
  20. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  21. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  22. package/dist/models/commission-class.d.ts +13 -6
  23. package/dist/models/commission-class.js +2 -1
  24. package/dist/models/commission-creation-config-class.d.ts +43 -0
  25. package/dist/models/commission-creation-config-class.js +20 -0
  26. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  27. package/dist/models/commission-creation-config-dto.js +20 -0
  28. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  29. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  30. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  31. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  32. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  33. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  34. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  35. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  36. package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
  37. package/dist/models/commission-paid-invoice-entry-class.js +22 -0
  38. package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
  39. package/dist/models/create-commission-agreement-request-dto.js +1 -1
  40. package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
  41. package/dist/models/create-commission-candidate-request-dto.d.ts +13 -1
  42. package/dist/models/create-commission-clawback-response-class.d.ts +4 -6
  43. package/dist/models/create-commission-clawback-response-class.js +3 -5
  44. package/dist/models/create-commission-request-dto.d.ts +6 -0
  45. package/dist/models/index.d.ts +13 -0
  46. package/dist/models/index.js +13 -0
  47. package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
  48. package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
  49. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  50. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  51. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  52. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  53. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  54. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  55. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +1 -1
  56. package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
  57. package/dist/models/update-commission-agreement-request-dto.js +1 -1
  58. package/models/clawback-config-class.ts +48 -0
  59. package/models/clawback-config-dto.ts +12 -6
  60. package/models/commission-agreement-class.ts +2 -2
  61. package/models/commission-agreement-version-class.ts +4 -4
  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-class.ts +14 -7
  65. package/models/commission-creation-config-class.ts +52 -0
  66. package/models/commission-creation-config-dto.ts +52 -0
  67. package/models/commission-creation-invoice-config-class.ts +30 -0
  68. package/models/commission-creation-invoice-config-dto.ts +30 -0
  69. package/models/commission-creation-renewal-config-class.ts +38 -0
  70. package/models/commission-creation-renewal-config-dto.ts +38 -0
  71. package/models/commission-paid-invoice-entry-class.ts +124 -0
  72. package/models/create-commission-agreement-request-dto.ts +5 -5
  73. package/models/create-commission-agreement-version-request-dto.ts +4 -4
  74. package/models/create-commission-candidate-request-dto.ts +13 -1
  75. package/models/create-commission-clawback-response-class.ts +4 -6
  76. package/models/create-commission-request-dto.ts +6 -0
  77. package/models/index.ts +13 -0
  78. package/models/list-commission-agreement-versions-response-class.ts +10 -10
  79. package/models/list-commission-agreements-response-class.ts +10 -10
  80. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  81. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  82. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  83. package/models/trigger-due-commission-clawbacks-request-dto.ts +1 -1
  84. package/models/update-commission-agreement-request-dto.ts +2 -2
  85. package/package.json +1 -1
@@ -345,6 +345,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
345
345
  });
346
346
  });
347
347
  },
348
+ /**
349
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
350
+ * @summary List commission paid invoice entries
351
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
352
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
353
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
354
+ * @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>
355
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
356
+ * @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>
357
+ * @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/>
358
+ * @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>
359
+ * @param {*} [options] Override http request option.
360
+ * @throws {RequiredError}
361
+ */
362
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
363
+ if (options === void 0) { options = {}; }
364
+ return __awaiter(_this, void 0, void 0, function () {
365
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
366
+ return __generator(this, function (_a) {
367
+ switch (_a.label) {
368
+ case 0:
369
+ localVarPath = "/commissionservice/v1/commissions/paid-invoice-entries";
370
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
371
+ if (configuration) {
372
+ baseOptions = configuration.baseOptions;
373
+ baseAccessToken = configuration.accessToken;
374
+ }
375
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
376
+ localVarHeaderParameter = {};
377
+ localVarQueryParameter = {};
378
+ // authentication bearer required
379
+ // http bearer authentication required
380
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
381
+ case 1:
382
+ // authentication bearer required
383
+ // http bearer authentication required
384
+ _a.sent();
385
+ if (pageSize !== undefined) {
386
+ localVarQueryParameter['pageSize'] = pageSize;
387
+ }
388
+ if (pageToken !== undefined) {
389
+ localVarQueryParameter['pageToken'] = pageToken;
390
+ }
391
+ if (filter !== undefined) {
392
+ localVarQueryParameter['filter'] = filter;
393
+ }
394
+ if (search !== undefined) {
395
+ localVarQueryParameter['search'] = search;
396
+ }
397
+ if (order !== undefined) {
398
+ localVarQueryParameter['order'] = order;
399
+ }
400
+ if (expand !== undefined) {
401
+ localVarQueryParameter['expand'] = expand;
402
+ }
403
+ if (filters !== undefined) {
404
+ localVarQueryParameter['filters'] = filters;
405
+ }
406
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
407
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
408
+ }
409
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
410
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
411
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
412
+ return [2 /*return*/, {
413
+ url: (0, common_1.toPathString)(localVarUrlObj),
414
+ options: localVarRequestOptions,
415
+ }];
416
+ }
417
+ });
418
+ });
419
+ },
348
420
  /**
349
421
  * Retrieves a list of commissions.
350
422
  * @summary List commissions
@@ -417,6 +489,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
417
489
  });
418
490
  });
419
491
  },
492
+ /**
493
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
494
+ * @summary List scheduled commission clawback triggers
495
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
496
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
497
+ * @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.
498
+ * @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>
499
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
500
+ * @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>
501
+ * @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/>
502
+ * @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>
503
+ * @param {*} [options] Override http request option.
504
+ * @throws {RequiredError}
505
+ */
506
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
507
+ if (options === void 0) { options = {}; }
508
+ return __awaiter(_this, void 0, void 0, function () {
509
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
510
+ return __generator(this, function (_a) {
511
+ switch (_a.label) {
512
+ case 0:
513
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/scheduled-triggers";
514
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
515
+ if (configuration) {
516
+ baseOptions = configuration.baseOptions;
517
+ baseAccessToken = configuration.accessToken;
518
+ }
519
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, 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 (pageSize !== undefined) {
530
+ localVarQueryParameter['pageSize'] = pageSize;
531
+ }
532
+ if (pageToken !== undefined) {
533
+ localVarQueryParameter['pageToken'] = pageToken;
534
+ }
535
+ if (filter !== undefined) {
536
+ localVarQueryParameter['filter'] = filter;
537
+ }
538
+ if (search !== undefined) {
539
+ localVarQueryParameter['search'] = search;
540
+ }
541
+ if (order !== undefined) {
542
+ localVarQueryParameter['order'] = order;
543
+ }
544
+ if (expand !== undefined) {
545
+ localVarQueryParameter['expand'] = expand;
546
+ }
547
+ if (filters !== undefined) {
548
+ localVarQueryParameter['filters'] = filters;
549
+ }
550
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
551
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
552
+ }
553
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
554
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
555
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
556
+ return [2 /*return*/, {
557
+ url: (0, common_1.toPathString)(localVarUrlObj),
558
+ options: localVarRequestOptions,
559
+ }];
560
+ }
561
+ });
562
+ });
563
+ },
420
564
  /**
421
565
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
422
566
  * @summary Create the due commission clawbacks trigger
@@ -636,6 +780,33 @@ var CommissionsApiFp = function (configuration) {
636
780
  });
637
781
  });
638
782
  },
783
+ /**
784
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
785
+ * @summary List commission paid invoice entries
786
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
787
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
788
+ * @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.
789
+ * @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>
790
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
791
+ * @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>
792
+ * @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/>
793
+ * @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>
794
+ * @param {*} [options] Override http request option.
795
+ * @throws {RequiredError}
796
+ */
797
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
798
+ return __awaiter(this, void 0, void 0, function () {
799
+ var localVarAxiosArgs;
800
+ return __generator(this, function (_a) {
801
+ switch (_a.label) {
802
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
803
+ case 1:
804
+ localVarAxiosArgs = _a.sent();
805
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
806
+ }
807
+ });
808
+ });
809
+ },
639
810
  /**
640
811
  * Retrieves a list of commissions.
641
812
  * @summary List commissions
@@ -663,6 +834,33 @@ var CommissionsApiFp = function (configuration) {
663
834
  });
664
835
  });
665
836
  },
837
+ /**
838
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
839
+ * @summary List scheduled commission clawback triggers
840
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
841
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
842
+ * @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.
843
+ * @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>
844
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
845
+ * @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>
846
+ * @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/>
847
+ * @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>
848
+ * @param {*} [options] Override http request option.
849
+ * @throws {RequiredError}
850
+ */
851
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
852
+ return __awaiter(this, void 0, void 0, function () {
853
+ var localVarAxiosArgs;
854
+ return __generator(this, function (_a) {
855
+ switch (_a.label) {
856
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
857
+ case 1:
858
+ localVarAxiosArgs = _a.sent();
859
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
860
+ }
861
+ });
862
+ });
863
+ },
666
864
  /**
667
865
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
668
866
  * @summary Create the due commission clawbacks trigger
@@ -773,6 +971,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
773
971
  getCommission: function (code, expand, authorization, options) {
774
972
  return localVarFp.getCommission(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
775
973
  },
974
+ /**
975
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
976
+ * @summary List commission paid invoice entries
977
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
978
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
979
+ * @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.
980
+ * @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>
981
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
982
+ * @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>
983
+ * @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/>
984
+ * @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>
985
+ * @param {*} [options] Override http request option.
986
+ * @throws {RequiredError}
987
+ */
988
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
989
+ return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
990
+ },
776
991
  /**
777
992
  * Retrieves a list of commissions.
778
993
  * @summary List commissions
@@ -790,6 +1005,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
790
1005
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
791
1006
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
792
1007
  },
1008
+ /**
1009
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1010
+ * @summary List scheduled commission clawback triggers
1011
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
1012
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1013
+ * @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.
1014
+ * @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>
1015
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
1016
+ * @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>
1017
+ * @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/>
1018
+ * @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>
1019
+ * @param {*} [options] Override http request option.
1020
+ * @throws {RequiredError}
1021
+ */
1022
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
1023
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
1024
+ },
793
1025
  /**
794
1026
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
795
1027
  * @summary Create the due commission clawbacks trigger
@@ -887,6 +1119,19 @@ var CommissionsApi = /** @class */ (function (_super) {
887
1119
  var _this = this;
888
1120
  return (0, exports.CommissionsApiFp)(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
889
1121
  };
1122
+ /**
1123
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
1124
+ * @summary List commission paid invoice entries
1125
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
1126
+ * @param {*} [options] Override http request option.
1127
+ * @throws {RequiredError}
1128
+ * @memberof CommissionsApi
1129
+ */
1130
+ CommissionsApi.prototype.listCommissionPaidInvoiceEntries = function (requestParameters, options) {
1131
+ var _this = this;
1132
+ if (requestParameters === void 0) { requestParameters = {}; }
1133
+ 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); });
1134
+ };
890
1135
  /**
891
1136
  * Retrieves a list of commissions.
892
1137
  * @summary List commissions
@@ -900,6 +1145,19 @@ var CommissionsApi = /** @class */ (function (_super) {
900
1145
  if (requestParameters === void 0) { requestParameters = {}; }
901
1146
  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); });
902
1147
  };
1148
+ /**
1149
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1150
+ * @summary List scheduled commission clawback triggers
1151
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1152
+ * @param {*} [options] Override http request option.
1153
+ * @throws {RequiredError}
1154
+ * @memberof CommissionsApi
1155
+ */
1156
+ CommissionsApi.prototype.listScheduledCommissionClawbackTriggers = function (requestParameters, options) {
1157
+ var _this = this;
1158
+ if (requestParameters === void 0) { requestParameters = {}; }
1159
+ 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); });
1160
+ };
903
1161
  /**
904
1162
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
905
1163
  * @summary Create the due commission clawbacks trigger
@@ -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 });
@@ -17,20 +17,26 @@
17
17
  export interface ClawbackConfigDto {
18
18
  /**
19
19
  * Allow manual commission clawback creation.
20
- * @type {object}
20
+ * @type {boolean}
21
21
  * @memberof ClawbackConfigDto
22
22
  */
23
- 'manual': object;
23
+ 'manual': boolean;
24
24
  /**
25
25
  * Allow automatic commission clawback creation for policy termination and withdrawal.
26
- * @type {object}
26
+ * @type {boolean}
27
27
  * @memberof ClawbackConfigDto
28
28
  */
29
- 'policyCancellation': object;
29
+ 'policyCancellation': boolean;
30
30
  /**
31
31
  * Allow automatic commission clawback creation for intermediary switches.
32
- * @type {object}
32
+ * @type {boolean}
33
33
  * @memberof ClawbackConfigDto
34
34
  */
35
- 'intermediarySwitched': object;
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 { ClawbackConfigDto } from './clawback-config-dto';
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 {ClawbackConfigDto}
64
+ * Version-scoped agreement configuration.
65
+ * @type {CommissionAgreementVersionConfigClass}
66
66
  * @memberof CommissionAgreementVersionClass
67
67
  */
68
- 'clawbackConfig': ClawbackConfigDto;
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
  };