@emilgroup/commission-sdk 2.10.1-beta.0 → 2.10.1-beta.10

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 (58) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/commissions-api.ts +227 -0
  4. package/dist/api/commissions-api.d.ts +123 -0
  5. package/dist/api/commissions-api.js +192 -0
  6. package/dist/models/clawback-config-class.d.ts +36 -0
  7. package/dist/models/clawback-config-class.js +15 -0
  8. package/dist/models/clawback-config-dto.d.ts +36 -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-candidate-class.d.ts +12 -0
  12. package/dist/models/commission-class.d.ts +43 -0
  13. package/dist/models/commission-class.js +7 -0
  14. package/dist/models/commission-config-dto.d.ts +2 -1
  15. package/dist/models/commission-config-dto.js +2 -1
  16. package/dist/models/commission-estimate-class.d.ts +2 -1
  17. package/dist/models/commission-estimate-class.js +2 -1
  18. package/dist/models/create-commission-agreement-request-dto.d.ts +7 -0
  19. package/dist/models/create-commission-agreement-version-request-dto.d.ts +7 -0
  20. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  21. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  22. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  23. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  24. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  25. package/dist/models/create-commission-clawback-response-class.js +21 -0
  26. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  27. package/dist/models/create-commission-item-request-dto.js +2 -1
  28. package/dist/models/create-commission-request-dto.d.ts +6 -0
  29. package/dist/models/evaluated-commission-class.d.ts +2 -1
  30. package/dist/models/evaluated-commission-class.js +2 -1
  31. package/dist/models/index.d.ts +6 -0
  32. package/dist/models/index.js +6 -0
  33. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  34. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  35. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  36. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  37. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  38. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  39. package/models/clawback-config-class.ts +42 -0
  40. package/models/clawback-config-dto.ts +42 -0
  41. package/models/commission-agreement-version-class.ts +7 -0
  42. package/models/commission-candidate-class.ts +12 -0
  43. package/models/commission-class.ts +46 -0
  44. package/models/commission-config-dto.ts +3 -2
  45. package/models/commission-estimate-class.ts +3 -2
  46. package/models/create-commission-agreement-request-dto.ts +7 -0
  47. package/models/create-commission-agreement-version-request-dto.ts +7 -0
  48. package/models/create-commission-candidate-request-dto.ts +16 -3
  49. package/models/create-commission-clawback-request-dto.ts +30 -0
  50. package/models/create-commission-clawback-response-class.ts +52 -0
  51. package/models/create-commission-item-request-dto.ts +3 -2
  52. package/models/create-commission-request-dto.ts +6 -0
  53. package/models/evaluated-commission-class.ts +3 -2
  54. package/models/index.ts +6 -0
  55. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  56. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  57. package/models/update-commission-candidate-request-dto.ts +3 -2
  58. package/package.json +1 -1
@@ -17,6 +17,8 @@ common.ts
17
17
  configuration.ts
18
18
  git_push.sh
19
19
  index.ts
20
+ models/clawback-config-class.ts
21
+ models/clawback-config-dto.ts
20
22
  models/commission-agreement-class.ts
21
23
  models/commission-agreement-metadata-dto.ts
22
24
  models/commission-agreement-metadata-partner-dto.ts
@@ -43,6 +45,8 @@ models/create-commission-agreement-version-request-dto.ts
43
45
  models/create-commission-agreement-version-response-class.ts
44
46
  models/create-commission-candidate-request-dto.ts
45
47
  models/create-commission-candidate-response-class.ts
48
+ models/create-commission-clawback-request-dto.ts
49
+ models/create-commission-clawback-response-class.ts
46
50
  models/create-commission-item-request-dto.ts
47
51
  models/create-commission-recipient-for-products-request-dto.ts
48
52
  models/create-commission-recipient-for-products-response-class.ts
@@ -83,6 +87,8 @@ models/publish-commission-settlements-request-dto.ts
83
87
  models/publish-commission-settlements-response-class.ts
84
88
  models/trigger-commission-settlement-creation-request-dto.ts
85
89
  models/trigger-commission-settlement-creation-response-class.ts
