@emilgroup/commission-sdk 2.10.1-beta.2 → 2.10.1-beta.20

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 (88) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/commissions-api.ts +415 -0
  4. package/dist/api/commissions-api.d.ts +233 -0
  5. package/dist/api/commissions-api.js +321 -0
  6. package/dist/models/clawback-config-class.d.ts +42 -0
  7. package/dist/models/clawback-config-class.js +15 -0
  8. package/dist/models/clawback-config-dto.d.ts +42 -0
  9. package/dist/models/clawback-config-dto.js +15 -0
  10. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  11. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  12. package/dist/models/commission-agreement-version-config-class.js +15 -0
  13. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  14. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  15. package/dist/models/commission-candidate-class.d.ts +12 -0
  16. package/dist/models/commission-class.d.ts +38 -0
  17. package/dist/models/commission-class.js +8 -0
  18. package/dist/models/commission-config-dto.d.ts +2 -1
  19. package/dist/models/commission-config-dto.js +2 -1
  20. package/dist/models/commission-creation-config-class.d.ts +43 -0
  21. package/dist/models/commission-creation-config-class.js +20 -0
  22. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  23. package/dist/models/commission-creation-config-dto.js +20 -0
  24. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  25. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  26. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  27. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  28. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  29. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  30. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  31. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  32. package/dist/models/commission-estimate-class.d.ts +2 -1
  33. package/dist/models/commission-estimate-class.js +2 -1
  34. package/dist/models/create-commission-agreement-request-dto.d.ts +7 -0
  35. package/dist/models/create-commission-agreement-version-request-dto.d.ts +7 -0
  36. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  37. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  38. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  39. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  40. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  41. package/dist/models/create-commission-clawback-response-class.js +21 -0
  42. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  43. package/dist/models/create-commission-item-request-dto.js +2 -1
  44. package/dist/models/create-commission-request-dto.d.ts +6 -0
  45. package/dist/models/evaluated-commission-class.d.ts +2 -1
  46. package/dist/models/evaluated-commission-class.js +2 -1
  47. package/dist/models/index.d.ts +16 -0
  48. package/dist/models/index.js +16 -0
  49. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  50. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  51. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  52. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  53. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  54. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  55. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  56. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  57. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  58. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  59. package/models/clawback-config-class.ts +48 -0
  60. package/models/clawback-config-dto.ts +48 -0
  61. package/models/commission-agreement-version-class.ts +7 -0
  62. package/models/commission-agreement-version-config-class.ts +38 -0
  63. package/models/commission-agreement-version-config-dto.ts +38 -0
  64. package/models/commission-candidate-class.ts +12 -0
  65. package/models/commission-class.ts +41 -0
  66. package/models/commission-config-dto.ts +3 -2
  67. package/models/commission-creation-config-class.ts +52 -0
  68. package/models/commission-creation-config-dto.ts +52 -0
  69. package/models/commission-creation-invoice-config-class.ts +30 -0
  70. package/models/commission-creation-invoice-config-dto.ts +30 -0
  71. package/models/commission-creation-renewal-config-class.ts +38 -0
  72. package/models/commission-creation-renewal-config-dto.ts +38 -0
  73. package/models/commission-estimate-class.ts +3 -2
  74. package/models/create-commission-agreement-request-dto.ts +7 -0
  75. package/models/create-commission-agreement-version-request-dto.ts +7 -0
  76. package/models/create-commission-candidate-request-dto.ts +16 -3
  77. package/models/create-commission-clawback-request-dto.ts +30 -0
  78. package/models/create-commission-clawback-response-class.ts +52 -0
  79. package/models/create-commission-item-request-dto.ts +3 -2
  80. package/models/create-commission-request-dto.ts +6 -0
  81. package/models/evaluated-commission-class.ts +3 -2
  82. package/models/index.ts +16 -0
  83. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  84. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  85. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  86. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  87. package/models/update-commission-candidate-request-dto.ts +3 -2
  88. package/package.json +1 -1
@@ -17,6 +17,8 @@ common.ts
17
17
  configuration.ts
18
18
  git_push.sh
19
19
  index.ts
