@emilgroup/commission-sdk 2.10.1-beta.5 → 2.10.1-beta.51

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 (113) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-rules-api.ts +20 -6
  4. package/api/commission-agreement-versions-api.ts +12 -12
  5. package/api/commission-settlements-api.ts +115 -8
  6. package/api/commissions-api.ts +616 -13
  7. package/dist/api/commission-agreement-rules-api.d.ts +12 -3
  8. package/dist/api/commission-agreement-rules-api.js +12 -6
  9. package/dist/api/commission-agreement-versions-api.d.ts +12 -12
  10. package/dist/api/commission-agreement-versions-api.js +9 -9
  11. package/dist/api/commission-settlements-api.d.ts +65 -8
  12. package/dist/api/commission-settlements-api.js +96 -3
  13. package/dist/api/commissions-api.d.ts +356 -13
  14. package/dist/api/commissions-api.js +456 -6
  15. package/dist/models/clawback-config-class.d.ts +42 -0
  16. package/dist/models/clawback-config-class.js +15 -0
  17. package/dist/models/clawback-config-dto.d.ts +42 -0
  18. package/dist/models/clawback-config-dto.js +15 -0
  19. package/dist/models/commission-agreement-version-class.d.ts +13 -0
  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-candidate-class.d.ts +12 -0
  25. package/dist/models/commission-class.d.ts +56 -0
  26. package/dist/models/commission-class.js +8 -0
  27. package/dist/models/commission-config-dto.d.ts +2 -1
  28. package/dist/models/commission-config-dto.js +2 -1
  29. package/dist/models/commission-creation-config-class.d.ts +43 -0
  30. package/dist/models/commission-creation-config-class.js +20 -0
  31. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  32. package/dist/models/commission-creation-config-dto.js +20 -0
  33. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  34. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  35. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  36. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  37. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  38. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  39. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  40. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  41. package/dist/models/commission-estimate-class.d.ts +2 -1
  42. package/dist/models/commission-estimate-class.js +2 -1
  43. package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
  44. package/dist/models/commission-paid-invoice-entry-class.js +22 -0
  45. package/dist/models/create-commission-agreement-request-dto.d.ts +13 -0
  46. package/dist/models/create-commission-agreement-version-request-dto.d.ts +13 -0
  47. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  48. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  49. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  50. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  51. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  52. package/dist/models/create-commission-clawback-response-class.js +21 -0
  53. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  54. package/dist/models/create-commission-item-request-dto.js +2 -1
  55. package/dist/models/create-commission-request-dto.d.ts +6 -0
  56. package/dist/models/evaluated-commission-class.d.ts +2 -1
  57. package/dist/models/evaluated-commission-class.js +2 -1
  58. package/dist/models/index.d.ts +20 -0
  59. package/dist/models/index.js +20 -0
  60. package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
  61. package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
  62. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  63. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  64. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  65. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  66. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  67. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  68. package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
  69. package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
  70. package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
  71. package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
  72. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  73. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  74. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  75. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  76. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  77. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  78. package/models/clawback-config-class.ts +48 -0
  79. package/models/clawback-config-dto.ts +48 -0
  80. package/models/commission-agreement-version-class.ts +13 -0
  81. package/models/commission-agreement-version-config-class.ts +38 -0
  82. package/models/commission-agreement-version-config-dto.ts +38 -0
  83. package/models/commission-candidate-class.ts +12 -0
  84. package/models/commission-class.ts +59 -0
  85. package/models/commission-config-dto.ts +3 -2
  86. package/models/commission-creation-config-class.ts +52 -0
  87. package/models/commission-creation-config-dto.ts +52 -0
  88. package/models/commission-creation-invoice-config-class.ts +30 -0
  89. package/models/commission-creation-invoice-config-dto.ts +30 -0
  90. package/models/commission-creation-renewal-config-class.ts +38 -0
  91. package/models/commission-creation-renewal-config-dto.ts +38 -0
  92. package/models/commission-estimate-class.ts +3 -2
  93. package/models/commission-paid-invoice-entry-class.ts +124 -0
  94. package/models/create-commission-agreement-request-dto.ts +13 -0
  95. package/models/create-commission-agreement-version-request-dto.ts +13 -0
  96. package/models/create-commission-candidate-request-dto.ts +16 -3
  97. package/models/create-commission-clawback-request-dto.ts +30 -0
  98. package/models/create-commission-clawback-response-class.ts +52 -0
  99. package/models/create-commission-item-request-dto.ts +3 -2
  100. package/models/create-commission-request-dto.ts +6 -0
  101. package/models/evaluated-commission-class.ts +3 -2
  102. package/models/index.ts +20 -0
  103. package/models/list-commission-agreement-versions-response-class.ts +10 -10
  104. package/models/list-commission-agreements-response-class.ts +10 -10
  105. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  106. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  107. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  108. package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
  109. package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
  110. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  111. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  112. package/models/update-commission-candidate-request-dto.ts +3 -2
  113. package/package.json +1 -1
