@emilgroup/commission-sdk-node 2.9.1-beta.2 → 2.9.1-beta.21

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 (94) hide show
  1. package/.openapi-generator/FILES +18 -0
  2. package/README.md +2 -2
  3. package/api/commissions-api.ts +603 -0
  4. package/dist/api/commissions-api.d.ts +343 -0
  5. package/dist/api/commissions-api.js +450 -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/commission-paid-invoice-entry-class.d.ts +108 -0
  35. package/dist/models/commission-paid-invoice-entry-class.js +21 -0
  36. package/dist/models/create-commission-agreement-request-dto.d.ts +7 -0
  37. package/dist/models/create-commission-agreement-version-request-dto.d.ts +7 -0
  38. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  39. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  40. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  41. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  42. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  43. package/dist/models/create-commission-clawback-response-class.js +21 -0
  44. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  45. package/dist/models/create-commission-item-request-dto.js +2 -1
  46. package/dist/models/create-commission-request-dto.d.ts +6 -0
  47. package/dist/models/evaluated-commission-class.d.ts +2 -1
  48. package/dist/models/evaluated-commission-class.js +2 -1
  49. package/dist/models/index.d.ts +18 -0
  50. package/dist/models/index.js +18 -0
  51. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  52. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  53. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  54. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  55. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  56. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  57. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  58. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  59. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  60. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  61. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  62. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  63. package/models/clawback-config-class.ts +48 -0
  64. package/models/clawback-config-dto.ts +48 -0
  65. package/models/commission-agreement-version-class.ts +7 -0
  66. package/models/commission-agreement-version-config-class.ts +38 -0
  67. package/models/commission-agreement-version-config-dto.ts +38 -0
  68. package/models/commission-candidate-class.ts +12 -0
  69. package/models/commission-class.ts +41 -0
  70. package/models/commission-config-dto.ts +3 -2
  71. package/models/commission-creation-config-class.ts +52 -0
  72. package/models/commission-creation-config-dto.ts +52 -0
  73. package/models/commission-creation-invoice-config-class.ts +30 -0
  74. package/models/commission-creation-invoice-config-dto.ts +30 -0
  75. package/models/commission-creation-renewal-config-class.ts +38 -0
  76. package/models/commission-creation-renewal-config-dto.ts +38 -0
  77. package/models/commission-estimate-class.ts +3 -2
  78. package/models/commission-paid-invoice-entry-class.ts +117 -0
  79. package/models/create-commission-agreement-request-dto.ts +7 -0
  80. package/models/create-commission-agreement-version-request-dto.ts +7 -0
  81. package/models/create-commission-candidate-request-dto.ts +16 -3
  82. package/models/create-commission-clawback-request-dto.ts +30 -0
  83. package/models/create-commission-clawback-response-class.ts +52 -0
  84. package/models/create-commission-item-request-dto.ts +3 -2
  85. package/models/create-commission-request-dto.ts +6 -0
  86. package/models/evaluated-commission-class.ts +3 -2
  87. package/models/index.ts +18 -0
  88. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  89. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  90. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  91. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  92. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  93. package/models/update-commission-candidate-request-dto.ts +3 -2
  94. package/package.json +1 -1
@@ -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';
@@ -31,8 +35,16 @@ import { EstimateCommissionsResponseClass } from '../models';
31
35
  // @ts-ignore
32
36
  import { GetCommissionResponseClass } from '../models';
33
37
  // @ts-ignore
38
+ import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
39
+ // @ts-ignore
34
40
  import { ListCommissionsResponseClass } from '../models';
35
41
  // @ts-ignore
42
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
43
+ // @ts-ignore
44
+ import { TriggerDueCommissionClawbacksRequestDto } from '../models';
45
+ // @ts-ignore
46
+ import { TriggerDueCommissionClawbacksResponseClass } from '../models';
47
+ // @ts-ignore
36
48
  import { UpdateCommissionRequestDto } from '../models';
37
49
  // @ts-ignore
38
50
  import { UpdateCommissionResponseClass } from '../models';
@@ -93,6 +105,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
93
105
  options: localVarRequestOptions,
94
106
  };
95
107
  },
108
+ /**
109
+ * Creates a manual clawback for one commission.
110
+ * @summary Create the commission clawback
111
+ * @param {string} code Unique identifier for the object.
112
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
113
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
114
+ * @param {*} [options] Override http request option.
115
+ * @throws {RequiredError}
116
+ */
117
+ createCommissionClawback: async (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
118
+ // verify required parameter 'code' is not null or undefined
119
+ assertParamExists('createCommissionClawback', 'code', code)
120
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
121
+ assertParamExists('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto)
122
+ const localVarPath = `/commissionservice/v1/commissions/{code}/clawbacks`
123
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
124
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
125
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
126
+ let baseOptions;
127
+ let baseAccessToken;
128
+ if (configuration) {
129
+ baseOptions = configuration.baseOptions;
130
+ baseAccessToken = configuration.accessToken;
131
+ }
132
+
133
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
134
+ const localVarHeaderParameter = {} as any;
135
+ const localVarQueryParameter = {} as any;
136
+
137
+ // authentication bearer required
138
+ // http bearer authentication required
139
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
140
+
141
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
142
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
143
+ }
144
+
145
+
146
+
147
+ localVarHeaderParameter['Content-Type'] = 'application/json';
148
+
149
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
150
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
151
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
152
+ localVarRequestOptions.data = serializeDataIfNeeded(createCommissionClawbackRequestDto, localVarRequestOptions, configuration)
153
+
154
+ return {
155
+ url: toPathString(localVarUrlObj),
156
+ options: localVarRequestOptions,
157
+ };
158
+ },
96
159
  /**
97
160
  * This will delete commission.
98
161
  * @summary Delete the commission
@@ -228,6 +291,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
228
291
 
229
292
 
230
293
 
294
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
295
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
296
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
297
+
298
+ return {
299
+ url: toPathString(localVarUrlObj),
300
+ options: localVarRequestOptions,
301
+ };
302
+ },
303
+ /**
304
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
305
+ * @summary List commission paid invoice entries
306
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
307
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
308
+ * @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.
309
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
310
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
311
+ * @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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
312
+ * @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;
313
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
314
+ * @param {*} [options] Override http request option.
315
+ * @throws {RequiredError}
316
+ */
317
+ listCommissionPaidInvoiceEntries: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
318
+ const localVarPath = `/commissionservice/v1/commissions/paid-invoice-entries`;
319
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
320
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
321
+ let baseOptions;
322
+ let baseAccessToken;
323
+ if (configuration) {
324
+ baseOptions = configuration.baseOptions;
325
+ baseAccessToken = configuration.accessToken;
326
+ }
327
+
328
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
329
+ const localVarHeaderParameter = {} as any;
330
+ const localVarQueryParameter = {} as any;
331
+
332
+ // authentication bearer required
333
+ // http bearer authentication required
334
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
335
+
336
+ if (pageSize !== undefined) {
337
+ localVarQueryParameter['pageSize'] = pageSize;
338
+ }
339
+
340
+ if (pageToken !== undefined) {
341
+ localVarQueryParameter['pageToken'] = pageToken;
342
+ }
343
+
344
+ if (filter !== undefined) {
345
+ localVarQueryParameter['filter'] = filter;
346
+ }
347
+
348
+ if (search !== undefined) {
349
+ localVarQueryParameter['search'] = search;
350
+ }
351
+
352
+ if (order !== undefined) {
353
+ localVarQueryParameter['order'] = order;
354
+ }
355
+
356
+ if (expand !== undefined) {
357
+ localVarQueryParameter['expand'] = expand;
358
+ }
359
+
360
+ if (filters !== undefined) {
361
+ localVarQueryParameter['filters'] = filters;
362
+ }
363
+
364
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
365
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
366
+ }
367
+
368
+
369
+
231
370
  setSearchParams(localVarUrlObj, localVarQueryParameter);
232
371
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
233
372
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -313,6 +452,129 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
313
452
  options: localVarRequestOptions,
314
453
  };
315
454
  },
455
+ /**
456
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
457
+ * @summary List scheduled commission clawback triggers
458
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
459
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
460
+ * @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.
461
+ * @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;
462
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
463
+ * @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;
464
+ * @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;
465
+ * @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;
466
+ * @param {*} [options] Override http request option.
467
+ * @throws {RequiredError}
468
+ */
469
+ listScheduledCommissionClawbackTriggers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
470
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/scheduled-triggers`;
471
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
472
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
473
+ let baseOptions;
474
+ let baseAccessToken;
475
+ if (configuration) {
476
+ baseOptions = configuration.baseOptions;
477
+ baseAccessToken = configuration.accessToken;
478
+ }
479
+
480
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
481
+ const localVarHeaderParameter = {} as any;
482
+ const localVarQueryParameter = {} as any;
483
+
484
+ // authentication bearer required
485
+ // http bearer authentication required
486
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
487
+
488
+ if (pageSize !== undefined) {
489
+ localVarQueryParameter['pageSize'] = pageSize;
490
+ }
491
+
492
+ if (pageToken !== undefined) {
493
+ localVarQueryParameter['pageToken'] = pageToken;
494
+ }
495
+
496
+ if (filter !== undefined) {
497
+ localVarQueryParameter['filter'] = filter;
498
+ }
499
+
500
+ if (search !== undefined) {
501
+ localVarQueryParameter['search'] = search;
502
+ }
503
+
504
+ if (order !== undefined) {
505
+ localVarQueryParameter['order'] = order;
506
+ }
507
+
508
+ if (expand !== undefined) {
509
+ localVarQueryParameter['expand'] = expand;
510
+ }
511
+
512
+ if (filters !== undefined) {
513
+ localVarQueryParameter['filters'] = filters;
514
+ }
515
+
516
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
517
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
518
+ }
519
+
520
+
521
+
522
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
523
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
524
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
525
+
526
+ return {
527
+ url: toPathString(localVarUrlObj),
528
+ options: localVarRequestOptions,
529
+ };
530
+ },
531
+ /**
532
+ * 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.
533
+ * @summary Create the due commission clawbacks trigger
534
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
535
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
536
+ * @param {*} [options] Override http request option.
537
+ * @throws {RequiredError}
538
+ */
539
+ triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
540
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
541
+ assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
542
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
543
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
544
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
545
+ let baseOptions;
546
+ let baseAccessToken;
547
+ if (configuration) {
548
+ baseOptions = configuration.baseOptions;
549
+ baseAccessToken = configuration.accessToken;
550
+ }
551
+
552
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
553
+ const localVarHeaderParameter = {} as any;
554
+ const localVarQueryParameter = {} as any;
555
+
556
+ // authentication bearer required
557
+ // http bearer authentication required
558
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
559
+
560
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
561
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
562
+ }
563
+
564
+
565
+
566
+ localVarHeaderParameter['Content-Type'] = 'application/json';
567
+
568
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
569
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
570
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
571
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
572
+
573
+ return {
574
+ url: toPathString(localVarUrlObj),
575
+ options: localVarRequestOptions,
576
+ };
577
+ },
316
578
  /**
317
579
  * This will update commission.
318
580
  * @summary Update the commission
@@ -386,6 +648,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
386
648
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
387
649
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
388
650
  },
651
+ /**
652
+ * Creates a manual clawback for one commission.
653
+ * @summary Create the commission clawback
654
+ * @param {string} code Unique identifier for the object.
655
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
656
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
657
+ * @param {*} [options] Override http request option.
658
+ * @throws {RequiredError}
659
+ */
660
+ async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
661
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
662
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
663
+ },
389
664
  /**
390
665
  * This will delete commission.
391
666
  * @summary Delete the commission
@@ -423,6 +698,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
423
698
  const localVarAxiosArgs = await localVarAxiosParamCreator.getCommission(code, expand, authorization, options);
424
699
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
425
700
  },
701
+ /**
702
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
703
+ * @summary List commission paid invoice entries
704
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
705
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
706
+ * @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.
707
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
708
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
709
+ * @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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
710
+ * @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;
711
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
712
+ * @param {*} [options] Override http request option.
713
+ * @throws {RequiredError}
714
+ */
715
+ async listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>> {
716
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
717
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
718
+ },
426
719
  /**
427
720
  * Retrieves a list of commissions.
428
721
  * @summary List commissions
@@ -441,6 +734,36 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
441
734
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
442
735
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
443
736
  },
737
+ /**
738
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
739
+ * @summary List scheduled commission clawback triggers
740
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
741
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
742
+ * @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.
743
+ * @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;
744
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
745
+ * @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;
746
+ * @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;
747
+ * @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;
748
+ * @param {*} [options] Override http request option.
749
+ * @throws {RequiredError}
750
+ */
751
+ 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>> {
752
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
753
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
754
+ },
755
+ /**
756
+ * 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.
757
+ * @summary Create the due commission clawbacks trigger
758
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
759
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
760
+ * @param {*} [options] Override http request option.
761
+ * @throws {RequiredError}
762
+ */
763
+ async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
764
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
765
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
766
+ },
444
767
  /**
445
768
  * This will update commission.
446
769
  * @summary Update the commission
@@ -475,6 +798,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
475
798
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
476
799
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
477
800
  },
801
+ /**
802
+ * Creates a manual clawback for one commission.
803
+ * @summary Create the commission clawback
804
+ * @param {string} code Unique identifier for the object.
805
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
806
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
807
+ * @param {*} [options] Override http request option.
808
+ * @throws {RequiredError}
809
+ */
810
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
811
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
812
+ },
478
813
  /**
479
814
  * This will delete commission.
480
815
  * @summary Delete the commission
@@ -509,6 +844,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
509
844
  getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass> {
510
845
  return localVarFp.getCommission(code, expand, authorization, options).then((request) => request(axios, basePath));
511
846
  },
847
+ /**
848
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
849
+ * @summary List commission paid invoice entries
850
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
851
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
852
+ * @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.
853
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
854
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
855
+ * @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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
856
+ * @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;
857
+ * @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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
858
+ * @param {*} [options] Override http request option.
859
+ * @throws {RequiredError}
860
+ */
861
+ listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass> {
862
+ return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
863
+ },
512
864
  /**
513
865
  * Retrieves a list of commissions.
514
866
  * @summary List commissions
@@ -526,6 +878,34 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
526
878
  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
879
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
528
880
  },
881
+ /**
882
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
883
+ * @summary List scheduled commission clawback triggers
884
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
885
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
886
+ * @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.
887
+ * @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;
888
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
889
+ * @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;
890
+ * @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;
891
+ * @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;
892
+ * @param {*} [options] Override http request option.
893
+ * @throws {RequiredError}
894
+ */
895
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass> {
896
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
897
+ },
898
+ /**
899
+ * 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.
900
+ * @summary Create the due commission clawbacks trigger
901
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
902
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
903
+ * @param {*} [options] Override http request option.
904
+ * @throws {RequiredError}
905
+ */
906
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
907
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
908
+ },
529
909
  /**
530
910
  * This will update commission.
531
911
  * @summary Update the commission
@@ -562,6 +942,34 @@ export interface CommissionsApiCreateCommissionRequest {
562
942
  readonly authorization?: string
563
943
  }
564
944
 
945
+ /**
946
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
947
+ * @export
948
+ * @interface CommissionsApiCreateCommissionClawbackRequest
949
+ */
950
+ export interface CommissionsApiCreateCommissionClawbackRequest {
951
+ /**
952
+ * Unique identifier for the object.
953
+ * @type {string}
954
+ * @memberof CommissionsApiCreateCommissionClawback
955
+ */
956
+ readonly code: string
957
+
958
+ /**
959
+ *
960
+ * @type {CreateCommissionClawbackRequestDto}
961
+ * @memberof CommissionsApiCreateCommissionClawback
962
+ */
963
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
964
+
965
+ /**
966
+ * Bearer Token: provided by the login endpoint under the name accessToken.
967
+ * @type {string}
968
+ * @memberof CommissionsApiCreateCommissionClawback
969
+ */
970
+ readonly authorization?: string
971
+ }
972
+
565
973
  /**
566
974
  * Request parameters for deleteCommission operation in CommissionsApi.
567
975
  * @export
@@ -632,6 +1040,69 @@ export interface CommissionsApiGetCommissionRequest {
632
1040
  readonly authorization?: string
633
1041
  }
634
1042
 
1043
+ /**
1044
+ * Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
1045
+ * @export
1046
+ * @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
1047
+ */
1048
+ export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
1049
+ /**
1050
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1051
+ * @type {string}
1052
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1053
+ */
1054
+ readonly authorization?: string
1055
+
1056
+ /**
1057
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1058
+ * @type {number}
1059
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1060
+ */
1061
+ readonly pageSize?: number
1062
+
1063
+ /**
1064
+ * 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.
1065
+ * @type {string}
1066
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1067
+ */
1068
+ readonly pageToken?: string
1069
+
1070
+ /**
1071
+ * 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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1072
+ * @type {string}
1073
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1074
+ */
1075
+ readonly filter?: string
1076
+
1077
+ /**
1078
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1079
+ * @type {string}
1080
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1081
+ */
1082
+ readonly search?: string
1083
+
1084
+ /**
1085
+ * 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, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
1086
+ * @type {string}
1087
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1088
+ */
1089
+ readonly order?: string
1090
+
1091
+ /**
1092
+ * 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;
1093
+ * @type {string}
1094
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1095
+ */
1096
+ readonly expand?: string
1097
+
1098
+ /**
1099
+ * 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, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
1100
+ * @type {string}
1101
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1102
+ */
1103
+ readonly filters?: string
1104
+ }
1105
+
635
1106
  /**
636
1107
  * Request parameters for listCommissions operation in CommissionsApi.
637
1108
  * @export
@@ -695,6 +1166,90 @@ export interface CommissionsApiListCommissionsRequest {
695
1166
  readonly filters?: string
696
1167
  }
697
1168
 
1169
+ /**
1170
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
1171
+ * @export
1172
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
1173
+ */
1174
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
1175
+ /**
1176
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1177
+ * @type {string}
1178
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1179
+ */
1180
+ readonly authorization?: string
1181
+
1182
+ /**
1183
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1184
+ * @type {number}
1185
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1186
+ */
1187
+ readonly pageSize?: number
1188
+
1189
+ /**
1190
+ * 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.
1191
+ * @type {string}
1192
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1193
+ */
1194
+ readonly pageToken?: string
1195
+
1196
+ /**
1197
+ * 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;
1198
+ * @type {string}
1199
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1200
+ */
1201
+ readonly filter?: string
1202
+
1203
+ /**
1204
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1205
+ * @type {string}
1206
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1207
+ */
1208
+ readonly search?: string
1209
+
1210
+ /**
1211
+ * 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;
1212
+ * @type {string}
1213
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1214
+ */
1215
+ readonly order?: string
1216
+
1217
+ /**
1218
+ * 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;
1219
+ * @type {string}
1220
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1221
+ */
1222
+ readonly expand?: string
1223
+
1224
+ /**
1225
+ * 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;
1226
+ * @type {string}
1227
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1228
+ */
1229
+ readonly filters?: string
1230
+ }
1231
+
1232
+ /**
1233
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
1234
+ * @export
1235
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
1236
+ */
1237
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
1238
+ /**
1239
+ *
1240
+ * @type {TriggerDueCommissionClawbacksRequestDto}
1241
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1242
+ */
1243
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
1244
+
1245
+ /**
1246
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1247
+ * @type {string}
1248
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1249
+ */
1250
+ readonly authorization?: string
1251
+ }
1252
+
698
1253
  /**
699
1254
  * Request parameters for updateCommission operation in CommissionsApi.
700
1255
  * @export
@@ -742,6 +1297,18 @@ export class CommissionsApi extends BaseAPI {
742
1297
  return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
743
1298
  }
744
1299
 
1300
+ /**
1301
+ * Creates a manual clawback for one commission.
1302
+ * @summary Create the commission clawback
1303
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
1304
+ * @param {*} [options] Override http request option.
1305
+ * @throws {RequiredError}
1306
+ * @memberof CommissionsApi
1307
+ */
1308
+ public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
1309
+ return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1310
+ }
1311
+
745
1312
  /**
746
1313
  * This will delete commission.
747
1314
  * @summary Delete the commission
@@ -778,6 +1345,18 @@ export class CommissionsApi extends BaseAPI {
778
1345
  return CommissionsApiFp(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
779
1346
  }
780
1347
 
1348
+ /**
1349
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
1350
+ * @summary List commission paid invoice entries
1351
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
1352
+ * @param {*} [options] Override http request option.
1353
+ * @throws {RequiredError}
1354
+ * @memberof CommissionsApi
1355
+ */
1356
+ public listCommissionPaidInvoiceEntries(requestParameters: CommissionsApiListCommissionPaidInvoiceEntriesRequest = {}, options?: AxiosRequestConfig) {
1357
+ return CommissionsApiFp(this.configuration).listCommissionPaidInvoiceEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1358
+ }
1359
+
781
1360
  /**
782
1361
  * Retrieves a list of commissions.
783
1362
  * @summary List commissions
@@ -790,6 +1369,30 @@ export class CommissionsApi extends BaseAPI {
790
1369
  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
1370
  }
792
1371
 
1372
+ /**
1373
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1374
+ * @summary List scheduled commission clawback triggers
1375
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1376
+ * @param {*} [options] Override http request option.
1377
+ * @throws {RequiredError}
1378
+ * @memberof CommissionsApi
1379
+ */
1380
+ public listScheduledCommissionClawbackTriggers(requestParameters: CommissionsApiListScheduledCommissionClawbackTriggersRequest = {}, options?: AxiosRequestConfig) {
1381
+ 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));
1382
+ }
1383
+
1384
+ /**
1385
+ * 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.
1386
+ * @summary Create the due commission clawbacks trigger
1387
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1388
+ * @param {*} [options] Override http request option.
1389
+ * @throws {RequiredError}
1390
+ * @memberof CommissionsApi
1391
+ */
1392
+ public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
1393
+ return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1394
+ }
1395
+
793
1396
  /**
794
1397
  * This will update commission.
795
1398
  * @summary Update the commission