20
+ models/clawback-config-class.ts
21
+ models/clawback-config-dto.ts
20
22
  models/commission-agreement-class.ts
21
23
  models/commission-agreement-metadata-dto.ts
22
24
  models/commission-agreement-metadata-partner-dto.ts
@@ -25,10 +27,18 @@ models/commission-agreement-rule-class.ts
25
27
  models/commission-agreement-rule-config-dto.ts
26
28
  models/commission-agreement-rule-evaluation-class.ts
27
29
  models/commission-agreement-version-class.ts
30
+ models/commission-agreement-version-config-class.ts
31
+ models/commission-agreement-version-config-dto.ts
28
32
  models/commission-candidate-class.ts
29
33
  models/commission-class.ts
30
34
  models/commission-conditions-dto.ts
31
35
  models/commission-config-dto.ts
36
+ models/commission-creation-config-class.ts
37
+ models/commission-creation-config-dto.ts
38
+ models/commission-creation-invoice-config-class.ts
39
+ models/commission-creation-invoice-config-dto.ts
40
+ models/commission-creation-renewal-config-class.ts
41
+ models/commission-creation-renewal-config-dto.ts
32
42
  models/commission-estimate-class.ts
33
43
  models/commission-item-class.ts
34
44
  models/commission-recipient-class.ts
@@ -43,6 +53,8 @@ models/create-commission-agreement-version-request-dto.ts
43
53
  models/create-commission-agreement-version-response-class.ts
44
54
  models/create-commission-candidate-request-dto.ts
45
55
  models/create-commission-candidate-response-class.ts
56
+ models/create-commission-clawback-request-dto.ts
57
+ models/create-commission-clawback-response-class.ts
46
58
  models/create-commission-item-request-dto.ts
47
59
  models/create-commission-recipient-for-products-request-dto.ts
48
60
  models/create-commission-recipient-for-products-response-class.ts
@@ -77,12 +89,16 @@ models/list-commission-candidates-response-class.ts
77
89
  models/list-commission-recipients-response-class.ts
78
90
  models/list-commission-settlements-response-class.ts
79
91
  models/list-commissions-response-class.ts
92
+ models/list-scheduled-commission-clawback-triggers-response-class.ts
80
93
  models/patch-commission-agreement-status-request-dto.ts
81
94
  models/patch-commission-agreement-status-response-class.ts
82
95
  models/publish-commission-settlements-request-dto.ts
83
96
  models/publish-commission-settlements-response-class.ts
97
+ models/scheduled-commission-clawback-trigger-class.ts
84
98
  models/trigger-commission-settlement-creation-request-dto.ts
85
99
  models/trigger-commission-settlement-creation-response-class.ts
100
+ models/trigger-due-commission-clawbacks-request-dto.ts
101
+ models/trigger-due-commission-clawbacks-response-class.ts
86
102
  models/update-commission-agreement-product-request-dto.ts
87
103
  models/update-commission-agreement-product-response-class.ts
88
104
  models/update-commission-agreement-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@2.10.1-beta.2 --save
20
+ npm install @emilgroup/commission-sdk@2.10.1-beta.20 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk@2.10.1-beta.2
24
+ yarn add @emilgroup/commission-sdk@2.10.1-beta.20
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { CreateCommissionClawbackRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateCommissionClawbackResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { CreateCommissionRequestDto } from '../models';
25
29
  // @ts-ignore
26
30
  import { CreateCommissionResponseClass } from '../models';
@@ -33,6 +37,12 @@ import { GetCommissionResponseClass } from '../models';
33
37
  // @ts-ignore
34
38
  import { ListCommissionsResponseClass } from '../models';
35
39
  // @ts-ignore
40
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
41
+ // @ts-ignore
42
+ import { TriggerDueCommissionClawbacksRequestDto } from '../models';
43
+ // @ts-ignore
44
+ import { TriggerDueCommissionClawbacksResponseClass } from '../models';
45
+ // @ts-ignore
36
46
  import { UpdateCommissionRequestDto } from '../models';
37
47
  // @ts-ignore
38
48
  import { UpdateCommissionResponseClass } from '../models';
@@ -89,6 +99,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
89
99
  options: localVarRequestOptions,
90
100
  };
