@emilgroup/commission-sdk-node 2.9.1-beta.2 → 2.9.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-node@2.9.1-beta.2 --save
20
+ npm install @emilgroup/commission-sdk-node@2.9.1-beta.20 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk-node@2.9.1-beta.2
24
+ yarn add @emilgroup/commission-sdk-node@2.9.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';
@@ -93,6 +103,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
93
103
  options: localVarRequestOptions,
94
104
  };
95
105
  },
106
+ /**
107
+ * Creates a manual clawback for one commission.
108
+ * @summary Create the commission clawback
109
+ * @param {string} code Unique identifier for the object.
110
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
111
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
112
+ * @param {*} [options] Override http request option.
113
+ * @throws {RequiredError}
114
+ */
115
+ createCommissionClawback: async (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
116
+ // verify required parameter 'code' is not null or undefined
117
+ assertParamExists('createCommissionClawback', 'code', code)
118
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
119
+ assertParamExists('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto)
120
+ const localVarPath = `/commissionservice/v1/commissions/{code}/clawbacks`
121
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
122
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
123
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
124
+ let baseOptions;
125
+ let baseAccessToken;
126
+ if (configuration) {
127
+ baseOptions = configuration.baseOptions;
128
+ baseAccessToken = configuration.accessToken;
129
+ }
130
+
131
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
132
+ const localVarHeaderParameter = {} as any;
133
+ const localVarQueryParameter = {} as any;
134
+
135
+ // authentication bearer required
136
+ // http bearer authentication required
137
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
138
+
139
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
140
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
141
+ }
142
+
143
+
144
+
145
+ localVarHeaderParameter['Content-Type'] = 'application/json';
146
+
147
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
148
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
149
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
150
+ localVarRequestOptions.data = serializeDataIfNeeded(createCommissionClawbackRequestDto, localVarRequestOptions, configuration)
151
+
152
+ return {
153
+ url: toPathString(localVarUrlObj),
154
+ options: localVarRequestOptions,
155
+ };
156
+ },
96
157
  /**
97
158
  * This will delete commission.
98
159
  * @summary Delete the commission
@@ -313,6 +374,129 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
313
374
  options: localVarRequestOptions,
314
375
  };
315
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&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 {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, effectiveDate, queuedAt, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
387
+ * @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;
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
+
444
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
445
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
446
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
447
+
448
+ return {
449
+ url: toPathString(localVarUrlObj),
450
+ options: localVarRequestOptions,
451
+ };
452
+ },
453
+ /**
454
+ * 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.
455
+ * @summary Create the due commission clawbacks trigger
456
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
457
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
458
+ * @param {*} [options] Override http request option.
459
+ * @throws {RequiredError}
460
+ */
461
+ triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
462
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
463
+ assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
464
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
465
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
466
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
467
+ let baseOptions;
468
+ let baseAccessToken;
469
+ if (configuration) {
470
+ baseOptions = configuration.baseOptions;
471
+ baseAccessToken = configuration.accessToken;
472
+ }
473
+
474
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
475
+ const localVarHeaderParameter = {} as any;
476
+ const localVarQueryParameter = {} as any;
477
+
478
+ // authentication bearer required
479
+ // http bearer authentication required
480
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
481
+
482
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
483
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
484
+ }
485
+
486
+
487
+
488
+ localVarHeaderParameter['Content-Type'] = 'application/json';
489
+
490
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
491
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
492
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
493
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
494
+
495
+ return {
496
+ url: toPathString(localVarUrlObj),
497
+ options: localVarRequestOptions,
498
+ };
499
+ },
316
500
  /**
317
501
  * This will update commission.
318
502
  * @summary Update the commission
@@ -386,6 +570,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
386
570
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
387
571
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
388
572
  },
573
+ /**
574
+ * Creates a manual clawback for one commission.
575
+ * @summary Create the commission clawback
576
+ * @param {string} code Unique identifier for the object.
577
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
578
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
579
+ * @param {*} [options] Override http request option.
580
+ * @throws {RequiredError}
581
+ */
582
+ async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
583
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
584
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
585
+ },
389
586
  /**
390
587
  * This will delete commission.
391
588
  * @summary Delete the commission
@@ -441,6 +638,36 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
441
638
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
442
639
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
443
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
+ },
659
+ /**
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.
661
+ * @summary Create the due commission clawbacks trigger
662
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
663
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
664
+ * @param {*} [options] Override http request option.
665
+ * @throws {RequiredError}
666
+ */
667
+ async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
668
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
669
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
670
+ },
444
671
  /**
445
672
  * This will update commission.
446
673
  * @summary Update the commission
@@ -475,6 +702,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
475
702
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
476
703
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
477
704
  },
705
+ /**
706
+ * Creates a manual clawback for one commission.
707
+ * @summary Create the commission clawback
708
+ * @param {string} code Unique identifier for the object.
709
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
710
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
711
+ * @param {*} [options] Override http request option.
712
+ * @throws {RequiredError}
713
+ */
714
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
715
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
716
+ },
478
717
  /**
479
718
  * This will delete commission.
480
719
  * @summary Delete the commission
@@ -526,6 +765,34 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
526
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> {
527
766
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
528
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
+ },
785
+ /**
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.
787
+ * @summary Create the due commission clawbacks trigger
788
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
789
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
790
+ * @param {*} [options] Override http request option.
791
+ * @throws {RequiredError}
792
+ */
793
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
794
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
795
+ },
529
796
  /**
530
797
  * This will update commission.
531
798
  * @summary Update the commission
@@ -562,6 +829,34 @@ export interface CommissionsApiCreateCommissionRequest {
562
829
  readonly authorization?: string
563
830
  }
564
831
 
832
+ /**
833
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
834
+ * @export
835
+ * @interface CommissionsApiCreateCommissionClawbackRequest
836
+ */
837
+ export interface CommissionsApiCreateCommissionClawbackRequest {
838
+ /**
839
+ * Unique identifier for the object.
840
+ * @type {string}
841
+ * @memberof CommissionsApiCreateCommissionClawback
842
+ */
843
+ readonly code: string
844
+
845
+ /**
846
+ *
847
+ * @type {CreateCommissionClawbackRequestDto}
848
+ * @memberof CommissionsApiCreateCommissionClawback
849
+ */
850
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
851
+
852
+ /**
853
+ * Bearer Token: provided by the login endpoint under the name accessToken.
854
+ * @type {string}
855
+ * @memberof CommissionsApiCreateCommissionClawback
856
+ */
857
+ readonly authorization?: string
858
+ }
859
+
565
860
  /**
566
861
  * Request parameters for deleteCommission operation in CommissionsApi.
567
862
  * @export
@@ -695,6 +990,90 @@ export interface CommissionsApiListCommissionsRequest {
695
990
  readonly filters?: string
696
991
  }
697
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
+
1056
+ /**
1057
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
1058
+ * @export
1059
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
1060
+ */
1061
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
1062
+ /**
1063
+ *
1064
+ * @type {TriggerDueCommissionClawbacksRequestDto}
1065
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1066
+ */
1067
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
1068
+
1069
+ /**
1070
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1071
+ * @type {string}
1072
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1073
+ */
1074
+ readonly authorization?: string
1075
+ }
1076
+
698
1077
  /**
699
1078
  * Request parameters for updateCommission operation in CommissionsApi.
700
1079
  * @export
@@ -742,6 +1121,18 @@ export class CommissionsApi extends BaseAPI {
742
1121
  return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
743
1122
  }
744
1123
 
1124
+ /**
1125
+ * Creates a manual clawback for one commission.
1126
+ * @summary Create the commission clawback
1127
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
1128
+ * @param {*} [options] Override http request option.
1129
+ * @throws {RequiredError}
1130
+ * @memberof CommissionsApi
1131
+ */
1132
+ public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
1133
+ return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1134
+ }
1135
+
745
1136
  /**
746
1137
  * This will delete commission.
747
1138
  * @summary Delete the commission
@@ -790,6 +1181,30 @@ export class CommissionsApi extends BaseAPI {
790
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));
791
1182
  }
792
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
+
1196
+ /**
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.
1198
+ * @summary Create the due commission clawbacks trigger
1199
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1200
+ * @param {*} [options] Override http request option.
1201
+ * @throws {RequiredError}
1202
+ * @memberof CommissionsApi
1203
+ */
1204
+ public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
1205
+ return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1206
+ }
1207
+
793
1208
  /**
794
1209
  * This will update commission.
795
1210
  * @summary Update the commission