@emilgroup/commission-sdk-node 2.9.1-beta.0 → 2.9.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-node@2.9.1-beta.0 --save
20
+ npm install @emilgroup/commission-sdk-node@2.9.1-beta.10 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/commission-sdk-node@2.9.1-beta.0
24
+ yarn add @emilgroup/commission-sdk-node@2.9.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';
@@ -93,6 +101,57 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
93
101
  options: localVarRequestOptions,
94
102
  };
95
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
+ },
96
155
  /**
97
156
  * This will delete commission.
98
157
  * @summary Delete the commission
@@ -313,6 +372,53 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
313
372
  options: localVarRequestOptions,
314
373
  };
315
374
  },
375
+ /**
376
+ * 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.
377
+ * @summary Create the due commission clawbacks trigger
378
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
379
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
380
+ * @param {*} [options] Override http request option.
381
+ * @throws {RequiredError}
382
+ */
383
+ triggerDueCommissionClawbacks: async (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
384
+ // verify required parameter 'triggerDueCommissionClawbacksRequestDto' is not null or undefined
385
+ assertParamExists('triggerDueCommissionClawbacks', 'triggerDueCommissionClawbacksRequestDto', triggerDueCommissionClawbacksRequestDto)
386
+ const localVarPath = `/commissionservice/v1/commissions/clawbacks/trigger-due`;
387
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
388
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
389
+ let baseOptions;
390
+ let baseAccessToken;
391
+ if (configuration) {
392
+ baseOptions = configuration.baseOptions;
393
+ baseAccessToken = configuration.accessToken;
394
+ }
395
+
396
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
397
+ const localVarHeaderParameter = {} as any;
398
+ const localVarQueryParameter = {} as any;
399
+
400
+ // authentication bearer required
401
+ // http bearer authentication required
402
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
403
+
404
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
405
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
406
+ }
407
+
408
+
409
+
410
+ localVarHeaderParameter['Content-Type'] = 'application/json';
411
+
412
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
413
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
414
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
415
+ localVarRequestOptions.data = serializeDataIfNeeded(triggerDueCommissionClawbacksRequestDto, localVarRequestOptions, configuration)
416
+
417
+ return {
418
+ url: toPathString(localVarUrlObj),
419
+ options: localVarRequestOptions,
420
+ };
421
+ },
316
422
  /**
317
423
  * This will update commission.
318
424
  * @summary Update the commission
@@ -386,6 +492,19 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
386
492
  const localVarAxiosArgs = await localVarAxiosParamCreator.createCommission(createCommissionRequestDto, authorization, options);
387
493
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
388
494
  },
495
+ /**
496
+ * Creates a manual clawback for one commission.
497
+ * @summary Create the commission clawback
498
+ * @param {string} code Unique identifier for the object.
499
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
500
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
501
+ * @param {*} [options] Override http request option.
502
+ * @throws {RequiredError}
503
+ */
504
+ async createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>> {
505
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options);
506
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
507
+ },
389
508
  /**
390
509
  * This will delete commission.
391
510
  * @summary Delete the commission
@@ -441,6 +560,18 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
441
560
  const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
442
561
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
443
562
  },
563
+ /**
564
+ * 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.
565
+ * @summary Create the due commission clawbacks trigger
566
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
567
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
568
+ * @param {*} [options] Override http request option.
569
+ * @throws {RequiredError}
570
+ */
571
+ async triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>> {
572
+ const localVarAxiosArgs = await localVarAxiosParamCreator.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options);
573
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
574
+ },
444
575
  /**
445
576
  * This will update commission.
446
577
  * @summary Update the commission
@@ -475,6 +606,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
475
606
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass> {
476
607
  return localVarFp.createCommission(createCommissionRequestDto, authorization, options).then((request) => request(axios, basePath));
477
608
  },
609
+ /**
610
+ * Creates a manual clawback for one commission.
611
+ * @summary Create the commission clawback
612
+ * @param {string} code Unique identifier for the object.
613
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
614
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
615
+ * @param {*} [options] Override http request option.
616
+ * @throws {RequiredError}
617
+ */
618
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass> {
619
+ return localVarFp.createCommissionClawback(code, createCommissionClawbackRequestDto, authorization, options).then((request) => request(axios, basePath));
620
+ },
478
621
  /**
479
622
  * This will delete commission.
480
623
  * @summary Delete the commission
@@ -526,6 +669,17 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
526
669
  listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
527
670
  return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
528
671
  },
672
+ /**
673
+ * 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.
674
+ * @summary Create the due commission clawbacks trigger
675
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
676
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
677
+ * @param {*} [options] Override http request option.
678
+ * @throws {RequiredError}
679
+ */
680
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass> {
681
+ return localVarFp.triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto, authorization, options).then((request) => request(axios, basePath));
682
+ },
529
683
  /**
530
684
  * This will update commission.
531
685
  * @summary Update the commission
@@ -562,6 +716,34 @@ export interface CommissionsApiCreateCommissionRequest {
562
716
  readonly authorization?: string
563
717
  }
564
718
 
719
+ /**
720
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
721
+ * @export
722
+ * @interface CommissionsApiCreateCommissionClawbackRequest
723
+ */
724
+ export interface CommissionsApiCreateCommissionClawbackRequest {
725
+ /**
726
+ * Unique identifier for the object.
727
+ * @type {string}
728
+ * @memberof CommissionsApiCreateCommissionClawback
729
+ */
730
+ readonly code: string
731
+
732
+ /**
733
+ *
734
+ * @type {CreateCommissionClawbackRequestDto}
735
+ * @memberof CommissionsApiCreateCommissionClawback
736
+ */
737
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto
738
+
739
+ /**
740
+ * Bearer Token: provided by the login endpoint under the name accessToken.
741
+ * @type {string}
742
+ * @memberof CommissionsApiCreateCommissionClawback
743
+ */
744
+ readonly authorization?: string
745
+ }
746
+
565
747
  /**
566
748
  * Request parameters for deleteCommission operation in CommissionsApi.
567
749
  * @export
@@ -695,6 +877,27 @@ export interface CommissionsApiListCommissionsRequest {
695
877
  readonly filters?: string
696
878
  }
697
879
 
880
+ /**
881
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
882
+ * @export
883
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
884
+ */
885
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
886
+ /**
887
+ *
888
+ * @type {TriggerDueCommissionClawbacksRequestDto}
889
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
890
+ */
891
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto
892
+
893
+ /**
894
+ * Bearer Token: provided by the login endpoint under the name accessToken.
895
+ * @type {string}
896
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
897
+ */
898
+ readonly authorization?: string
899
+ }
900
+
698
901
  /**
699
902
  * Request parameters for updateCommission operation in CommissionsApi.
700
903
  * @export
@@ -742,6 +945,18 @@ export class CommissionsApi extends BaseAPI {
742
945
  return CommissionsApiFp(this.configuration).createCommission(requestParameters.createCommissionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
743
946
  }
744
947
 
948
+ /**
949
+ * Creates a manual clawback for one commission.
950
+ * @summary Create the commission clawback
951
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
952
+ * @param {*} [options] Override http request option.
953
+ * @throws {RequiredError}
954
+ * @memberof CommissionsApi
955
+ */
956
+ public createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig) {
957
+ return CommissionsApiFp(this.configuration).createCommissionClawback(requestParameters.code, requestParameters.createCommissionClawbackRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
958
+ }
959
+
745
960
  /**
746
961
  * This will delete commission.
747
962
  * @summary Delete the commission
@@ -790,6 +1005,18 @@ export class CommissionsApi extends BaseAPI {
790
1005
  return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
791
1006
  }
792
1007
 
1008
+ /**
1009
+ * 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.
1010
+ * @summary Create the due commission clawbacks trigger
1011
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
1012
+ * @param {*} [options] Override http request option.
1013
+ * @throws {RequiredError}
1014
+ * @memberof CommissionsApi
1015
+ */
1016
+ public triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig) {
1017
+ return CommissionsApiFp(this.configuration).triggerDueCommissionClawbacks(requestParameters.triggerDueCommissionClawbacksRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1018
+ }
1019
+
793
1020
  /**
794
1021
  * This will update commission.
795
1022
  * @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