90
+ models/trigger-due-commission-clawbacks-request-dto.ts
91
+ models/trigger-due-commission-clawbacks-response-class.ts
86
92
  models/update-commission-agreement-product-request-dto.ts
87
93
  models/update-commission-agreement-product-response-class.ts
88
94
  models/update-commission-agreement-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/commission-sdk@2.10.1-beta.0 --save
20
+ npm install @emilgroup/commission-sdk@2.10.1-beta.10 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk@2.10.1-beta.0
24
+ yarn add @emilgroup/commission-sdk@2.10.1-beta.10
25
25
  ```
26
26
 
27
27
  And then you can import `CommissionApi`.
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { CreateCommissionClawbackRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateCommissionClawbackResponseClass } from '../models';
27
+ // @ts-ignore
24
28
  import { CreateCommissionRequestDto } from '../models';
25
29
  // @ts-ignore
26
30
  import { CreateCommissionResponseClass } from '../models';
@@ -33,6 +37,10 @@ import { GetCommissionResponseClass } from '../models';
33
37
  // @ts-ignore
34
38
  import { ListCommissionsResponseClass } from '../models';
35
39
  // @ts-ignore
40
+ import { TriggerDueCommissionClawbacksRequestDto } from '../models';
41
+ // @ts-ignore
42
+ import { TriggerDueCommissionClawbacksResponseClass } from '../models';
43
+ // @ts-ignore
36
44
  import { UpdateCommissionRequestDto } from '../models';
37
45
  // @ts-ignore
38
46
  import { UpdateCommissionResponseClass } from '../models';
@@ -89,6 +97,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
89
97
  options: localVarRequestOptions,
90
98
  };
91
99
  },
100
+ /**
101
+ * Creates a manual clawback for one commission.
102
+ * @summary Create the commission clawback
103
+ * @param {string} code Unique identifier for the object.
104
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
105
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ createCommissionClawback: async (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
110
+ // verify required parameter 'code' is not null or undefined
111
+ assertParamExists('createCommissionClawback', 'code', code)
112
+ // verify required parameter 'createCommissionClawbackRequestDto' is not null or undefined
113
+ assertParamExists('createCommissionClawback', 'createCommissionClawbackRequestDto', createCommissionClawbackRequestDto)
114
+ const localVarPath = `/commissionservice/v1/commissions/{code}/clawbacks`
115
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
116
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
117
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
118
+ let baseOptions;
119
+ let baseAccessToken;
120
+ if (configuration) {
121
+ baseOptions = configuration.baseOptions;
122
+ baseAccessToken = configuration.accessToken;
123
+ }
124
+
125
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
126
+ const localVarHeaderParameter = {} as any;
127
+ const localVarQueryParameter = {} as any;
128
+
129
+ // authentication bearer required
130
+ // http bearer authentication required
131
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
132
+
133
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
134
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
135
+ }
136
+
137
+
138
+
139
+ localVarHeaderParameter['Content-Type'] = 'application/json';
140
+
141
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
142
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
143
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
144
+ localVarRequestOptions.data = serializeDataIfNeeded(createCommissionClawbackRequestDto, localVarRequestOptions, configuration)
145
+
146
+ return {
147
+ url: toPathString(localVarUrlObj),
148
+ options: localVarRequestOptions,
149
+ };
150
+ },
92
151
  /**
93
152
  * This will delete commission.
94
153
  * @summary Delete the commission
@@ -309,6 +368,53 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
309
368
  options: localVarRequestOptions,
310
369
  };
311
370
  },
371
+ /**
372
+ * 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.
373
+ * @summary Create the due commission clawbacks trigger
374
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
375
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
376
+ * @param {*} [options] Override http request option.
377
+ * @throws {RequiredError}
378
+ */
379
+ triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
380
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
381
+ assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
382
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
383
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
384
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
385
+ let baseOptions;
386
+ let baseAccessToken;
387
+ if (configuration) {
388
+ baseOptions = configuration.baseOptions;
389
+ baseAccessToken = configuration.accessToken;
390
+ }
391
+
392
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
393
+ const localVarHeaderParameter = {} as any;
394
+ const localVarQueryParameter = {} as any;
395
+
396
+ // authentication bearer required
397
+ // http bearer authentication required
398
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
399
+
400
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
401
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
402
+ }
403
+
404
+
405
+
406
+ localVarHeaderParameter['Content-Type'] = 'application/json';
407
+
408
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
409
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
410
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
411
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
412
+
413
+ return {
414
+ url: toPathString(localVarUrlObj),
415
+ options: localVarRequestOptions,
416
+ };
417
+ },
312
418
  /**
313
419
  * This will update commission.
314
420
  * @summary Update the commission
@@ -382,6 +488,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
382
488
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
383
489
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
384
490
  },
491
+ /**
492
+ * Creates a manual clawback for one commission.
493
+ * @summary Create the commission clawback
494
+ * @param {string} code Unique identifier for the object.
495
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
496
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
+ * @param {*} [options] Override http request option.
498
+ * @throws {RequiredError}
499
+ */
500
+ async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
501
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
502
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
503
+ },
385
504
  /**
386
505
  * This will delete commission.
387
506
  * @summary Delete the commission
@@ -437,6 +556,18 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
437
556
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
438
557
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
439
558
  },
559
+ /**
560
+ * 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.
561
+ * @summary Create the due commission clawbacks trigger
562
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
563
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
564
+ * @param {*} [options] Override http request option.
565
+ * @throws {RequiredError}
566
+ */
567
+ async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
568
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
569
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
570
+ },
440
571
  /**
441
572
  * This will update commission.
442
573
  * @summary Update the commission
@@ -471,6 +602,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
471
602
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
472
603
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
473
604
  },
605
+ /**
606
+ * Creates a manual clawback for one commission.
607
+ * @summary Create the commission clawback
608
+ * @param {string} code Unique identifier for the object.
609
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
610
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
611
+ * @param {*} [options] Override http request option.
612
+ * @throws {RequiredError}
613
+ */
614
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
615
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
616
+ },
474
617
  /**
475
618
  * This will delete commission.
476
619
  * @summary Delete the commission
@@ -522,6 +665,17 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
522
665
  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
666
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
524
667
  },
668
+ /**
669
+ * 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.
670
+ * @summary Create the due commission clawbacks trigger
671
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
672
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
673
+ * @param {*} [options] Override http request option.
674
+ * @throws {RequiredError}
675
+ */
676
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
677
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
678
+ },
525
679
  /**
526
680
  * This will update commission.
527
681
  * @summary Update the commission
@@ -558,6 +712,34 @@ export interface CommissionsApiCreateCommissionRequest {
558
712
  readonly authorization?: string
559
713
  }
560
714
 
715
+ /**
716
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
717
+ * @export
718
+ * @interface CommissionsApiCreateCommissionClawbackRequest
719
+ */
720
+ export interface CommissionsApiCreateCommissionClawbackRequest {
721
+ /**
722
+ * Unique identifier for the object.
723
+ * @type {string}
724
+ * @memberof CommissionsApiCreateCommissionClawback
725
+ */
726
+ readonly code: string
727
+
728
+ /**
729
+ *
730
+ * @type {CreateCommissionClawbackRequestDto}
731
+ * @memberof CommissionsApiCreateCommissionClawback
732
+ */
733
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
734
+
735
+ /**
736
+ * Bearer Token: provided by the login endpoint under the name accessToken.
737
+ * @type {string}
738
+ * @memberof CommissionsApiCreateCommissionClawback
739
+ */
740
+ readonly authorization?: string
741
+ }
742
+
561
743
  /**
562
744
  * Request parameters for deleteCommission operation in CommissionsApi.
563
745
  * @export
@@ -691,6 +873,27 @@ export interface CommissionsApiListCommissionsRequest {
691
873
  readonly filters?: string
692
874
  }
693
875
 
876
+ /**
877
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
878
+ * @export
879
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
880
+ */
881
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
882
+ /**
883
+ *
884
+ * @type {TriggerDueCommissionClawbacksRequestDto}
885
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
886
+ */
887
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
888
+
889
+ /**
890
+ * Bearer Token: provided by the login endpoint under the name accessToken.
891
+ * @type {string}
892
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
893
+ */
894
+ readonly authorization?: string
895
+ }
896
+
694
897
  /**
695
898
  * Request parameters for updateCommission operation in CommissionsApi.
696
899
  * @export
@@ -738,6 +941,18 @@ export class CommissionsApi extends BaseAPI {
738
941
  return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
739
942
  }
740
943
 
944
+ /**
945
+ * Creates a manual clawback for one commission.
946
+ * @summary Create the commission clawback
947
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
948
+ * @param {*} [options] Override http request option.
949
+ * @throws {RequiredError}
950
+ * @memberof CommissionsApi
951
+ */
952
+ public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
953
+ return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
954
+ }
955
+
741
956
  /**
742
957
  * This will delete commission.
743
958
  * @summary Delete the commission
@@ -786,6 +1001,18 @@ export class CommissionsApi extends BaseAPI {
786
1001
  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
1002
  }
788
1003
 
1004
+ /**
1005
+ * 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.
1006
+ * @summary Create the due commission clawbacks trigger
1007
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1008
+ * @param {*} [options] Override http request option.
1009
+ * @throws {RequiredError}
1010
+ * @memberof CommissionsApi
1011
+ */
1012
+ public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
1013
+ return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1014
+ }
1015
+
789
1016
  /**
790
1017
  * This will update commission.
791
1018
  * @summary Update the commission
@@ -12,12 +12,16 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateCommissionClawbackRequestDto } from '../models';
16
+ import { CreateCommissionClawbackResponseClass } from '../models';
15
17
  import { CreateCommissionRequestDto } from '../models';
16
18
  import { CreateCommissionResponseClass } from '../models';
17
19
  import { EstimateCommissionsRequestDto } from '../models';
18
20
  import { EstimateCommissionsResponseClass } from '../models';
19
21
  import { GetCommissionResponseClass } from '../models';
20
22
  import { ListCommissionsResponseClass } from '../models';
23
+ import { TriggerDueCommissionClawbacksRequestDto } from '../models';
24
+ import { TriggerDueCommissionClawbacksResponseClass } from '../models';
21
25
  import { UpdateCommissionRequestDto } from '../models';
22
26
  import { UpdateCommissionResponseClass } from '../models';
23
27
  /**
@@ -34,6 +38,16 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
34
38
  * @throws {RequiredError}
35
39
  */
36
40
  createCommission: (createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
+ /**
42
+ * Creates a manual clawback for one commission.
43
+ * @summary Create the commission clawback
44
+ * @param {string} code Unique identifier for the object.
45
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
46
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ createCommissionClawback: (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
51
  /**
38
52
  * This will delete commission.
39
53
  * @summary Delete the commission
@@ -77,6 +91,15 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
77
91
  * @throws {RequiredError}
78
92
  */
79
93
  listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
94
+ /**
95
+ * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
96
+ * @summary Create the due commission clawbacks trigger
97
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ triggerDueCommissionClawbacks: (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
103
  /**
81
104
  * This will update commission.
82
105
  * @summary Update the commission
@@ -102,6 +125,16 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
102
125
  * @throws {RequiredError}
103
126
  */
104
127
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionResponseClass>>;
128
+ /**
129
+ * Creates a manual clawback for one commission.
130
+ * @summary Create the commission clawback
131
+ * @param {string} code Unique identifier for the object.
132
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
133
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
134
+ * @param {*} [options] Override http request option.
135
+ * @throws {RequiredError}
136
+ */
137
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>>;
105
138
  /**
106
139
  * This will delete commission.
107
140
  * @summary Delete the commission
@@ -145,6 +178,15 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
145
178
  * @throws {RequiredError}
146
179
  */
147
180
  listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
181
+ /**
182
+ * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
183
+ * @summary Create the due commission clawbacks trigger
184
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
185
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ */
189
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>>;
148
190
  /**
149
191
  * This will update commission.
150
192
  * @summary Update the commission
@@ -170,6 +212,16 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
170
212
  * @throws {RequiredError}
171
213
  */
172
214
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass>;
215
+ /**
216
+ * Creates a manual clawback for one commission.
217
+ * @summary Create the commission clawback
218
+ * @param {string} code Unique identifier for the object.
219
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
220
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
221
+ * @param {*} [options] Override http request option.
222
+ * @throws {RequiredError}
223
+ */
224
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass>;
173
225
  /**
174
226
  * This will delete commission.
175
227
  * @summary Delete the commission
@@ -213,6 +265,15 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
213
265
  * @throws {RequiredError}
214
266
  */
215
267
  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>;
268
+ /**
269
+ * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
270
+ * @summary Create the due commission clawbacks trigger
271
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
272
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
273
+ * @param {*} [options] Override http request option.
274
+ * @throws {RequiredError}
275
+ */
276
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass>;
216
277
  /**
217
278
  * This will update commission.
218
279
  * @summary Update the commission
@@ -243,6 +304,31 @@ export interface CommissionsApiCreateCommissionRequest {
243
304
  */
244
305
  readonly authorization?: string;
245
306
  }
307
+ /**
308
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
309
+ * @export
310
+ * @interface CommissionsApiCreateCommissionClawbackRequest
311
+ */
312
+ export interface CommissionsApiCreateCommissionClawbackRequest {
313
+ /**
314
+ * Unique identifier for the object.
315
+ * @type {string}
316
+ * @memberof CommissionsApiCreateCommissionClawback
317
+ */
318
+ readonly code: string;
319
+ /**
320
+ *
321
+ * @type {CreateCommissionClawbackRequestDto}
322
+ * @memberof CommissionsApiCreateCommissionClawback
323
+ */
324
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto;
325
+ /**
326
+ * Bearer Token: provided by the login endpoint under the name accessToken.
327
+ * @type {string}
328
+ * @memberof CommissionsApiCreateCommissionClawback
329
+ */
330
+ readonly authorization?: string;
331
+ }
246
332
  /**
247
333
  * Request parameters for deleteCommission operation in CommissionsApi.
248
334
  * @export
@@ -361,6 +447,25 @@ export interface CommissionsApiListCommissionsRequest {
361
447
  */
362
448
  readonly filters?: string;
363
449
  }
450
+ /**
451
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
452
+ * @export
453
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
454
+ */
455
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
456
+ /**
457
+ *
458
+ * @type {TriggerDueCommissionClawbacksRequestDto}
459
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
460
+ */
461
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto;
462
+ /**
463
+ * Bearer Token: provided by the login endpoint under the name accessToken.
464
+ * @type {string}
465
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
466
+ */
467
+ readonly authorization?: string;
468
+ }
364
469
  /**
365
470
  * Request parameters for updateCommission operation in CommissionsApi.
366
471
  * @export
@@ -402,6 +507,15 @@ export declare class CommissionsApi extends BaseAPI {
402
507
  * @memberof CommissionsApi
403
508
  */
404
509
  createCommission(requestParameters: CommissionsApiCreateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionResponseClass, any, {}>>;
510
+ /**
511
+ * Creates a manual clawback for one commission.
512
+ * @summary Create the commission clawback
513
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
514
+ * @param {*} [options] Override http request option.
515
+ * @throws {RequiredError}
516
+ * @memberof CommissionsApi
517
+ */
518
+ createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionClawbackResponseClass, any, {}>>;
405
519
  /**
406
520
  * This will delete commission.
407
521
  * @summary Delete the commission
@@ -438,6 +552,15 @@ export declare class CommissionsApi extends BaseAPI {
438
552
  * @memberof CommissionsApi
439
553
  */
440
554
  listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
555
+ /**
556
+ * Requests due scheduled commission clawbacks processing by enqueueing a trigger message. The endpoint returns after the message is sent and does not wait for the job to finish.
557
+ * @summary Create the due commission clawbacks trigger
558
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
559
+ * @param {*} [options] Override http request option.
560
+ * @throws {RequiredError}
561
+ * @memberof CommissionsApi
562
+ */
563
+ triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerDueCommissionClawbacksResponseClass, any, {}>>;
441
564
  /**
442
565
  * This will update commission.
443
566
  * @summary Update the commission