@emilgroup/commission-sdk 2.10.0 → 2.10.1-beta.0

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 (29) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-versions-api.ts +12 -12
  4. package/api/commission-settlements-api.ts +107 -0
  5. package/api/commissions-api.ts +13 -13
  6. package/dist/api/commission-agreement-versions-api.d.ts +12 -12
  7. package/dist/api/commission-agreement-versions-api.js +9 -9
  8. package/dist/api/commission-settlements-api.d.ts +57 -0
  9. package/dist/api/commission-settlements-api.js +93 -0
  10. package/dist/api/commissions-api.d.ts +13 -13
  11. package/dist/api/commissions-api.js +6 -6
  12. package/dist/models/commission-agreement-version-class.d.ts +6 -0
  13. package/dist/models/commission-class.d.ts +6 -0
  14. package/dist/models/create-commission-agreement-request-dto.d.ts +6 -0
  15. package/dist/models/create-commission-agreement-version-request-dto.d.ts +6 -0
  16. package/dist/models/index.d.ts +2 -0
  17. package/dist/models/index.js +2 -0
  18. package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
  19. package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
  20. package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
  21. package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
  22. package/models/commission-agreement-version-class.ts +6 -0
  23. package/models/commission-class.ts +6 -0
  24. package/models/create-commission-agreement-request-dto.ts +6 -0
  25. package/models/create-commission-agreement-version-request-dto.ts +6 -0
  26. package/models/index.ts +2 -0
  27. package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
  28. package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
  29. package/package.json +1 -1
@@ -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
@@ -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
@@ -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
@@ -68,15 +68,15 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
68
68
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
69
69
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
70
  * @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.
71
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
71
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
72
72
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
73
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
73
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
74
74
  * @param {'items' | 'agreement'} [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.
75
75
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
76
76
  * @param {*} [options] Override http request option.
77
77
  * @throws {RequiredError}
78
78
  */
79
- listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
80
  /**
81
81
  * This will update commission.
82
82
  * @summary Update the commission
@@ -136,15 +136,15 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
136
136
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
137
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
138
138
  * @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.
139
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
139
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
140
140
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
141
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
141
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
142
142
  * @param {'items' | 'agreement'} [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.
143
143
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
144
144
  * @param {*} [options] Override http request option.
145
145
  * @throws {RequiredError}
146
146
  */
147
- listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
147
+ listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
148
148
  /**
149
149
  * This will update commission.
150
150
  * @summary Update the commission
@@ -204,15 +204,15 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
204
204
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
205
205
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
206
206
  * @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.
207
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
207
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
208
208
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
209
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
209
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
210
210
  * @param {'items' | 'agreement'} [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.
211
211
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
212
212
  * @param {*} [options] Override http request option.
213
213
  * @throws {RequiredError}
214
214
  */
215
- listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
215
+ listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
216
216
  /**
217
217
  * This will update commission.
218
218
  * @summary Update the commission
@@ -332,10 +332,10 @@ export interface CommissionsApiListCommissionsRequest {
332
332
  readonly pageToken?: string;
333
333
  /**
334
334
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
335
- * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'}
335
+ * @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'}
336
336
  * @memberof CommissionsApiListCommissions
337
337
  */
338
- readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode';
338
+ readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode';
339
339
  /**
340
340
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
341
341
  * @type {string}
@@ -344,10 +344,10 @@ export interface CommissionsApiListCommissionsRequest {
344
344
  readonly search?: string;
345
345
  /**
346
346
  * 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.
347
- * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
347
+ * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
348
348
  * @memberof CommissionsApiListCommissions
349
349
  */
350
- readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
350
+ readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
351
351
  /**
352
352
  * 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.
353
353
  * @type {'items' | 'agreement'}
@@ -298,9 +298,9 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
298
298
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
299
299
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
300
300
  * @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.
301
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
301
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
302
302
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
303
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
303
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
304
304
  * @param {'items' | 'agreement'} [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.
305
305
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
306
306
  * @param {*} [options] Override http request option.
@@ -518,9 +518,9 @@ var CommissionsApiFp = function (configuration) {
518
518
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
519
519
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
520
520
  * @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.
521
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
521
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
522
522
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
523
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
523
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
524
524
  * @param {'items' | 'agreement'} [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.
525
525
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
526
526
  * @param {*} [options] Override http request option.
@@ -622,9 +622,9 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
622
622
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
623
623
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
624
624
  * @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.
625
- * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
625
+ * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
626
626
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
627
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
627
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
628
628
  * @param {'items' | 'agreement'} [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.
629
629
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
630
630
  * @param {*} [options] Override http request option.
@@ -53,6 +53,12 @@ export interface CommissionAgreementVersionClass {
53
53
  * @memberof CommissionAgreementVersionClass
54
54
  */
55
55
  'endDate'?: string;
56
+ /**
57
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
58
+ * @type {string}
59
+ * @memberof CommissionAgreementVersionClass
60
+ */
61
+ 'settlementCreationDate'?: string;
56
62
  /**
57
63
  * Description explaining what changed in this version or version notes
58
64
  * @type {string}
@@ -95,6 +95,12 @@ export interface CommissionClass {
95
95
  * @memberof CommissionClass
96
96
  */
97
97
  'status': string;
98
+ /**
99
+ * The latest date when the commission became open.
100
+ * @type {string}
101
+ * @memberof CommissionClass
102
+ */
103
+ 'openedAt'?: string;
98
104
  /**
99
105
  * The code of the settlement this commission is associated with
100
106
  * @type {string}
@@ -64,6 +64,12 @@ export interface CreateCommissionAgreementRequestDto {
64
64
  * @memberof CreateCommissionAgreementRequestDto
65
65
  */
66
66
  'endDate'?: string;
67
+ /**
68
+ * Date when commission settlement creation should start for this agreement. Treated as a date-only schedule value.
69
+ * @type {string}
70
+ * @memberof CreateCommissionAgreementRequestDto
71
+ */
72
+ 'settlementCreationDate'?: string;
67
73
  }
