@emilgroup/commission-sdk-node 2.9.1-beta.10 → 2.9.1-beta.12

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.
@@ -81,10 +81,12 @@ models/list-commission-candidates-response-class.ts
81
81
  models/list-commission-recipients-response-class.ts
82
82
  models/list-commission-settlements-response-class.ts
83
83
  models/list-commissions-response-class.ts
84
+ models/list-scheduled-commission-clawback-triggers-response-class.ts
84
85
  models/patch-commission-agreement-status-request-dto.ts
85
86
  models/patch-commission-agreement-status-response-class.ts
86
87
  models/publish-commission-settlements-request-dto.ts
87
88
  models/publish-commission-settlements-response-class.ts
89
+ models/scheduled-commission-clawback-trigger-class.ts
88
90
  models/trigger-commission-settlement-creation-request-dto.ts
89
91
  models/trigger-commission-settlement-creation-response-class.ts
90
92
  models/trigger-due-commission-clawbacks-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/commission-sdk-node@2.9.1-beta.10 --save
20
+ npm install @emilgroup/commission-sdk-node@2.9.1-beta.12 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk-node@2.9.1-beta.10
24
+ yarn add @emilgroup/commission-sdk-node@2.9.1-beta.12
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -37,6 +37,8 @@ import { GetCommissionResponseClass } from '../models';
37
37
  // @ts-ignore
38
38
  import { ListCommissionsResponseClass } from '../models';
39
39
  // @ts-ignore
40
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
41
+ // @ts-ignore
40
42
  import { TriggerDueCommissionClawbacksRequestDto } from '../models';
41
43
  // @ts-ignore
42
44
  import { TriggerDueCommissionClawbacksResponseClass } from '../models';
@@ -363,6 +365,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
363
365
 
364
366
 
365
367
 