91
101
  },
102
+ /**
103
+ * Creates a manual clawback for one commission.
104
+ * @summary Create the commission clawback
105
+ * @param {string} code Unique identifier for the object.
106
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
107
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ createCommissionClawback: async (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
112
+ // verify required parameter 'code' is not null or undefined
113
+ assertParamExists('createCommissionClawback', 'code', code)
114
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
115
+ assertParamExists('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto)
116
+ const localVarPath = `/commissionservice/v1/commissions/{code}/clawbacks`
117
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
118
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
119
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
120
+ let baseOptions;
121
+ let baseAccessToken;
122
+ if (configuration) {
123
+ baseOptions = configuration.baseOptions;
124
+ baseAccessToken = configuration.accessToken;
125
+ }
126
+
127
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
128
+ const localVarHeaderParameter = {} as any;
129
+ const localVarQueryParameter = {} as any;
130
+
131
+ // authentication bearer required
132
+ // http bearer authentication required
133
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
134
+
135
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
136
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
137
+ }
138
+
139
+
140
+
141
+ localVarHeaderParameter['Content-Type'] = 'application/json';
142
+
143
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
144
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
145
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
146
+ localVarRequestOptions.data = serializeDataIfNeeded(createCommissionClawbackRequestDto, localVarRequestOptions, configuration)
147
+
148
+ return {
149
+ url: toPathString(localVarUrlObj),
150
+ options: localVarRequestOptions,
151
+ };
152
+ },
92
153
  /**
93
154
  * This will delete commission.
94
155
  * @summary Delete the commission
@@ -309,6 +370,129 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
309
370
  options: localVarRequestOptions,
310
371
  };
311
372
  },
373
+ /**
374
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
375
+ * @summary List scheduled commission clawback triggers
376
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
377
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
378
+ * @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.
379
+ * @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;
380
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
381
+ * @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;
382
+ * @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;
383
+ * @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;
384
+ * @param {*} [options] Override http request option.
385
+ * @throws {RequiredError}
386
+ */
387
+ listScheduledCommissionClawbackTriggers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
388
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/scheduled-triggers`;
389
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
390
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
391
+ let baseOptions;
392
+ let baseAccessToken;
393
+ if (configuration) {
394
+ baseOptions = configuration.baseOptions;
395
+ baseAccessToken = configuration.accessToken;
396
+ }
397
+
398
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
399
+ const localVarHeaderParameter = {} as any;
400
+ const localVarQueryParameter = {} as any;
401
+
402
+ // authentication bearer required
403
+ // http bearer authentication required
404
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
405
+
406
+ if (pageSize !== undefined) {
407
+ localVarQueryParameter['pageSize'] = pageSize;
408
+ }
409
+
410
+ if (pageToken !== undefined) {
411
+ localVarQueryParameter['pageToken'] = pageToken;
412
+ }
413
+
414
+ if (filter !== undefined) {
415
+ localVarQueryParameter['filter'] = filter;
416
+ }
417
+
418
+ if (search !== undefined) {
419
+ localVarQueryParameter['search'] = search;
420
+ }
421
+
422
+ if (order !== undefined) {
423
+ localVarQueryParameter['order'] = order;
424
+ }
425
+
426
+ if (expand !== undefined) {
427
+ localVarQueryParameter['expand'] = expand;
428
+ }
429
+
430
+ if (filters !== undefined) {
431
+ localVarQueryParameter['filters'] = filters;
432
+ }
433
+
434
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
435
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
436
+ }
437
+
438
+
439
+
440
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
441
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
442
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
443
+
444
+ return {
445
+ url: toPathString(localVarUrlObj),
446
+ options: localVarRequestOptions,
447
+ };
448
+ },
449
+ /**
450
+ * 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.
451
+ * @summary Create the due commission clawbacks trigger
452
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
453
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
454
+ * @param {*} [options] Override http request option.
455
+ * @throws {RequiredError}
456
+ */
457
+ triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
458
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
459
+ assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
460
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
461
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
462
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
463
+ let baseOptions;
464
+ let baseAccessToken;
465
+ if (configuration) {
466
+ baseOptions = configuration.baseOptions;
467
+ baseAccessToken = configuration.accessToken;
468
+ }
469
+
470
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
471
+ const localVarHeaderParameter = {} as any;
472
+ const localVarQueryParameter = {} as any;
473
+
474
+ // authentication bearer required
475
+ // http bearer authentication required
476
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
477
+
478
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
479
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
480
+ }
481
+
482
+
483
+
484
+ localVarHeaderParameter['Content-Type'] = 'application/json';
485
+
486
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
487
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
488
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
489
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
490
+
491
+ return {
492
+ url: toPathString(localVarUrlObj),
493
+ options: localVarRequestOptions,
494
+ };
495
+ },
312
496
  /**
313
497
  * This will update commission.
314
498
  * @summary Update the commission
@@ -382,6 +566,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
382
566
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
383
567
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
384
568
  },
569
+ /**
570
+ * Creates a manual clawback for one commission.
571
+ * @summary Create the commission clawback
572
+ * @param {string} code Unique identifier for the object.
573
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
574
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
575
+ * @param {*} [options] Override http request option.
576
+ * @throws {RequiredError}
577
+ */
578
+ async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
579
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
580
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
581
+ },
385
582
  /**
386
583
  * This will delete commission.
387
584
  * @summary Delete the commission
@@ -437,6 +634,36 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
437
634
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
438
635
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
439
636
  },
637
+ /**
638
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
639
+ * @summary List scheduled commission clawback triggers
640
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
641
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
642
+ * @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.
643
+ * @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;
644
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
645
+ * @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;
646
+ * @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;
647
+ * @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;
648
+ * @param {*} [options] Override http request option.
649
+ * @throws {RequiredError}
650
+ */
651
+ 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>> {
652
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
653
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
654
+ },
655
+ /**
656
+ * 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.
657
+ * @summary Create the due commission clawbacks trigger
658
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
659
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
660
+ * @param {*} [options] Override http request option.
661
+ * @throws {RequiredError}
662
+ */
663
+ async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
664
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
665
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
666
+ },
440
667
  /**
441
668
  * This will update commission.
442
669
  * @summary Update the commission
@@ -471,6 +698,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
471
698
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
472
699
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
473
700
  },
701
+ /**
702
+ * Creates a manual clawback for one commission.
703
+ * @summary Create the commission clawback
704
+ * @param {string} code Unique identifier for the object.
705
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
706
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
707
+ * @param {*} [options] Override http request option.
708
+ * @throws {RequiredError}
709
+ */
710
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
711
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
712
+ },
474
713
  /**
475
714
  * This will delete commission.
476
715
  * @summary Delete the commission
@@ -522,6 +761,34 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
522
761
  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> {
523
762
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
524
763
  },
764
+ /**
765
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
766
+ * @summary List scheduled commission clawback triggers
767
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
768
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
769
+ * @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.
770
+ * @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;
771
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
772
+ * @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;
773
+ * @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;
774
+ * @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;
775
+ * @param {*} [options] Override http request option.
776
+ * @throws {RequiredError}
777
+ */
778
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass> {
779
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
780
+ },
781
+ /**
782
+ * 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.
783
+ * @summary Create the due commission clawbacks trigger
784
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
785
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
786
+ * @param {*} [options] Override http request option.
787
+ * @throws {RequiredError}
788
+ */
789
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
790
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
791
+ },
525
792
  /**
526
793
  * This will update commission.
527
794
  * @summary Update the commission
@@ -558,6 +825,34 @@ export interface CommissionsApiCreateCommissionRequest {
558
825
  readonly authorization?: string
559
826
  }
560
827
 
828
+ /**
829
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
830
+ * @export
831
+ * @interface CommissionsApiCreateCommissionClawbackRequest
832
+ */
833
+ export interface CommissionsApiCreateCommissionClawbackRequest {
834
+ /**
835
+ * Unique identifier for the object.
836
+ * @type {string}
837
+ * @memberof CommissionsApiCreateCommissionClawback
838
+ */
839
+ readonly code: string
840
+
841
+ /**
842
+ *
843
+ * @type {CreateCommissionClawbackRequestDto}
844
+ * @memberof CommissionsApiCreateCommissionClawback
845
+ */
846
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
847
+
848
+ /**
849
+ * Bearer Token: provided by the login endpoint under the name accessToken.
850
+ * @type {string}
851
+ * @memberof CommissionsApiCreateCommissionClawback
852
+ */
853
+ readonly authorization?: string
854
+ }
855
+
561
856
  /**
562
857
  * Request parameters for deleteCommission operation in CommissionsApi.
563
858
  * @export
@@ -691,6 +986,90 @@ export interface CommissionsApiListCommissionsRequest {
691
986
  readonly filters?: string
692
987
  }
693
988
 
989
+ /**
990
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
991
+ * @export
992
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
993
+ */
994
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
995
+ /**
996
+ * Bearer Token: provided by the login endpoint under the name accessToken.
997
+ * @type {string}
998
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
999
+ */
1000
+ readonly authorization?: string
1001
+
1002
+ /**
1003
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1004
+ * @type {number}
1005
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1006
+ */
1007
+ readonly pageSize?: number
1008
+
1009
+ /**
1010
+ * 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.
1011
+ * @type {string}
1012
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1013
+ */
1014
+ readonly pageToken?: string
1015
+
1016
+ /**
1017
+ * 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;
1018
+ * @type {string}
1019
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1020
+ */
1021
+ readonly filter?: string
1022
+
1023
+ /**
1024
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1025
+ * @type {string}
1026
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1027
+ */
1028
+ readonly search?: string
1029
+
1030
+ /**
1031
+ * 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;
1032
+ * @type {string}
1033
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1034
+ */
1035
+ readonly order?: string
1036
+
1037
+ /**
1038
+ * 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;
1039
+ * @type {string}
1040
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1041
+ */
1042
+ readonly expand?: string
1043
+
1044
+ /**
1045
+ * 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;
1046
+ * @type {string}
1047
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1048
+ */
1049
+ readonly filters?: string
1050
+ }
1051
+
1052
+ /**
1053
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
1054
+ * @export
1055
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
1056
+ */
1057
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
1058
+ /**
1059
+ *
1060
+ * @type {TriggerDueCommissionClawbacksRequestDto}
1061
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1062
+ */
1063
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
1064
+
1065
+ /**
1066
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1067
+ * @type {string}
1068
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1069
+ */
1070
+ readonly authorization?: string
1071
+ }
1072
+
694
1073
  /**
695
1074
  * Request parameters for updateCommission operation in CommissionsApi.
696
1075
  * @export
@@ -738,6 +1117,18 @@ export class CommissionsApi extends BaseAPI {
738
1117
  return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
739
1118
  }
740
1119
 
1120
+ /**
1121
+ * Creates a manual clawback for one commission.
1122
+ * @summary Create the commission clawback
1123
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
1124
+ * @param {*} [options] Override http request option.
1125
+ * @throws {RequiredError}
1126
+ * @memberof CommissionsApi
1127
+ */
1128
+ public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
1129
+ return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1130
+ }
1131
+
741
1132
  /**
742
1133
  * This will delete commission.
743
1134
  * @summary Delete the commission
@@ -786,6 +1177,30 @@ export class CommissionsApi extends BaseAPI {
786
1177
  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));
787
1178
  }
788
1179
 
1180
+ /**
1181
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1182
+ * @summary List scheduled commission clawback triggers
1183
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1184
+ * @param {*} [options] Override http request option.
1185
+ * @throws {RequiredError}
1186
+ * @memberof CommissionsApi
1187
+ */
1188
+ public listScheduledCommissionClawbackTriggers(requestParameters: CommissionsApiListScheduledCommissionClawbackTriggersRequest = {}, options?: AxiosRequestConfig) {
1189
+ 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));
1190
+ }
1191
+
1192
+ /**
1193
+ * 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.
1194
+ * @summary Create the due commission clawbacks trigger
1195
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1196
+ * @param {*} [options] Override http request option.
1197
+ * @throws {RequiredError}
1198
+ * @memberof CommissionsApi
1199
+ */
1200
+ public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
1201
+ return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1202
+ }
1203
+
789
1204
  /**
790
1205
  * This will update commission.
791
1206
  * @summary Update the commission