@@ -67,10 +67,11 @@ export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuratio
67
67
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
68
68
  * @summary Retrieve the commission agreement rule evaluation default data
69
69
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
70
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
70
71
  * @param {*} [options] Override http request option.
71
72
  * @throws {RequiredError}
72
73
  */
73
- getEvaluationDefaultData: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
+ getEvaluationDefaultData: (authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
75
  /**
75
76
  * Retrieves a list of commission agreement rules.
76
77
  * @summary List commission agreement rules
@@ -143,10 +144,11 @@ export declare const CommissionAgreementRulesApiFp: (configuration?: Configurati
143
144
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
144
145
  * @summary Retrieve the commission agreement rule evaluation default data
145
146
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
147
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
146
148
  * @param {*} [options] Override http request option.
147
149
  * @throws {RequiredError}
148
150
  */
149
- getEvaluationDefaultData(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
151
+ getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
150
152
  /**
151
153
  * Retrieves a list of commission agreement rules.
152
154
  * @summary List commission agreement rules
@@ -219,10 +221,11 @@ export declare const CommissionAgreementRulesApiFactory: (configuration?: Config
219
221
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
220
222
  * @summary Retrieve the commission agreement rule evaluation default data
221
223
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
224
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
222
225
  * @param {*} [options] Override http request option.
223
226
  * @throws {RequiredError}
224
227
  */
225
- getEvaluationDefaultData(authorization?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
228
+ getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
226
229
  /**
227
230
  * Retrieves a list of commission agreement rules.
228
231
  * @summary List commission agreement rules
@@ -343,6 +346,12 @@ export interface CommissionAgreementRulesApiGetEvaluationDefaultDataRequest {
343
346
  * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
344
347
  */
345
348
  readonly authorization?: string;
349
+ /**
350
+ * Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
351
+ * @type {string}
352
+ * @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
353
+ */
354
+ readonly commissionAgreementProductCode?: string;
346
355
  }
347
356
  /**
348
357
  * Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.
@@ -296,10 +296,11 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
296
296
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
297
297
  * @summary Retrieve the commission agreement rule evaluation default data
298
298
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
299
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
299
300
  * @param {*} [options] Override http request option.
300
301
  * @throws {RequiredError}
301
302
  */
302
- getEvaluationDefaultData: function (authorization, options) {
303
+ getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
303
304
  if (options === void 0) { options = {}; }
304
305
  return __awaiter(_this, void 0, void 0, function () {
305
306
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -322,6 +323,9 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
322
323
  // authentication bearer required
323
324
  // http bearer authentication required
324
325
  _a.sent();
326
+ if (commissionAgreementProductCode !== undefined) {
327
+ localVarQueryParameter['commissionAgreementProductCode'] = commissionAgreementProductCode;
328
+ }
325
329
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
326
330
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
327
331
  }
@@ -560,15 +564,16 @@ var CommissionAgreementRulesApiFp = function (configuration) {
560
564
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
561
565
  * @summary Retrieve the commission agreement rule evaluation default data
562
566
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
567
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
563
568
  * @param {*} [options] Override http request option.
564
569
  * @throws {RequiredError}
565
570
  */
566
- getEvaluationDefaultData: function (authorization, options) {
571
+ getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
567
572
  return __awaiter(this, void 0, void 0, function () {
568
573
  var localVarAxiosArgs;
569
574
  return __generator(this, function (_a) {
570
575
  switch (_a.label) {
571
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getEvaluationDefaultData(authorization, options)];
576
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options)];
572
577
  case 1:
573
578
  localVarAxiosArgs = _a.sent();
574
579
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -684,11 +689,12 @@ var CommissionAgreementRulesApiFactory = function (configuration, basePath, axio
684
689
  * Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
685
690
  * @summary Retrieve the commission agreement rule evaluation default data
686
691
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
692
+ * @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
687
693
  * @param {*} [options] Override http request option.
688
694
  * @throws {RequiredError}
689
695
  */
690
- getEvaluationDefaultData: function (authorization, options) {
691
- return localVarFp.getEvaluationDefaultData(authorization, options).then(function (request) { return request(axios, basePath); });
696
+ getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
697
+ return localVarFp.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options).then(function (request) { return request(axios, basePath); });
692
698
  },
693
699
  /**
694
700
  * Retrieves a list of commission agreement rules.
@@ -792,7 +798,7 @@ var CommissionAgreementRulesApi = /** @class */ (function (_super) {
792
798
  CommissionAgreementRulesApi.prototype.getEvaluationDefaultData = function (requestParameters, options) {
793
799
  var _this = this;
794
800
  if (requestParameters === void 0) { requestParameters = {}; }
795
- return (0, exports.CommissionAgreementRulesApiFp)(this.configuration).getEvaluationDefaultData(requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
801
+ return (0, exports.CommissionAgreementRulesApiFp)(this.configuration).getEvaluationDefaultData(requestParameters.authorization, requestParameters.commissionAgreementProductCode, options).then(function (request) { return request(_this.axios, _this.basePath); });
796
802
  };
797
803
  /**
798
804
  * Retrieves a list of commission agreement rules.
@@ -55,11 +55,11 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
55
55
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
56
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
57
57
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
58
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
58
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
59
59
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
60
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
60
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
61
61
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
62
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
62
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
63
63
  * @param {*} [options] Override http request option.
64
64
  * @throws {RequiredError}
65
65
  */
@@ -104,11 +104,11 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
104
104
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
105
105
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
106
106
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
107
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
107
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
108
108
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
109
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
109
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
110
110
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
111
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
111
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
112
112
  * @param {*} [options] Override http request option.
113
113
  * @throws {RequiredError}
114
114
  */
@@ -153,11 +153,11 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
153
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
154
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
155
155
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
156
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
156
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
157
157
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
158
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
158
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
159
159
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
160
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
160
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
161
161
  * @param {*} [options] Override http request option.
162
162
  * @throws {RequiredError}
163
163
  */
@@ -251,7 +251,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
251
251
  */
252
252
  readonly pageToken?: string;
253
253
  /**
254
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
254
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
255
255
  * @type {string}
256
256
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
257
257
  */
@@ -263,7 +263,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
263
263
  */
264
264
  readonly search?: string;
265
265
  /**
266
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
266
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
267
267
  * @type {string}
268
268
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
269
269
  */
@@ -275,7 +275,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
275
275
  */
276
276
  readonly expand?: string;
277
277
  /**
278
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
278
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
279
279
  * @type {string}
280
280
  * @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
281
281
  */
@@ -249,11 +249,11 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
249
249
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
250
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
251
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
252
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
252
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
253
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
254
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
255
255
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
256
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
256
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
257
257
  * @param {*} [options] Override http request option.
258
258
  * @throws {RequiredError}
259
259
  */
@@ -395,11 +395,11 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
395
395
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
396
396
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
397
397
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
398
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
398
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
399
399
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
400
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
400
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
401
401
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
402
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
402
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
403
403
  * @param {*} [options] Override http request option.
404
404
  * @throws {RequiredError}
405
405
  */
@@ -466,11 +466,11 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
466
466
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
467
467
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
468
468
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
469
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
469
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
470
470
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
471
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate&lt;/i&gt;
471
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, startDate, endDate, settlementCreationDate&lt;/i&gt;
472
472
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: agreements&lt;i&gt;
473
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, createdAt&lt;/i&gt;
473
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, agreementCode, startDate, endDate, settlementCreationDate, createdAt&lt;/i&gt;
474
474
  * @param {*} [options] Override http request option.
475
475
  * @throws {RequiredError}
476
476
  */
@@ -18,6 +18,8 @@ import { GetCommissionSettlementResponseClass } from '../models';
18
18
  import { ListCommissionSettlementsResponseClass } from '../models';
19
19
  import { PublishCommissionSettlementsRequestDto } from '../models';
20
20
  import { PublishCommissionSettlementsResponseClass } from '../models';
21
+ import { TriggerCommissionSettlementCreationRequestDto } from '../models';
22
+ import { TriggerCommissionSettlementCreationResponseClass } from '../models';
21
23
  import { UpdateCommissionSettlementRequestDto } from '../models';
22
24
  import { UpdateCommissionSettlementResponseClass } from '../models';
23
25
  /**
@@ -59,7 +61,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
59
61
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
60
62
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
61
63
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
62
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
64
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
63
65
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
64
66
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
65
67
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -67,7 +69,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
67
69
  * @param {*} [options] Override http request option.
68
70
  * @throws {RequiredError}
69
71
  */
70
- listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
72
+ listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
71
73
  /**
72
74
  * This will publish multiple commission settlements.
73
75
  * @summary Create the commission settlement publish
@@ -77,6 +79,15 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
77
79
  * @throws {RequiredError}
78
80
  */
79
81
  publishCommissionSettlements: (publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ * Triggers the commission settlement creation job.
84
+ * @summary Create the commission settlement creation job
85
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
86
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ triggerCommissionSettlementCreation: (triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
91
  /**
81
92
  * This will update commission settlement.
82
93
  * @summary Update the commission settlement
@@ -127,7 +138,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
127
138
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
128
139
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
129
140
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
130
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
141
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
131
142
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
132
143
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
133
144
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -135,7 +146,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
135
146
  * @param {*} [options] Override http request option.
136
147
  * @throws {RequiredError}
137
148
  */
138
- listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
149
+ listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
139
150
  /**
140
151
  * This will publish multiple commission settlements.
141
152
  * @summary Create the commission settlement publish
@@ -145,6 +156,15 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
145
156
  * @throws {RequiredError}
146
157
  */
147
158
  publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublishCommissionSettlementsResponseClass>>;
159
+ /**
160
+ * Triggers the commission settlement creation job.
161
+ * @summary Create the commission settlement creation job
162
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
163
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ */
167
+ triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerCommissionSettlementCreationResponseClass>>;
148
168
  /**
149
169
  * This will update commission settlement.
150
170
  * @summary Update the commission settlement
@@ -195,7 +215,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
195
215
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
196
216
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
197
217
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
198
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
218
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
199
219
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
200
220
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
201
221
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -203,7 +223,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
203
223
  * @param {*} [options] Override http request option.
204
224
  * @throws {RequiredError}
205
225
  */
206
- listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
226
+ listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
207
227
  /**
208
228
  * This will publish multiple commission settlements.
209
229
  * @summary Create the commission settlement publish
@@ -213,6 +233,15 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
213
233
  * @throws {RequiredError}
214
234
  */
215
235
  publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass>;
236
+ /**
237
+ * Triggers the commission settlement creation job.
238
+ * @summary Create the commission settlement creation job
239
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
240
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
241
+ * @param {*} [options] Override http request option.
242
+ * @throws {RequiredError}
243
+ */
244
+ triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerCommissionSettlementCreationResponseClass>;
216
245
  /**
217
246
  * This will update commission settlement.
218
247
  * @summary Update the commission settlement
@@ -313,10 +342,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
313
342
  readonly pageToken?: string;
314
343
  /**
315
344
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
316
- * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
345
+ * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
317
346
  * @memberof CommissionSettlementsApiListCommissionSettlements
318
347
  */
319
- readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
348
+ readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode';
320
349
  /**
321
350
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
322
351
  * @type {string}
@@ -361,6 +390,25 @@ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
361
390
  */
362
391
  readonly authorization?: string;
363
392
  }
393
+ /**
394
+ * Request parameters for triggerCommissionSettlementCreation operation in CommissionSettlementsApi.
395
+ * @export
396
+ * @interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest
397
+ */
398
+ export interface CommissionSettlementsApiTriggerCommissionSettlementCreationRequest {
399
+ /**
400
+ *
401
+ * @type {TriggerCommissionSettlementCreationRequestDto}
402
+ * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
403
+ */
404
+ readonly triggerCommissionSettlementCreationRequestDto: TriggerCommissionSettlementCreationRequestDto;
405
+ /**
406
+ * Bearer Token: provided by the login endpoint under the name accessToken.
407
+ * @type {string}
408
+ * @memberof CommissionSettlementsApiTriggerCommissionSettlementCreation
409
+ */
410
+ readonly authorization?: string;
411
+ }
364
412
  /**
365
413
  * Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
366
414
  * @export
@@ -438,6 +486,15 @@ export declare class CommissionSettlementsApi extends BaseAPI {
438
486
  * @memberof CommissionSettlementsApi
439
487
  */
440
488
  publishCommissionSettlements(requestParameters: CommissionSettlementsApiPublishCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublishCommissionSettlementsResponseClass, any, {}>>;
489
+ /**
490
+ * Triggers the commission settlement creation job.
491
+ * @summary Create the commission settlement creation job
492
+ * @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
493
+ * @param {*} [options] Override http request option.
494
+ * @throws {RequiredError}
495
+ * @memberof CommissionSettlementsApi
496
+ */
497
+ triggerCommissionSettlementCreation(requestParameters: CommissionSettlementsApiTriggerCommissionSettlementCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerCommissionSettlementCreationResponseClass, any, {}>>;
441
498
  /**
442
499
  * This will update commission settlement.
443
500
  * @summary Update the commission settlement
@@ -249,7 +249,7 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
249
249
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
250
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
251
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
252
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
253
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
254
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
255
255
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -364,6 +364,55 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
364
364
  });
365
365
  });
366
366
  },
367
+ /**
368
+ * Triggers the commission settlement creation job.
369
+ * @summary Create the commission settlement creation job
370
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
371
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
372
+ * @param {*} [options] Override http request option.
373
+ * @throws {RequiredError}
374
+ */
375
+ triggerCommissionSettlementCreation: function (triggerCommissionSettlementCreationRequestDto, authorization, options) {
376
+ if (options === void 0) { options = {}; }
377
+ return __awaiter(_this, void 0, void 0, function () {
378
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
379
+ return __generator(this, function (_a) {
380
+ switch (_a.label) {
381
+ case 0:
382
+ // verify required parameter 'triggerCommissionSettlementCreationRequestDto' is not null or undefined
383
+ (0, common_1.assertParamExists)('triggerCommissionSettlementCreation', 'triggerCommissionSettlementCreationRequestDto', triggerCommissionSettlementCreationRequestDto);
384
+ localVarPath = "/commissionservice/v1/commission-settlements/commission-settlement-creation/trigger";
385
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
386
+ if (configuration) {
387
+ baseOptions = configuration.baseOptions;
388
+ baseAccessToken = configuration.accessToken;
389
+ }
390
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
391
+ localVarHeaderParameter = {};
392
+ localVarQueryParameter = {};
393
+ // authentication bearer required
394
+ // http bearer authentication required
395
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
396
+ case 1:
397
+ // authentication bearer required
398
+ // http bearer authentication required
399
+ _a.sent();
400
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
401
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
402
+ }
403
+ localVarHeaderParameter['Content-Type'] = 'application/json';
404
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
405
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
406
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
407
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(triggerCommissionSettlementCreationRequestDto, localVarRequestOptions, configuration);
408
+ return [2 /*return*/, {
409
+ url: (0, common_1.toPathString)(localVarUrlObj),
410
+ options: localVarRequestOptions,
411
+ }];
412
+ }
413
+ });
414
+ });
415
+ },
367
416
  /**
368
417
  * This will update commission settlement.
369
418
  * @summary Update the commission settlement
@@ -497,7 +546,7 @@ var CommissionSettlementsApiFp = function (configuration) {
497
546
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
498
547
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
499
548
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
500
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
549
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
501
550
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
502
551
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
503
552
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -539,6 +588,27 @@ var CommissionSettlementsApiFp = function (configuration) {
539
588
  });
540
589
  });
541
590
  },
591
+ /**
592
+ * Triggers the commission settlement creation job.
593
+ * @summary Create the commission settlement creation job
594
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
595
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
596
+ * @param {*} [options] Override http request option.
597
+ * @throws {RequiredError}
598
+ */
599
+ triggerCommissionSettlementCreation: function (triggerCommissionSettlementCreationRequestDto, authorization, options) {
600
+ return __awaiter(this, void 0, void 0, function () {
601
+ var localVarAxiosArgs;
602
+ return __generator(this, function (_a) {
603
+ switch (_a.label) {
604
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options)];
605
+ case 1:
606
+ localVarAxiosArgs = _a.sent();
607
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
608
+ }
609
+ });
610
+ });
611
+ },
542
612
  /**
543
613
  * This will update commission settlement.
544
614
  * @summary Update the commission settlement
@@ -611,7 +681,7 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
611
681
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
612
682
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
613
683
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
614
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
684
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
615
685
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
616
686
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
617
687
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -633,6 +703,17 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
633
703
  publishCommissionSettlements: function (publishCommissionSettlementsRequestDto, authorization, options) {
634
704
  return localVarFp.publishCommissionSettlements(publishCommissionSettlementsRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
635
705
  },
706
+ /**
707
+ * Triggers the commission settlement creation job.
708
+ * @summary Create the commission settlement creation job
709
+ * @param {TriggerCommissionSettlementCreationRequestDto} triggerCommissionSettlementCreationRequestDto
710
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
711
+ * @param {*} [options] Override http request option.
712
+ * @throws {RequiredError}
713
+ */
714
+ triggerCommissionSettlementCreation: function (triggerCommissionSettlementCreationRequestDto, authorization, options) {
715
+ return localVarFp.triggerCommissionSettlementCreation(triggerCommissionSettlementCreationRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
716
+ },
636
717
  /**
637
718
  * This will update commission settlement.
638
719
  * @summary Update the commission settlement
@@ -720,6 +801,18 @@ var CommissionSettlementsApi = /** @class */ (function (_super) {
720
801
  var _this = this;
721
802
  return (0, exports.CommissionSettlementsApiFp)(this.configuration).publishCommissionSettlements(requestParameters.publishCommissionSettlementsRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
722
803
  };
804
+ /**
805
+ * Triggers the commission settlement creation job.
806
+ * @summary Create the commission settlement creation job
807
+ * @param {CommissionSettlementsApiTriggerCommissionSettlementCreationRequest} requestParameters Request parameters.
808
+ * @param {*} [options] Override http request option.
809
+ * @throws {RequiredError}
810
+ * @memberof CommissionSettlementsApi
811
+ */
812
+ CommissionSettlementsApi.prototype.triggerCommissionSettlementCreation = function (requestParameters, options) {
813
+ var _this = this;
814
+ return (0, exports.CommissionSettlementsApiFp)(this.configuration).triggerCommissionSettlementCreation(requestParameters.triggerCommissionSettlementCreationRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
815
+ };
723
816
  /**
724
817
  * This will update commission settlement.
725
818
  * @summary Update the commission settlement