368
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
369
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
370
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
371
+
372
+ return {
373
+ url: toPathString(localVarUrlObj),
374
+ options: localVarRequestOptions,
375
+ };
376
+ },
377
+ /**
378
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
379
+ * @summary List scheduled commission clawback triggers
380
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
381
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
382
+ * @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.
383
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
384
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
385
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt</i>
386
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
387
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy</i>
388
+ * @param {*} [options] Override http request option.
389
+ * @throws {RequiredError}
390
+ */
391
+ listScheduledCommissionClawbackTriggers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
392
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/scheduled-triggers`;
393
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
394
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
395
+ let baseOptions;
396
+ let baseAccessToken;
397
+ if (configuration) {
398
+ baseOptions = configuration.baseOptions;
399
+ baseAccessToken = configuration.accessToken;
400
+ }
401
+
402
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
403
+ const localVarHeaderParameter = {} as any;
404
+ const localVarQueryParameter = {} as any;
405
+
406
+ // authentication bearer required
407
+ // http bearer authentication required
408
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
409
+
410
+ if (pageSize !== undefined) {
411
+ localVarQueryParameter['pageSize'] = pageSize;
412
+ }
413
+
414
+ if (pageToken !== undefined) {
415
+ localVarQueryParameter['pageToken'] = pageToken;
416
+ }
417
+
418
+ if (filter !== undefined) {
419
+ localVarQueryParameter['filter'] = filter;
420
+ }
421
+
422
+ if (search !== undefined) {
423
+ localVarQueryParameter['search'] = search;
424
+ }
425
+
426
+ if (order !== undefined) {
427
+ localVarQueryParameter['order'] = order;
428
+ }
429
+
430
+ if (expand !== undefined) {
431
+ localVarQueryParameter['expand'] = expand;
432
+ }
433
+
434
+ if (filters !== undefined) {
435
+ localVarQueryParameter['filters'] = filters;
436
+ }
437
+
438
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
439
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
440
+ }
441
+
442
+
443
+
366
444
  setSearchParams(localVarUrlObj, localVarQueryParameter);
367
445
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
368
446
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -560,6 +638,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
560
638
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
561
639
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
562
640
  },
641
+ /**
642
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
643
+ * @summary List scheduled commission clawback triggers
644
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
645
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
646
+ * @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.
647
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
648
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
649
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
650
+ * @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;
651
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
652
+ * @param {*} [options] Override http request option.
653
+ * @throws {RequiredError}
654
+ */
655
+ async listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>> {
656
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
657
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
658
+ },
563
659
  /**
564
660
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
565
661
  * @summary Create the due commission clawbacks trigger
@@ -669,6 +765,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
669
765
  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> {
670
766
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
671
767
  },
768
+ /**
769
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
770
+ * @summary List scheduled commission clawback triggers
771
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
772
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
773
+ * @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.
774
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
775
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
776
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
777
+ * @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;
778
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
779
+ * @param {*} [options] Override http request option.
780
+ * @throws {RequiredError}
781
+ */
782
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass> {
783
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
784
+ },
672
785
  /**
673
786
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
674
787
  * @summary Create the due commission clawbacks trigger
@@ -877,6 +990,69 @@ export interface CommissionsApiListCommissionsRequest {
877
990
  readonly filters?: string
878
991
  }
879
992
 
993
+ /**
994
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
995
+ * @export
996
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
997
+ */
998
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
999
+ /**
1000
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1001
+ * @type {string}
1002
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1003
+ */
1004
+ readonly authorization?: string
1005
+
1006
+ /**
1007
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1008
+ * @type {number}
1009
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1010
+ */
1011
+ readonly pageSize?: number
1012
+
1013
+ /**
1014
+ * 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.
1015
+ * @type {string}
1016
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1017
+ */
1018
+ readonly pageToken?: string
1019
+
1020
+ /**
1021
+ * 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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1022
+ * @type {string}
1023
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1024
+ */
1025
+ readonly filter?: string
1026
+
1027
+ /**
1028
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1029
+ * @type {string}
1030
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1031
+ */
1032
+ readonly search?: string
1033
+
1034
+ /**
1035
+ * 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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
1036
+ * @type {string}
1037
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1038
+ */
1039
+ readonly order?: string
1040
+
1041
+ /**
1042
+ * 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;
1043
+ * @type {string}
1044
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1045
+ */
1046
+ readonly expand?: string
1047
+
1048
+ /**
1049
+ * 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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1050
+ * @type {string}
1051
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1052
+ */
1053
+ readonly filters?: string
1054
+ }
1055
+
880
1056
  /**
881
1057
  * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
882
1058
  * @export
@@ -1005,6 +1181,18 @@ export class CommissionsApi extends BaseAPI {
1005
1181
  return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1006
1182
  }
1007
1183
 
1184
+ /**
1185
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1186
+ * @summary List scheduled commission clawback triggers
1187
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1188
+ * @param {*} [options] Override http request option.
1189
+ * @throws {RequiredError}
1190
+ * @memberof CommissionsApi
1191
+ */
1192
+ public listScheduledCommissionClawbackTriggers(requestParameters: CommissionsApiListScheduledCommissionClawbackTriggersRequest = {}, options?: AxiosRequestConfig) {
1193
+ return CommissionsApiFp(this.configuration).listScheduledCommissionClawbackTriggers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1194
+ }
1195
+
1008
1196
  /**
1009
1197
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
1010
1198
  * @summary Create the due commission clawbacks trigger
@@ -20,6 +20,7 @@ import { EstimateCommissionsRequestDto } from '../models';
20
20
  import { EstimateCommissionsResponseClass } from '../models';
21
21
  import { GetCommissionResponseClass } from '../models';
22
22
  import { ListCommissionsResponseClass } from '../models';
23
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
23
24
  import { TriggerDueCommissionClawbacksRequestDto } from '../models';
24
25
  import { TriggerDueCommissionClawbacksResponseClass } from '../models';
25
26
  import { UpdateCommissionRequestDto } from '../models';
@@ -91,6 +92,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
91
92
  * @throws {RequiredError}
92
93
  */
93
94
  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>;
95
+ /**
96
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
97
+ * @summary List scheduled commission clawback triggers
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
100
+ * @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.
101
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
102
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
103
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
104
+ * @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;
105
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ listScheduledCommissionClawbackTriggers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
94
110
  /**
95
111
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
96
112
  * @summary Create the due commission clawbacks trigger
@@ -178,6 +194,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
178
194
  * @throws {RequiredError}
179
195
  */
180
196
  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>>;
197
+ /**
198
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
199
+ * @summary List scheduled commission clawback triggers
200
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
201
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
202
+ * @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.
203
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
204
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
205
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
206
+ * @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;
207
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
208
+ * @param {*} [options] Override http request option.
209
+ * @throws {RequiredError}
210
+ */
211
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>>;
181
212
  /**
182
213
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
183
214
  * @summary Create the due commission clawbacks trigger
@@ -265,6 +296,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
265
296
  * @throws {RequiredError}
266
297
  */
267
298
  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>;
299
+ /**
300
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
301
+ * @summary List scheduled commission clawback triggers
302
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
303
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
304
+ * @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.
305
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
306
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
307
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
308
+ * @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;
309
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
310
+ * @param {*} [options] Override http request option.
311
+ * @throws {RequiredError}
312
+ */
313
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>;
268
314
  /**
269
315
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
270
316
  * @summary Create the due commission clawbacks trigger
@@ -447,6 +493,61 @@ export interface CommissionsApiListCommissionsRequest {
447
493
  */
448
494
  readonly filters?: string;
449
495
  }
496
+ /**
497
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
498
+ * @export
499
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
500
+ */
501
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
502
+ /**
503
+ * Bearer Token: provided by the login endpoint under the name accessToken.
504
+ * @type {string}
505
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
506
+ */
507
+ readonly authorization?: string;
508
+ /**
509
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
510
+ * @type {number}
511
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
512
+ */
513
+ readonly pageSize?: number;
514
+ /**
515
+ * 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.
516
+ * @type {string}
517
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
518
+ */
519
+ readonly pageToken?: string;
520
+ /**
521
+ * 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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
522
+ * @type {string}
523
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
524
+ */
525
+ readonly filter?: string;
526
+ /**
527
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
528
+ * @type {string}
529
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
530
+ */
531
+ readonly search?: string;
532
+ /**
533
+ * 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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
534
+ * @type {string}
535
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
536
+ */
537
+ readonly order?: string;
538
+ /**
539
+ * 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;
540
+ * @type {string}
541
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
542
+ */
543
+ readonly expand?: string;
544
+ /**
545
+ * 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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
546
+ * @type {string}
547
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
548
+ */
549
+ readonly filters?: string;
550
+ }
450
551
  /**
451
552
  * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
452
553
  * @export
@@ -552,6 +653,15 @@ export declare class CommissionsApi extends BaseAPI {
552
653
  * @memberof CommissionsApi
553
654
  */
554
655
  listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
656
+ /**
657
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
658
+ * @summary List scheduled commission clawback triggers
659
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
660
+ * @param {*} [options] Override http request option.
661
+ * @throws {RequiredError}
662
+ * @memberof CommissionsApi
663
+ */
664
+ listScheduledCommissionClawbackTriggers(requestParameters?: CommissionsApiListScheduledCommissionClawbackTriggersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListScheduledCommissionClawbackTriggersResponseClass, any, {}>>;
555
665
  /**
556
666
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
557
667
  * @summary Create the due commission clawbacks trigger
@@ -421,6 +421,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
421
421
  });
422
422
  });
423
423
  },
424
+ /**
425
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
426
+ * @summary List scheduled commission clawback triggers
427
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
428
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
429
+ * @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.
430
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
431
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
432
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
433
+ * @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;
434
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
435
+ * @param {*} [options] Override http request option.
436
+ * @throws {RequiredError}
437
+ */
438
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
439
+ if (options === void 0) { options = {}; }
440
+ return __awaiter(_this, void 0, void 0, function () {
441
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
442
+ return __generator(this, function (_a) {
443
+ switch (_a.label) {
444
+ case 0:
445
+ localVarPath = "/commissionservice/v1/commissions/clawbacks/scheduled-triggers";
446
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
447
+ if (configuration) {
448
+ baseOptions = configuration.baseOptions;
449
+ baseAccessToken = configuration.accessToken;
450
+ }
451
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
452
+ localVarHeaderParameter = {};
453
+ localVarQueryParameter = {};
454
+ // authentication bearer required
455
+ // http bearer authentication required
456
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
457
+ case 1:
458
+ // authentication bearer required
459
+ // http bearer authentication required
460
+ _a.sent();
461
+ if (pageSize !== undefined) {
462
+ localVarQueryParameter['pageSize'] = pageSize;
463
+ }
464
+ if (pageToken !== undefined) {
465
+ localVarQueryParameter['pageToken'] = pageToken;
466
+ }
467
+ if (filter !== undefined) {
468
+ localVarQueryParameter['filter'] = filter;
469
+ }
470
+ if (search !== undefined) {
471
+ localVarQueryParameter['search'] = search;
472
+ }
473
+ if (order !== undefined) {
474
+ localVarQueryParameter['order'] = order;
475
+ }
476
+ if (expand !== undefined) {
477
+ localVarQueryParameter['expand'] = expand;
478
+ }
479
+ if (filters !== undefined) {
480
+ localVarQueryParameter['filters'] = filters;
481
+ }
482
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
483
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
484
+ }
485
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
486
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
487
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
488
+ return [2 /*return*/, {
489
+ url: (0, common_1.toPathString)(localVarUrlObj),
490
+ options: localVarRequestOptions,
491
+ }];
492
+ }
493
+ });
494
+ });
495
+ },
424
496
  /**
425
497
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
426
498
  * @summary Create the due commission clawbacks trigger
@@ -667,6 +739,33 @@ var CommissionsApiFp = function (configuration) {
667
739
  });
668
740
  });
669
741
  },
742
+ /**
743
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
744
+ * @summary List scheduled commission clawback triggers
745
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
746
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
747
+ * @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.
748
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
749
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
750
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
751
+ * @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;
752
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
753
+ * @param {*} [options] Override http request option.
754
+ * @throws {RequiredError}
755
+ */
756
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
757
+ return __awaiter(this, void 0, void 0, function () {
758
+ var localVarAxiosArgs;
759
+ return __generator(this, function (_a) {
760
+ switch (_a.label) {
761
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
762
+ case 1:
763
+ localVarAxiosArgs = _a.sent();
764
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
765
+ }
766
+ });
767
+ });
768
+ },
670
769
  /**
671
770
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
672
771
  * @summary Create the due commission clawbacks trigger
@@ -794,6 +893,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
794
893
  listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
795
894
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
796
895
  },
896
+ /**
897
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
898
+ * @summary List scheduled commission clawback triggers
899
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
900
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
901
+ * @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.
902
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
903
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
904
+ * @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: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
905
+ * @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;
906
+ * @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, policyCode, triggerType, status, effectiveDate, queuedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
907
+ * @param {*} [options] Override http request option.
908
+ * @throws {RequiredError}
909
+ */
910
+ listScheduledCommissionClawbackTriggers: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
911
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
912
+ },
797
913
  /**
798
914
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
799
915
  * @summary Create the due commission clawbacks trigger
@@ -904,6 +1020,19 @@ var CommissionsApi = /** @class */ (function (_super) {
904
1020
  if (requestParameters === void 0) { requestParameters = {}; }
905
1021
  return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
906
1022
  };
1023
+ /**
1024
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1025
+ * @summary List scheduled commission clawback triggers
1026
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1027
+ * @param {*} [options] Override http request option.
1028
+ * @throws {RequiredError}
1029
+ * @memberof CommissionsApi
1030
+ */
1031
+ CommissionsApi.prototype.listScheduledCommissionClawbackTriggers = function (requestParameters, options) {
1032
+ var _this = this;
1033
+ if (requestParameters === void 0) { requestParameters = {}; }
1034
+ return (0, exports.CommissionsApiFp)(this.configuration).listScheduledCommissionClawbackTriggers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
1035
+ };
907
1036
  /**
908
1037
  * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
909
1038
  * @summary Create the due commission clawbacks trigger
@@ -61,10 +61,12 @@ export * from './list-commission-candidates-response-class';
61
61
  export * from './list-commission-recipients-response-class';
62
62
  export * from './list-commission-settlements-response-class';
63
63
  export * from './list-commissions-response-class';
64
+ export * from './list-scheduled-commission-clawback-triggers-response-class';
64
65
  export * from './patch-commission-agreement-status-request-dto';
65
66
  export * from './patch-commission-agreement-status-response-class';
66
67
  export * from './publish-commission-settlements-request-dto';
67
68
  export * from './publish-commission-settlements-response-class';
69
+ export * from './scheduled-commission-clawback-trigger-class';
68
70
  export * from './trigger-commission-settlement-creation-request-dto';
69
71
  export * from './trigger-commission-settlement-creation-response-class';
70
72
  export * from './trigger-due-commission-clawbacks-request-dto';
@@ -77,10 +77,12 @@ __exportStar(require("./list-commission-candidates-response-class"), exports);
77
77
  __exportStar(require("./list-commission-recipients-response-class"), exports);
78
78
  __exportStar(require("./list-commission-settlements-response-class"), exports);
79
79
  __exportStar(require("./list-commissions-response-class"), exports);
80
+ __exportStar(require("./list-scheduled-commission-clawback-triggers-response-class"), exports);
80
81
  __exportStar(require("./patch-commission-agreement-status-request-dto"), exports);
81
82
  __exportStar(require("./patch-commission-agreement-status-response-class"), exports);
82
83
  __exportStar(require("./publish-commission-settlements-request-dto"), exports);
83
84
  __exportStar(require("./publish-commission-settlements-response-class"), exports);
85
+ __exportStar(require("./scheduled-commission-clawback-trigger-class"), exports);
84
86
  __exportStar(require("./trigger-commission-settlement-creation-request-dto"), exports);
85
87
  __exportStar(require("./trigger-commission-settlement-creation-response-class"), exports);
86
88
  __exportStar(require("./trigger-due-commission-clawbacks-request-dto"), exports);
@@ -0,0 +1,43 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ScheduledCommissionClawbackTriggerClass } from './scheduled-commission-clawback-trigger-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListScheduledCommissionClawbackTriggersResponseClass
17
+ */
18
+ export interface ListScheduledCommissionClawbackTriggersResponseClass {
19
+ /**
20
+ * The list of scheduled commission clawback triggerss.
21
+ * @type {Array<ScheduledCommissionClawbackTriggerClass>}
22
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
23
+ */
24
+ 'items': Array<ScheduledCommissionClawbackTriggerClass>;
25
+ /**
26
+ * Next page token.
27
+ * @type {string}
28
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
29
+ */
30
+ 'nextPageToken': string;
31
+ /**
32
+ * Items per page.
33
+ * @type {number}
34
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
35
+ */
36
+ 'itemsPerPage': number;
37
+ /**
38
+ * Total amount of items.
39
+ * @type {number}
40
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
41
+ */
42
+ 'totalItems': number;
43
+ }
@@ -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,109 @@
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 ScheduledCommissionClawbackTriggerClass
16
+ */
17
+ export interface ScheduledCommissionClawbackTriggerClass {
18
+ /**
19
+ * The unique database identifier of the scheduled trigger
20
+ * @type {number}
21
+ * @memberof ScheduledCommissionClawbackTriggerClass
22
+ */
23
+ 'id': number;
24
+ /**
25
+ * Unique identifier for the object.
26
+ * @type {string}
27
+ * @memberof ScheduledCommissionClawbackTriggerClass
28
+ */
29
+ 'code': string;
30
+ /**
31
+ * The policy this scheduled clawback trigger belongs to
32
+ * @type {string}
33
+ * @memberof ScheduledCommissionClawbackTriggerClass
34
+ */
35
+ 'policyCode': string;
36
+ /**
37
+ * The automatic clawback trigger type
38
+ * @type {string}
39
+ * @memberof ScheduledCommissionClawbackTriggerClass
40
+ */
41
+ 'triggerType': ScheduledCommissionClawbackTriggerClassTriggerTypeEnum;
42
+ /**
43
+ * The effective date when the scheduled clawback trigger becomes due
44
+ * @type {string}
45
+ * @memberof ScheduledCommissionClawbackTriggerClass
46
+ */
47
+ 'effectiveDate': string;
48
+ /**
49
+ * The current scheduled trigger status
50
+ * @type {string}
51
+ * @memberof ScheduledCommissionClawbackTriggerClass
52
+ */
53
+ 'status': ScheduledCommissionClawbackTriggerClassStatusEnum;
54
+ /**
55
+ * The time when the due job queued this trigger for processing
56
+ * @type {string}
57
+ * @memberof ScheduledCommissionClawbackTriggerClass
58
+ */
59
+ 'queuedAt'?: string;
60
+ /**
61
+ * Failure reason when processing this scheduled trigger failed
62
+ * @type {string}
63
+ * @memberof ScheduledCommissionClawbackTriggerClass
64
+ */
65
+ 'errorMessage'?: string;
66
+ /**
67
+ * The time when this scheduled trigger was canceled
68
+ * @type {string}
69
+ * @memberof ScheduledCommissionClawbackTriggerClass
70
+ */
71
+ 'canceledAt'?: string;
72
+ /**
73
+ * Time at which the object was created.
74
+ * @type {string}
75
+ * @memberof ScheduledCommissionClawbackTriggerClass
76
+ */
77
+ 'createdAt': string;
78
+ /**
79
+ * Time at which the object was updated.
80
+ * @type {string}
81
+ * @memberof ScheduledCommissionClawbackTriggerClass
82
+ */
83
+ 'updatedAt': string;
84
+ /**
85
+ * Identifier of the user who created the record.
86
+ * @type {string}
87
+ * @memberof ScheduledCommissionClawbackTriggerClass
88
+ */
89
+ 'createdBy': string;
90
+ /**
91
+ * Identifier of the user who last updated the record.
92
+ * @type {string}
93
+ * @memberof ScheduledCommissionClawbackTriggerClass
94
+ */
95
+ 'updatedBy': string;
96
+ }
97
+ export declare const ScheduledCommissionClawbackTriggerClassTriggerTypeEnum: {
98
+ readonly PolicyTermination: "policy_termination";
99
+ readonly PolicyWithdrawal: "policy_withdrawal";
100
+ readonly IntermediarySwitched: "intermediary_switched";
101
+ };
102
+ export type ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum[keyof typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum];
103
+ export declare const ScheduledCommissionClawbackTriggerClassStatusEnum: {
104
+ readonly Scheduled: "scheduled";
105
+ readonly Queued: "queued";
106
+ readonly Canceled: "canceled";
107
+ readonly Failed: "failed";
108
+ };
109
+ export type ScheduledCommissionClawbackTriggerClassStatusEnum = typeof ScheduledCommissionClawbackTriggerClassStatusEnum[keyof typeof ScheduledCommissionClawbackTriggerClassStatusEnum];
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL CommissionService
6
+ * The EMIL CommissionService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ScheduledCommissionClawbackTriggerClassStatusEnum = exports.ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = void 0;
17
+ exports.ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = {
18
+ PolicyTermination: 'policy_termination',
19
+ PolicyWithdrawal: 'policy_withdrawal',
20
+ IntermediarySwitched: 'intermediary_switched'
21
+ };
22
+ exports.ScheduledCommissionClawbackTriggerClassStatusEnum = {
23
+ Scheduled: 'scheduled',
24
+ Queued: 'queued',
25
+ Canceled: 'canceled',
26
+ Failed: 'failed'
27
+ };
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface TriggerDueCommissionClawbacksRequestDto {
18
18
  /**
19
- * Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used.
19
+ * Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used. Future dates are only allowed when dryRun is true.
20
20
  * @type {string}
21
21
  * @memberof TriggerDueCommissionClawbacksRequestDto
22
22
  */
package/models/index.ts CHANGED
@@ -61,10 +61,12 @@ export * from './list-commission-candidates-response-class';
61
61
  export * from './list-commission-recipients-response-class';
62
62
  export * from './list-commission-settlements-response-class';
63
63
  export * from './list-commissions-response-class';
64
+ export * from './list-scheduled-commission-clawback-triggers-response-class';
64
65
  export * from './patch-commission-agreement-status-request-dto';
65
66
  export * from './patch-commission-agreement-status-response-class';
66
67
  export * from './publish-commission-settlements-request-dto';
67
68
  export * from './publish-commission-settlements-response-class';
69
+ export * from './scheduled-commission-clawback-trigger-class';
68
70
  export * from './trigger-commission-settlement-creation-request-dto';
69
71
  export * from './trigger-commission-settlement-creation-response-class';
70
72
  export * from './trigger-due-commission-clawbacks-request-dto';
@@ -0,0 +1,49 @@
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
+ import { ScheduledCommissionClawbackTriggerClass } from './scheduled-commission-clawback-trigger-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface ListScheduledCommissionClawbackTriggersResponseClass
22
+ */
23
+ export interface ListScheduledCommissionClawbackTriggersResponseClass {
24
+ /**
25
+ * The list of scheduled commission clawback triggerss.
26
+ * @type {Array<ScheduledCommissionClawbackTriggerClass>}
27
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
28
+ */
29
+ 'items': Array<ScheduledCommissionClawbackTriggerClass>;
30
+ /**
31
+ * Next page token.
32
+ * @type {string}
33
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
34
+ */
35
+ 'nextPageToken': string;
36
+ /**
37
+ * Items per page.
38
+ * @type {number}
39
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
40
+ */
41
+ 'itemsPerPage': number;
42
+ /**
43
+ * Total amount of items.
44
+ * @type {number}
45
+ * @memberof ListScheduledCommissionClawbackTriggersResponseClass
46
+ */
47
+ 'totalItems': number;
48
+ }
49
+
@@ -0,0 +1,119 @@
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 ScheduledCommissionClawbackTriggerClass
21
+ */
22
+ export interface ScheduledCommissionClawbackTriggerClass {
23
+ /**
24
+ * The unique database identifier of the scheduled trigger
25
+ * @type {number}
26
+ * @memberof ScheduledCommissionClawbackTriggerClass
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Unique identifier for the object.
31
+ * @type {string}
32
+ * @memberof ScheduledCommissionClawbackTriggerClass
33
+ */
34
+ 'code': string;
35
+ /**
36
+ * The policy this scheduled clawback trigger belongs to
37
+ * @type {string}
38
+ * @memberof ScheduledCommissionClawbackTriggerClass
39
+ */
40
+ 'policyCode': string;
41
+ /**
42
+ * The automatic clawback trigger type
43
+ * @type {string}
44
+ * @memberof ScheduledCommissionClawbackTriggerClass
45
+ */
46
+ 'triggerType': ScheduledCommissionClawbackTriggerClassTriggerTypeEnum;
47
+ /**
48
+ * The effective date when the scheduled clawback trigger becomes due
49
+ * @type {string}
50
+ * @memberof ScheduledCommissionClawbackTriggerClass
51
+ */
52
+ 'effectiveDate': string;
53
+ /**
54
+ * The current scheduled trigger status
55
+ * @type {string}
56
+ * @memberof ScheduledCommissionClawbackTriggerClass
57
+ */
58
+ 'status': ScheduledCommissionClawbackTriggerClassStatusEnum;
59
+ /**
60
+ * The time when the due job queued this trigger for processing
61
+ * @type {string}
62
+ * @memberof ScheduledCommissionClawbackTriggerClass
63
+ */
64
+ 'queuedAt'?: string;
65
+ /**
66
+ * Failure reason when processing this scheduled trigger failed
67
+ * @type {string}
68
+ * @memberof ScheduledCommissionClawbackTriggerClass
69
+ */
70
+ 'errorMessage'?: string;
71
+ /**
72
+ * The time when this scheduled trigger was canceled
73
+ * @type {string}
74
+ * @memberof ScheduledCommissionClawbackTriggerClass
75
+ */
76
+ 'canceledAt'?: string;
77
+ /**
78
+ * Time at which the object was created.
79
+ * @type {string}
80
+ * @memberof ScheduledCommissionClawbackTriggerClass
81
+ */
82
+ 'createdAt': string;
83
+ /**
84
+ * Time at which the object was updated.
85
+ * @type {string}
86
+ * @memberof ScheduledCommissionClawbackTriggerClass
87
+ */
88
+ 'updatedAt': string;
89
+ /**
90
+ * Identifier of the user who created the record.
91
+ * @type {string}
92
+ * @memberof ScheduledCommissionClawbackTriggerClass
93
+ */
94
+ 'createdBy': string;
95
+ /**
96
+ * Identifier of the user who last updated the record.
97
+ * @type {string}
98
+ * @memberof ScheduledCommissionClawbackTriggerClass
99
+ */
100
+ 'updatedBy': string;
101
+ }
102
+
103
+ export const ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = {
104
+ PolicyTermination: 'policy_termination',
105
+ PolicyWithdrawal: 'policy_withdrawal',
106
+ IntermediarySwitched: 'intermediary_switched'
107
+ } as const;
108
+
109
+ export type ScheduledCommissionClawbackTriggerClassTriggerTypeEnum = typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum[keyof typeof ScheduledCommissionClawbackTriggerClassTriggerTypeEnum];
110
+ export const ScheduledCommissionClawbackTriggerClassStatusEnum = {
111
+ Scheduled: 'scheduled',
112
+ Queued: 'queued',
113
+ Canceled: 'canceled',
114
+ Failed: 'failed'
115
+ } as const;
116
+
117
+ export type ScheduledCommissionClawbackTriggerClassStatusEnum = typeof ScheduledCommissionClawbackTriggerClassStatusEnum[keyof typeof ScheduledCommissionClawbackTriggerClassStatusEnum];
118
+
119
+
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface TriggerDueCommissionClawbacksRequestDto {
23
23
  /**
24
- * Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used.
24
+ * Processing cutoff for due scheduled clawback triggers. If omitted, server processing time is used. Future dates are only allowed when dryRun is true.
25
25
  * @type {string}
26
26
  * @memberof TriggerDueCommissionClawbacksRequestDto
27
27
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/commission-sdk-node",
3
- "version": "2.9.1-beta.10",
3
+ "version": "2.9.1-beta.12",
4
4
  "description": "OpenAPI client for @emilgroup/commission-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [