@emilgroup/commission-sdk 2.10.1-beta.2 → 2.10.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';
@@ -89,6 +101,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
89
101
  options: localVarRequestOptions,
90
102
  };
91
103
  },
104
+ /**
105
+ * Creates a manual clawback for one commission.
106
+ * @summary Create the commission clawback
107
+ * @param {string} code Unique identifier for the object.
108
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
109
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ createCommissionClawback: async (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
114
+ // verify required parameter 'code' is not null or undefined
115
+ assertParamExists('createCommissionClawback', 'code', code)
116
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
117
+ assertParamExists('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto)
118
+ const localVarPath = `/commissionservice/v1/commissions/{code}/clawbacks`
119
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
120
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
121
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
122
+ let baseOptions;
123
+ let baseAccessToken;
124
+ if (configuration) {
125
+ baseOptions = configuration.baseOptions;
126
+ baseAccessToken = configuration.accessToken;
127
+ }
128
+
129
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
130
+ const localVarHeaderParameter = {} as any;
131
+ const localVarQueryParameter = {} as any;
132
+
133
+ // authentication bearer required
134
+ // http bearer authentication required
135
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
136
+
137
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
138
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
139
+ }
140
+
141
+
142
+
143
+ localVarHeaderParameter['Content-Type'] = 'application/json';
144
+
145
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
146
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
147
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
148
+ localVarRequestOptions.data = serializeDataIfNeeded(createCommissionClawbackRequestDto, localVarRequestOptions, configuration)
149
+
150
+ return {
151
+ url: toPathString(localVarUrlObj),
152
+ options: localVarRequestOptions,
153
+ };
154
+ },
92
155
  /**
93
156
  * This will delete commission.
94
157
  * @summary Delete the commission
@@ -224,6 +287,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
224
287
 
225
288
 
226
289
 
290
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
291
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
292
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
293
+
294
+ return {
295
+ url: toPathString(localVarUrlObj),
296
+ options: localVarRequestOptions,
297
+ };
298
+ },
299
+ /**
300
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
301
+ * @summary List commission paid invoice entries
302
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
303
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
304
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
305
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
306
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
307
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
308
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
309
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
310
+ * @param {*} [options] Override http request option.
311
+ * @throws {RequiredError}
312
+ */
313
+ listCommissionPaidInvoiceEntries: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
314
+ const localVarPath = `/commissionservice/v1/commissions/paid-invoice-entries`;
315
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
316
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
317
+ let baseOptions;
318
+ let baseAccessToken;
319
+ if (configuration) {
320
+ baseOptions = configuration.baseOptions;
321
+ baseAccessToken = configuration.accessToken;
322
+ }
323
+
324
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
325
+ const localVarHeaderParameter = {} as any;
326
+ const localVarQueryParameter = {} as any;
327
+
328
+ // authentication bearer required
329
+ // http bearer authentication required
330
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
331
+
332
+ if (pageSize !== undefined) {
333
+ localVarQueryParameter['pageSize'] = pageSize;
334
+ }
335
+
336
+ if (pageToken !== undefined) {
337
+ localVarQueryParameter['pageToken'] = pageToken;
338
+ }
339
+
340
+ if (filter !== undefined) {
341
+ localVarQueryParameter['filter'] = filter;
342
+ }
343
+
344
+ if (search !== undefined) {
345
+ localVarQueryParameter['search'] = search;
346
+ }
347
+
348
+ if (order !== undefined) {
349
+ localVarQueryParameter['order'] = order;
350
+ }
351
+
352
+ if (expand !== undefined) {
353
+ localVarQueryParameter['expand'] = expand;
354
+ }
355
+
356
+ if (filters !== undefined) {
357
+ localVarQueryParameter['filters'] = filters;
358
+ }
359
+
360
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
361
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
362
+ }
363
+
364
+
365
+
227
366
  setSearchParams(localVarUrlObj, localVarQueryParameter);
228
367
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
229
368
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -309,6 +448,129 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
309
448
  options: localVarRequestOptions,
310
449
  };
311
450
  },