68
74
  export declare const CreateCommissionAgreementRequestDtoBillingFrequencyEnum: {
69
75
  readonly Immediately: "immediately";
@@ -33,6 +33,12 @@ export interface CreateCommissionAgreementVersionRequestDto {
33
33
  * @memberof CreateCommissionAgreementVersionRequestDto
34
34
  */
35
35
  'endDate'?: string;
36
+ /**
37
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
38
+ * @type {string}
39
+ * @memberof CreateCommissionAgreementVersionRequestDto
40
+ */
41
+ 'settlementCreationDate'?: string;
36
42
  /**
37
43
  * Description explaining what changed in this version or version notes
38
44
  * @type {string}
@@ -61,6 +61,8 @@ export * from './patch-commission-agreement-status-request-dto';
61
61
  export * from './patch-commission-agreement-status-response-class';
62
62
  export * from './publish-commission-settlements-request-dto';
63
63
  export * from './publish-commission-settlements-response-class';
64
+ export * from './trigger-commission-settlement-creation-request-dto';
65
+ export * from './trigger-commission-settlement-creation-response-class';
64
66
  export * from './update-commission-agreement-product-request-dto';
65
67
  export * from './update-commission-agreement-product-response-class';
66
68
  export * from './update-commission-agreement-request-dto';
@@ -77,6 +77,8 @@ __exportStar(require("./patch-commission-agreement-status-request-dto"), exports
77
77
  __exportStar(require("./patch-commission-agreement-status-response-class"), exports);
78
78
  __exportStar(require("./publish-commission-settlements-request-dto"), exports);
79
79
  __exportStar(require("./publish-commission-settlements-response-class"), exports);
80
+ __exportStar(require("./trigger-commission-settlement-creation-request-dto"), exports);
81
+ __exportStar(require("./trigger-commission-settlement-creation-response-class"), exports);
80
82
  __exportStar(require("./update-commission-agreement-product-request-dto"), exports);
81
83
  __exportStar(require("./update-commission-agreement-product-response-class"), exports);
82
84
  __exportStar(require("./update-commission-agreement-request-dto"), exports);
@@ -0,0 +1,30 @@
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 TriggerCommissionSettlementCreationRequestDto
16
+ */
17
+ export interface TriggerCommissionSettlementCreationRequestDto {
18
+ /**
19
+ * Optional business execution timestamp used to evaluate the due date. The settlement window ends at the start of that due date. Defaults to the current timestamp when omitted.
20
+ * @type {string}
21
+ * @memberof TriggerCommissionSettlementCreationRequestDto
22
+ */
23
+ 'executionDate'?: string;
24
+ /**
25
+ * When true, validates and logs what would be processed without creating settlements.
26
+ * @type {boolean}
27
+ * @memberof TriggerCommissionSettlementCreationRequestDto
28
+ */
29
+ 'dryRun'?: boolean;
30
+ }
@@ -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,24 @@
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 TriggerCommissionSettlementCreationResponseClass
16
+ */
17
+ export interface TriggerCommissionSettlementCreationResponseClass {
18
+ /**
19
+ * Indicates that the commission settlement creation job was triggered.
20
+ * @type {boolean}
21
+ * @memberof TriggerCommissionSettlementCreationResponseClass
22
+ */
23
+ 'success': boolean;
24
+ }
@@ -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 });
@@ -58,6 +58,12 @@ export interface CommissionAgreementVersionClass {
58
58
  * @memberof CommissionAgreementVersionClass
59
59
  */
60
60
  'endDate'?: string;
61
+ /**
62
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
63
+ * @type {string}
64
+ * @memberof CommissionAgreementVersionClass
65
+ */
66
+ 'settlementCreationDate'?: string;
61
67
  /**
62
68
  * Description explaining what changed in this version or version notes
63
69
  * @type {string}
@@ -100,6 +100,12 @@ export interface CommissionClass {
100
100
  * @memberof CommissionClass
101
101
  */
102
102
  'status': string;
103
+ /**
104
+ * The latest date when the commission became open.
105
+ * @type {string}
106
+ * @memberof CommissionClass
107
+ */
108
+ 'openedAt'?: string;
103
109
  /**
104
110
  * The code of the settlement this commission is associated with
105
111
  * @type {string}
@@ -69,6 +69,12 @@ export interface CreateCommissionAgreementRequestDto {
69
69
  * @memberof CreateCommissionAgreementRequestDto
70
70
  */
71
71
  'endDate'?: string;
72
+ /**
73
+ * Date when commission settlement creation should start for this agreement. Treated as a date-only schedule value.
74
+ * @type {string}
75
+ * @memberof CreateCommissionAgreementRequestDto
76
+ */
77
+ 'settlementCreationDate'?: string;
72
78
  }