451
+ /**
452
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
453
+ * @summary List scheduled commission clawback triggers
454
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
456
+ * @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.
457
+ * @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;
458
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
459
+ * @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;
460
+ * @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;
461
+ * @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;
462
+ * @param {*} [options] Override http request option.
463
+ * @throws {RequiredError}
464
+ */
465
+ listScheduledCommissionClawbackTriggers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
466
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/scheduled-triggers`;
467
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
468
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
469
+ let baseOptions;
470
+ let baseAccessToken;
471
+ if (configuration) {
472
+ baseOptions = configuration.baseOptions;
473
+ baseAccessToken = configuration.accessToken;
474
+ }
475
+
476
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
477
+ const localVarHeaderParameter = {} as any;
478
+ const localVarQueryParameter = {} as any;
479
+
480
+ // authentication bearer required
481
+ // http bearer authentication required
482
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
483
+
484
+ if (pageSize !== undefined) {
485
+ localVarQueryParameter['pageSize'] = pageSize;
486
+ }
487
+
488
+ if (pageToken !== undefined) {
489
+ localVarQueryParameter['pageToken'] = pageToken;
490
+ }
491
+
492
+ if (filter !== undefined) {
493
+ localVarQueryParameter['filter'] = filter;
494
+ }
495
+
496
+ if (search !== undefined) {
497
+ localVarQueryParameter['search'] = search;
498
+ }
499
+
500
+ if (order !== undefined) {
501
+ localVarQueryParameter['order'] = order;
502
+ }
503
+
504
+ if (expand !== undefined) {
505
+ localVarQueryParameter['expand'] = expand;
506
+ }
507
+
508
+ if (filters !== undefined) {
509
+ localVarQueryParameter['filters'] = filters;
510
+ }
511
+
512
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
513
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
514
+ }
515
+
516
+
517
+
518
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
519
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
520
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
521
+
522
+ return {
523
+ url: toPathString(localVarUrlObj),
524
+ options: localVarRequestOptions,
525
+ };
526
+ },
527
+ /**
528
+ * 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.
529
+ * @summary Create the due commission clawbacks trigger
530
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
531
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
532
+ * @param {*} [options] Override http request option.
533
+ * @throws {RequiredError}
534
+ */
535
+ triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
536
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
537
+ assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
538
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
539
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
540
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
541
+ let baseOptions;
542
+ let baseAccessToken;
543
+ if (configuration) {
544
+ baseOptions = configuration.baseOptions;
545
+ baseAccessToken = configuration.accessToken;
546
+ }
547
+
548
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
549
+ const localVarHeaderParameter = {} as any;
550
+ const localVarQueryParameter = {} as any;
551
+
552
+ // authentication bearer required
553
+ // http bearer authentication required
554
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
555
+
556
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
557
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
558
+ }
559
+
560
+
561
+
562
+ localVarHeaderParameter['Content-Type'] = 'application/json';
563
+
564
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
565
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
566
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
567
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
568
+
569
+ return {
570
+ url: toPathString(localVarUrlObj),
571
+ options: localVarRequestOptions,
572
+ };
573
+ },
312
574
  /**
313
575
  * This will update commission.
314
576
  * @summary Update the commission
@@ -382,6 +644,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
382
644
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
383
645
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
384
646
  },
647
+ /**
648
+ * Creates a manual clawback for one commission.
649
+ * @summary Create the commission clawback
650
+ * @param {string} code Unique identifier for the object.
651
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
652
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
653
+ * @param {*} [options] Override http request option.
654
+ * @throws {RequiredError}
655
+ */
656
+ async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
657
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
658
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
659
+ },
385
660
  /**
386
661
  * This will delete commission.
387
662
  * @summary Delete the commission
@@ -419,6 +694,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
419
694
  const localVarAxiosArgs = await localVarAxiosParamCreator.getCommission(code, expand, authorization, options);
420
695
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
421
696
  },
697
+ /**
698
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
699
+ * @summary List commission paid invoice entries
700
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
701
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
702
+ * @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.
703
+ * @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;
704
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
705
+ * @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;
706
+ * @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;
707
+ * @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;
708
+ * @param {*} [options] Override http request option.
709
+ * @throws {RequiredError}
710
+ */
711
+ 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>> {
712
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
713
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
714
+ },
422
715
  /**
423
716
  * Retrieves a list of commissions.
424
717
  * @summary List commissions
@@ -437,6 +730,36 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
437
730
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
438
731
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
439
732
  },
733
+ /**
734
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
735
+ * @summary List scheduled commission clawback triggers
736
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
737
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
738
+ * @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.
739
+ * @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;
740
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
741
+ * @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;
742
+ * @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;
743
+ * @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;
744
+ * @param {*} [options] Override http request option.
745
+ * @throws {RequiredError}
746
+ */
747
+ 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>> {
748
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
749
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
750
+ },
751
+ /**
752
+ * 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.
753
+ * @summary Create the due commission clawbacks trigger
754
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
755
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
756
+ * @param {*} [options] Override http request option.
757
+ * @throws {RequiredError}
758
+ */
759
+ async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
760
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
761
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
762
+ },
440
763
  /**
441
764
  * This will update commission.
442
765
  * @summary Update the commission
@@ -471,6 +794,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
471
794
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
472
795
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
473
796
  },
797
+ /**
798
+ * Creates a manual clawback for one commission.
799
+ * @summary Create the commission clawback
800
+ * @param {string} code Unique identifier for the object.
801
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
802
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
803
+ * @param {*} [options] Override http request option.
804
+ * @throws {RequiredError}
805
+ */
806
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
807
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
808
+ },
474
809
  /**
475
810
  * This will delete commission.
476
811
  * @summary Delete the commission
@@ -505,6 +840,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
505
840
  getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass> {
506
841
  return localVarFp.getCommission(code, expand, authorization, options).then((request) => request(axios, basePath));
507
842
  },
843
+ /**
844
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
845
+ * @summary List commission paid invoice entries
846
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
847
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
848
+ * @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.
849
+ * @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;
850
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
851
+ * @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;
852
+ * @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;
853
+ * @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;
854
+ * @param {*} [options] Override http request option.
855
+ * @throws {RequiredError}
856
+ */
857
+ listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass> {
858
+ return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
859
+ },
508
860
  /**
509
861
  * Retrieves a list of commissions.
510
862
  * @summary List commissions
@@ -522,6 +874,34 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
522
874
  listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
523
875
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
524
876
  },
877
+ /**
878
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
879
+ * @summary List scheduled commission clawback triggers
880
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
881
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
882
+ * @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.
883
+ * @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;
884
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
885
+ * @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;
886
+ * @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;
887
+ * @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;
888
+ * @param {*} [options] Override http request option.
889
+ * @throws {RequiredError}
890
+ */
891
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass> {
892
+ return localVarFp.listScheduledCommissionClawbackTriggers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
893
+ },
894
+ /**
895
+ * 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.
896
+ * @summary Create the due commission clawbacks trigger
897
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
898
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
899
+ * @param {*} [options] Override http request option.
900
+ * @throws {RequiredError}
901
+ */
902
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
903
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
904
+ },
525
905
  /**
526
906
  * This will update commission.
527
907
  * @summary Update the commission
@@ -558,6 +938,34 @@ export interface CommissionsApiCreateCommissionRequest {
558
938
  readonly authorization?: string
559
939
  }
560
940
 
941
+ /**
942
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
943
+ * @export
944
+ * @interface CommissionsApiCreateCommissionClawbackRequest
945
+ */
946
+ export interface CommissionsApiCreateCommissionClawbackRequest {
947
+ /**
948
+ * Unique identifier for the object.
949
+ * @type {string}
950
+ * @memberof CommissionsApiCreateCommissionClawback
951
+ */
952
+ readonly code: string
953
+
954
+ /**
955
+ *
956
+ * @type {CreateCommissionClawbackRequestDto}
957
+ * @memberof CommissionsApiCreateCommissionClawback
958
+ */
959
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
960
+
961
+ /**
962
+ * Bearer Token: provided by the login endpoint under the name accessToken.
963
+ * @type {string}
964
+ * @memberof CommissionsApiCreateCommissionClawback
965
+ */
966
+ readonly authorization?: string
967
+ }
968
+
561
969
  /**
562
970
  * Request parameters for deleteCommission operation in CommissionsApi.
563
971
  * @export
@@ -628,6 +1036,69 @@ export interface CommissionsApiGetCommissionRequest {
628
1036
  readonly authorization?: string
629
1037
  }
630
1038
 
1039
+ /**
1040
+ * Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
1041
+ * @export
1042
+ * @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
1043
+ */
1044
+ export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
1045
+ /**
1046
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1047
+ * @type {string}
1048
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1049
+ */
1050
+ readonly authorization?: string
1051
+
1052
+ /**
1053
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1054
+ * @type {number}
1055
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1056
+ */
1057
+ readonly pageSize?: number
1058
+
1059
+ /**
1060
+ * 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.
1061
+ * @type {string}
1062
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1063
+ */
1064
+ readonly pageToken?: string
1065
+
1066
+ /**
1067
+ * 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;
1068
+ * @type {string}
1069
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1070
+ */
1071
+ readonly filter?: string
1072
+
1073
+ /**
1074
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1075
+ * @type {string}
1076
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1077
+ */
1078
+ readonly search?: string
1079
+
1080
+ /**
1081
+ * 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;
1082
+ * @type {string}
1083
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1084
+ */
1085
+ readonly order?: string
1086
+
1087
+ /**
1088
+ * 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;
1089
+ * @type {string}
1090
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1091
+ */
1092
+ readonly expand?: string
1093
+
1094
+ /**
1095
+ * 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;
1096
+ * @type {string}
1097
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
1098
+ */
1099
+ readonly filters?: string
1100
+ }
1101
+
631
1102
  /**
632
1103
  * Request parameters for listCommissions operation in CommissionsApi.
633
1104
  * @export
@@ -691,6 +1162,90 @@ export interface CommissionsApiListCommissionsRequest {
691
1162
  readonly filters?: string
692
1163
  }
693
1164
 
1165
+ /**
1166
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
1167
+ * @export
1168
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
1169
+ */
1170
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
1171
+ /**
1172
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1173
+ * @type {string}
1174
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1175
+ */
1176
+ readonly authorization?: string
1177
+
1178
+ /**
1179
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1180
+ * @type {number}
1181
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1182
+ */
1183
+ readonly pageSize?: number
1184
+
1185
+ /**
1186
+ * 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.
1187
+ * @type {string}
1188
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1189
+ */
1190
+ readonly pageToken?: string
1191
+
1192
+ /**
1193
+ * 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;
1194
+ * @type {string}
1195
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1196
+ */
1197
+ readonly filter?: string
1198
+
1199
+ /**
1200
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1201
+ * @type {string}
1202
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1203
+ */
1204
+ readonly search?: string
1205
+
1206
+ /**
1207
+ * 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;
1208
+ * @type {string}
1209
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1210
+ */
1211
+ readonly order?: string
1212
+
1213
+ /**
1214
+ * 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;
1215
+ * @type {string}
1216
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1217
+ */
1218
+ readonly expand?: string
1219
+
1220
+ /**
1221
+ * 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;
1222
+ * @type {string}
1223
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
1224
+ */
1225
+ readonly filters?: string
1226
+ }
1227
+
1228
+ /**
1229
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
1230
+ * @export
1231
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
1232
+ */
1233
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
1234
+ /**
1235
+ *
1236
+ * @type {TriggerDueCommissionClawbacksRequestDto}
1237
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1238
+ */
1239
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
1240
+
1241
+ /**
1242
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1243
+ * @type {string}
1244
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
1245
+ */
1246
+ readonly authorization?: string
1247
+ }
1248
+
694
1249
  /**
695
1250
  * Request parameters for updateCommission operation in CommissionsApi.
696
1251
  * @export
@@ -738,6 +1293,18 @@ export class CommissionsApi extends BaseAPI {
738
1293
  return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
739
1294
  }
740
1295
 
1296
+ /**
1297
+ * Creates a manual clawback for one commission.
1298
+ * @summary Create the commission clawback
1299
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
1300
+ * @param {*} [options] Override http request option.
1301
+ * @throws {RequiredError}
1302
+ * @memberof CommissionsApi
1303
+ */
1304
+ public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
1305
+ return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1306
+ }
1307
+
741
1308
  /**
742
1309
  * This will delete commission.
743
1310
  * @summary Delete the commission
@@ -774,6 +1341,18 @@ export class CommissionsApi extends BaseAPI {
774
1341
  return CommissionsApiFp(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
775
1342
  }
776
1343
 
1344
+ /**
1345
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
1346
+ * @summary List commission paid invoice entries
1347
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
1348
+ * @param {*} [options] Override http request option.
1349
+ * @throws {RequiredError}
1350
+ * @memberof CommissionsApi
1351
+ */
1352
+ public listCommissionPaidInvoiceEntries(requestParameters: CommissionsApiListCommissionPaidInvoiceEntriesRequest = {}, options?: AxiosRequestConfig) {
1353
+ 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));
1354
+ }
1355
+
777
1356
  /**
778
1357
  * Retrieves a list of commissions.
779
1358
  * @summary List commissions
@@ -786,6 +1365,30 @@ export class CommissionsApi extends BaseAPI {
786
1365
  return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
787
1366
  }
788
1367
 
1368
+ /**
1369
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
1370
+ * @summary List scheduled commission clawback triggers
1371
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
1372
+ * @param {*} [options] Override http request option.
1373
+ * @throws {RequiredError}
1374
+ * @memberof CommissionsApi
1375
+ */
1376
+ public listScheduledCommissionClawbackTriggers(requestParameters: CommissionsApiListScheduledCommissionClawbackTriggersRequest = {}, options?: AxiosRequestConfig) {
1377
+ 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));
1378
+ }
1379
+
1380
+ /**
1381
+ * 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.
1382
+ * @summary Create the due commission clawbacks trigger
1383
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1384
+ * @param {*} [options] Override http request option.
1385
+ * @throws {RequiredError}
1386
+ * @memberof CommissionsApi
1387
+ */
1388
+ public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
1389
+ return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1390
+ }
1391
+
789
1392
  /**
790
1393
  * This will update commission.
791
1394
  * @summary Update the commission