73
79
 
74
80
  export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
@@ -38,6 +38,12 @@ export interface CreateCommissionAgreementVersionRequestDto {
38
38
  * @memberof CreateCommissionAgreementVersionRequestDto
39
39
  */
40
40
  'endDate'?: string;
41
+ /**
42
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
43
+ * @type {string}
44
+ * @memberof CreateCommissionAgreementVersionRequestDto
45
+ */
46
+ 'settlementCreationDate'?: string;
41
47
  /**
42
48
  * Description explaining what changed in this version or version notes
43
49
  * @type {string}
package/models/index.ts CHANGED
@@ -61,6 +61,8 @@ export * from './patch-commission-agreement-status-request-dto';
61
61
  export * from './patch-commission-agreement-status-response-class';
62
62
  export * from './publish-commission-settlements-request-dto';
63
63
  export * from './publish-commission-settlements-response-class';
64
+ export * from './trigger-commission-settlement-creation-request-dto';
65
+ export * from './trigger-commission-settlement-creation-response-class';
64
66
  export * from './update-commission-agreement-product-request-dto';
65
67
  export * from './update-commission-agreement-product-response-class';
66
68
  export * from './update-commission-agreement-request-dto';
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface TriggerCommissionSettlementCreationRequestDto
21
+ */
22
+ export interface TriggerCommissionSettlementCreationRequestDto {
23
+ /**
24
+ * Optional business execution timestamp used to evaluate the due date. The settlement window ends at the start of that due date. Defaults to the current timestamp when omitted.
25
+ * @type {string}
26
+ * @memberof TriggerCommissionSettlementCreationRequestDto
27
+ */
28
+ 'executionDate'?: string;
29
+ /**
30
+ * When true, validates and logs what would be processed without creating settlements.
31
+ * @type {boolean}
32
+ * @memberof TriggerCommissionSettlementCreationRequestDto
33
+ */
34
+ 'dryRun'?: boolean;
35
+ }
36
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface TriggerCommissionSettlementCreationResponseClass
21
+ */
22
+ export interface TriggerCommissionSettlementCreationResponseClass {
23
+ /**
24
+ * Indicates that the commission settlement creation job was triggered.
25
+ * @type {boolean}
26
+ * @memberof TriggerCommissionSettlementCreationResponseClass
27
+ */
28
+ 'success': boolean;
29
+ }
30
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/commission-sdk",
3
- "version": "2.10.0",
3
+ "version": "2.10.1-beta.0",
4
4
  "description": "OpenAPI client for @emilgroup/commission-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [