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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/.openapi-generator/FILES +18 -0
  2. package/README.md +2 -2
  3. package/api/commissions-api.ts +603 -0
  4. package/dist/api/commissions-api.d.ts +343 -0
  5. package/dist/api/commissions-api.js +450 -0
  6. package/dist/models/clawback-config-class.d.ts +42 -0
  7. package/dist/models/clawback-config-class.js +15 -0
  8. package/dist/models/clawback-config-dto.d.ts +42 -0
  9. package/dist/models/clawback-config-dto.js +15 -0
  10. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  11. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  12. package/dist/models/commission-agreement-version-config-class.js +15 -0
  13. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  14. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  15. package/dist/models/commission-candidate-class.d.ts +12 -0
  16. package/dist/models/commission-class.d.ts +38 -0
  17. package/dist/models/commission-class.js +8 -0
  18. package/dist/models/commission-config-dto.d.ts +2 -1
  19. package/dist/models/commission-config-dto.js +2 -1
  20. package/dist/models/commission-creation-config-class.d.ts +43 -0
  21. package/dist/models/commission-creation-config-class.js +20 -0
  22. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  23. package/dist/models/commission-creation-config-dto.js +20 -0
  24. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  25. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  26. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  27. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  28. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  29. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  30. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  31. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  32. package/dist/models/commission-estimate-class.d.ts +2 -1
  33. package/dist/models/commission-estimate-class.js +2 -1
  34. package/dist/models/commission-paid-invoice-entry-class.d.ts +108 -0
  35. package/dist/models/commission-paid-invoice-entry-class.js +21 -0
  36. package/dist/models/create-commission-agreement-request-dto.d.ts +7 -0
  37. package/dist/models/create-commission-agreement-version-request-dto.d.ts +7 -0
  38. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  39. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  40. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  41. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  42. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  43. package/dist/models/create-commission-clawback-response-class.js +21 -0
  44. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  45. package/dist/models/create-commission-item-request-dto.js +2 -1
  46. package/dist/models/create-commission-request-dto.d.ts +6 -0
  47. package/dist/models/evaluated-commission-class.d.ts +2 -1
  48. package/dist/models/evaluated-commission-class.js +2 -1
  49. package/dist/models/index.d.ts +18 -0
  50. package/dist/models/index.js +18 -0
  51. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  52. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  53. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  54. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  55. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  56. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  57. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  58. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  59. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  60. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  61. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  62. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  63. package/models/clawback-config-class.ts +48 -0
  64. package/models/clawback-config-dto.ts +48 -0
  65. package/models/commission-agreement-version-class.ts +7 -0
  66. package/models/commission-agreement-version-config-class.ts +38 -0
  67. package/models/commission-agreement-version-config-dto.ts +38 -0
  68. package/models/commission-candidate-class.ts +12 -0
  69. package/models/commission-class.ts +41 -0
  70. package/models/commission-config-dto.ts +3 -2
  71. package/models/commission-creation-config-class.ts +52 -0
  72. package/models/commission-creation-config-dto.ts +52 -0
  73. package/models/commission-creation-invoice-config-class.ts +30 -0
  74. package/models/commission-creation-invoice-config-dto.ts +30 -0
  75. package/models/commission-creation-renewal-config-class.ts +38 -0
  76. package/models/commission-creation-renewal-config-dto.ts +38 -0
  77. package/models/commission-estimate-class.ts +3 -2
  78. package/models/commission-paid-invoice-entry-class.ts +117 -0
  79. package/models/create-commission-agreement-request-dto.ts +7 -0
  80. package/models/create-commission-agreement-version-request-dto.ts +7 -0
  81. package/models/create-commission-candidate-request-dto.ts +16 -3
  82. package/models/create-commission-clawback-request-dto.ts +30 -0
  83. package/models/create-commission-clawback-response-class.ts +52 -0
  84. package/models/create-commission-item-request-dto.ts +3 -2
  85. package/models/create-commission-request-dto.ts +6 -0
  86. package/models/evaluated-commission-class.ts +3 -2
  87. package/models/index.ts +18 -0
  88. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  89. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  90. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  91. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  92. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  93. package/models/update-commission-candidate-request-dto.ts +3 -2
  94. package/package.json +1 -1
@@ -12,12 +12,18 @@
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';
22
+ import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
20
23
  import { ListCommissionsResponseClass } from '../models';
24
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
25
+ import { TriggerDueCommissionClawbacksRequestDto } from '../models';
26
+ import { TriggerDueCommissionClawbacksResponseClass } from '../models';
21
27
  import { UpdateCommissionRequestDto } from '../models';
22
28
  import { UpdateCommissionResponseClass } from '../models';
23
29
  /**
@@ -34,6 +40,16 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
34
40
  * @throws {RequiredError}
35
41
  */
36
42
  createCommission: (createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ * Creates a manual clawback for one commission.
45
+ * @summary Create the commission clawback
46
+ * @param {string} code Unique identifier for the object.
47
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
48
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ createCommissionClawback: (code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
53
  /**
38
54
  * This will delete commission.
39
55
  * @summary Delete the commission
@@ -62,6 +78,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
62
78
  * @throws {RequiredError}
63
79
  */
64
80
  getCommission: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
81
+ /**
82
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
83
+ * @summary List commission paid invoice entries
84
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
86
+ * @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.
87
+ * @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;
88
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
89
+ * @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;
90
+ * @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;
91
+ * @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;
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ listCommissionPaidInvoiceEntries: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
96
  /**
66
97
  * Retrieves a list of commissions.
67
98
  * @summary List commissions
@@ -77,6 +108,30 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
77
108
  * @throws {RequiredError}
78
109
  */
79
110
  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>;
111
+ /**
112
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
113
+ * @summary List scheduled commission clawback triggers
114
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
115
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
116
+ * @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.
117
+ * @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;
118
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
119
+ * @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;
120
+ * @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;
121
+ * @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;
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ */
125
+ listScheduledCommissionClawbackTriggers: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
126
+ /**
127
+ * 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.
128
+ * @summary Create the due commission clawbacks trigger
129
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
130
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ */
134
+ triggerDueCommissionClawbacks: (triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
135
  /**
81
136
  * This will update commission.
82
137
  * @summary Update the commission
@@ -102,6 +157,16 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
102
157
  * @throws {RequiredError}
103
158
  */
104
159
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionResponseClass>>;
160
+ /**
161
+ * Creates a manual clawback for one commission.
162
+ * @summary Create the commission clawback
163
+ * @param {string} code Unique identifier for the object.
164
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
165
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionClawbackResponseClass>>;
105
170
  /**
106
171
  * This will delete commission.
107
172
  * @summary Delete the commission
@@ -130,6 +195,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
130
195
  * @throws {RequiredError}
131
196
  */
132
197
  getCommission(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionResponseClass>>;
198
+ /**
199
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
200
+ * @summary List commission paid invoice entries
201
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
203
+ * @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.
204
+ * @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;
205
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
206
+ * @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;
207
+ * @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;
208
+ * @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;
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ 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>>;
133
213
  /**
134
214
  * Retrieves a list of commissions.
135
215
  * @summary List commissions
@@ -145,6 +225,30 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
145
225
  * @throws {RequiredError}
146
226
  */
147
227
  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>>;
228
+ /**
229
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
230
+ * @summary List scheduled commission clawback triggers
231
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
232
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
233
+ * @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.
234
+ * @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;
235
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
236
+ * @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;
237
+ * @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;
238
+ * @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;
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ */
242
+ 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>>;
243
+ /**
244
+ * 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.
245
+ * @summary Create the due commission clawbacks trigger
246
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
247
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
248
+ * @param {*} [options] Override http request option.
249
+ * @throws {RequiredError}
250
+ */
251
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerDueCommissionClawbacksResponseClass>>;
148
252
  /**
149
253
  * This will update commission.
150
254
  * @summary Update the commission
@@ -170,6 +274,16 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
170
274
  * @throws {RequiredError}
171
275
  */
172
276
  createCommission(createCommissionRequestDto: CreateCommissionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionResponseClass>;
277
+ /**
278
+ * Creates a manual clawback for one commission.
279
+ * @summary Create the commission clawback
280
+ * @param {string} code Unique identifier for the object.
281
+ * @param {CreateCommissionClawbackRequestDto} createCommissionClawbackRequestDto
282
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ */
286
+ createCommissionClawback(code: string, createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionClawbackResponseClass>;
173
287
  /**
174
288
  * This will delete commission.
175
289
  * @summary Delete the commission
@@ -198,6 +312,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
198
312
  * @throws {RequiredError}
199
313
  */
200
314
  getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass>;
315
+ /**
316
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
317
+ * @summary List commission paid invoice entries
318
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
319
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
320
+ * @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.
321
+ * @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;
322
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
323
+ * @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;
324
+ * @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;
325
+ * @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;
326
+ * @param {*} [options] Override http request option.
327
+ * @throws {RequiredError}
328
+ */
329
+ listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>;
201
330
  /**
202
331
  * Retrieves a list of commissions.
203
332
  * @summary List commissions
@@ -213,6 +342,30 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
213
342
  * @throws {RequiredError}
214
343
  */
215
344
  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>;
345
+ /**
346
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
347
+ * @summary List scheduled commission clawback triggers
348
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
349
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
350
+ * @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.
351
+ * @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;
352
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
353
+ * @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;
354
+ * @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;
355
+ * @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;
356
+ * @param {*} [options] Override http request option.
357
+ * @throws {RequiredError}
358
+ */
359
+ listScheduledCommissionClawbackTriggers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListScheduledCommissionClawbackTriggersResponseClass>;
360
+ /**
361
+ * 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.
362
+ * @summary Create the due commission clawbacks trigger
363
+ * @param {TriggerDueCommissionClawbacksRequestDto} triggerDueCommissionClawbacksRequestDto
364
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
365
+ * @param {*} [options] Override http request option.
366
+ * @throws {RequiredError}
367
+ */
368
+ triggerDueCommissionClawbacks(triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerDueCommissionClawbacksResponseClass>;
216
369
  /**
217
370
  * This will update commission.
218
371
  * @summary Update the commission
@@ -243,6 +396,31 @@ export interface CommissionsApiCreateCommissionRequest {
243
396
  */
244
397
  readonly authorization?: string;
245
398
  }
399
+ /**
400
+ * Request parameters for createCommissionClawback operation in CommissionsApi.
401
+ * @export
402
+ * @interface CommissionsApiCreateCommissionClawbackRequest
403
+ */
404
+ export interface CommissionsApiCreateCommissionClawbackRequest {
405
+ /**
406
+ * Unique identifier for the object.
407
+ * @type {string}
408
+ * @memberof CommissionsApiCreateCommissionClawback
409
+ */
410
+ readonly code: string;
411
+ /**
412
+ *
413
+ * @type {CreateCommissionClawbackRequestDto}
414
+ * @memberof CommissionsApiCreateCommissionClawback
415
+ */
416
+ readonly createCommissionClawbackRequestDto: CreateCommissionClawbackRequestDto;
417
+ /**
418
+ * Bearer Token: provided by the login endpoint under the name accessToken.
419
+ * @type {string}
420
+ * @memberof CommissionsApiCreateCommissionClawback
421
+ */
422
+ readonly authorization?: string;
423
+ }
246
424
  /**
247
425
  * Request parameters for deleteCommission operation in CommissionsApi.
248
426
  * @export
@@ -306,6 +484,61 @@ export interface CommissionsApiGetCommissionRequest {
306
484
  */
307
485
  readonly authorization?: string;
308
486
  }
487
+ /**
488
+ * Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
489
+ * @export
490
+ * @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
491
+ */
492
+ export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
493
+ /**
494
+ * Bearer Token: provided by the login endpoint under the name accessToken.
495
+ * @type {string}
496
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
497
+ */
498
+ readonly authorization?: string;
499
+ /**
500
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
501
+ * @type {number}
502
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
503
+ */
504
+ readonly pageSize?: number;
505
+ /**
506
+ * 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.
507
+ * @type {string}
508
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
509
+ */
510
+ readonly pageToken?: string;
511
+ /**
512
+ * 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;
513
+ * @type {string}
514
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
515
+ */
516
+ readonly filter?: string;
517
+ /**
518
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
519
+ * @type {string}
520
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
521
+ */
522
+ readonly search?: string;
523
+ /**
524
+ * 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;
525
+ * @type {string}
526
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
527
+ */
528
+ readonly order?: string;
529
+ /**
530
+ * 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;
531
+ * @type {string}
532
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
533
+ */
534
+ readonly expand?: string;
535
+ /**
536
+ * 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;
537
+ * @type {string}
538
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
539
+ */
540
+ readonly filters?: string;
541
+ }
309
542
  /**
310
543
  * Request parameters for listCommissions operation in CommissionsApi.
311
544
  * @export
@@ -361,6 +594,80 @@ export interface CommissionsApiListCommissionsRequest {
361
594
  */
362
595
  readonly filters?: string;
363
596
  }
597
+ /**
598
+ * Request parameters for listScheduledCommissionClawbackTriggers operation in CommissionsApi.
599
+ * @export
600
+ * @interface CommissionsApiListScheduledCommissionClawbackTriggersRequest
601
+ */
602
+ export interface CommissionsApiListScheduledCommissionClawbackTriggersRequest {
603
+ /**
604
+ * Bearer Token: provided by the login endpoint under the name accessToken.
605
+ * @type {string}
606
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
607
+ */
608
+ readonly authorization?: string;
609
+ /**
610
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
611
+ * @type {number}
612
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
613
+ */
614
+ readonly pageSize?: number;
615
+ /**
616
+ * 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.
617
+ * @type {string}
618
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
619
+ */
620
+ readonly pageToken?: string;
621
+ /**
622
+ * 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;
623
+ * @type {string}
624
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
625
+ */
626
+ readonly filter?: string;
627
+ /**
628
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
629
+ * @type {string}
630
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
631
+ */
632
+ readonly search?: string;
633
+ /**
634
+ * 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;
635
+ * @type {string}
636
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
637
+ */
638
+ readonly order?: string;
639
+ /**
640
+ * 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;
641
+ * @type {string}
642
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
643
+ */
644
+ readonly expand?: string;
645
+ /**
646
+ * 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;
647
+ * @type {string}
648
+ * @memberof CommissionsApiListScheduledCommissionClawbackTriggers
649
+ */
650
+ readonly filters?: string;
651
+ }
652
+ /**
653
+ * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
654
+ * @export
655
+ * @interface CommissionsApiTriggerDueCommissionClawbacksRequest
656
+ */
657
+ export interface CommissionsApiTriggerDueCommissionClawbacksRequest {
658
+ /**
659
+ *
660
+ * @type {TriggerDueCommissionClawbacksRequestDto}
661
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
662
+ */
663
+ readonly triggerDueCommissionClawbacksRequestDto: TriggerDueCommissionClawbacksRequestDto;
664
+ /**
665
+ * Bearer Token: provided by the login endpoint under the name accessToken.
666
+ * @type {string}
667
+ * @memberof CommissionsApiTriggerDueCommissionClawbacks
668
+ */
669
+ readonly authorization?: string;
670
+ }
364
671
  /**
365
672
  * Request parameters for updateCommission operation in CommissionsApi.
366
673
  * @export
@@ -402,6 +709,15 @@ export declare class CommissionsApi extends BaseAPI {
402
709
  * @memberof CommissionsApi
403
710
  */
404
711
  createCommission(requestParameters: CommissionsApiCreateCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionResponseClass, any, {}>>;
712
+ /**
713
+ * Creates a manual clawback for one commission.
714
+ * @summary Create the commission clawback
715
+ * @param {CommissionsApiCreateCommissionClawbackRequest} requestParameters Request parameters.
716
+ * @param {*} [options] Override http request option.
717
+ * @throws {RequiredError}
718
+ * @memberof CommissionsApi
719
+ */
720
+ createCommissionClawback(requestParameters: CommissionsApiCreateCommissionClawbackRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionClawbackResponseClass, any, {}>>;
405
721
  /**
406
722
  * This will delete commission.
407
723
  * @summary Delete the commission
@@ -429,6 +745,15 @@ export declare class CommissionsApi extends BaseAPI {
429
745
  * @memberof CommissionsApi
430
746
  */
431
747
  getCommission(requestParameters: CommissionsApiGetCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionResponseClass, any, {}>>;
748
+ /**
749
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
750
+ * @summary List commission paid invoice entries
751
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
752
+ * @param {*} [options] Override http request option.
753
+ * @throws {RequiredError}
754
+ * @memberof CommissionsApi
755
+ */
756
+ listCommissionPaidInvoiceEntries(requestParameters?: CommissionsApiListCommissionPaidInvoiceEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionPaidInvoiceEntriesResponseClass, any, {}>>;
432
757
  /**
433
758
  * Retrieves a list of commissions.
434
759
  * @summary List commissions
@@ -438,6 +763,24 @@ export declare class CommissionsApi extends BaseAPI {
438
763
  * @memberof CommissionsApi
439
764
  */
440
765
  listCommissions(requestParameters?: CommissionsApiListCommissionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionsResponseClass, any, {}>>;
766
+ /**
767
+ * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
768
+ * @summary List scheduled commission clawback triggers
769
+ * @param {CommissionsApiListScheduledCommissionClawbackTriggersRequest} requestParameters Request parameters.
770
+ * @param {*} [options] Override http request option.
771
+ * @throws {RequiredError}
772
+ * @memberof CommissionsApi
773
+ */
774
+ listScheduledCommissionClawbackTriggers(requestParameters?: CommissionsApiListScheduledCommissionClawbackTriggersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListScheduledCommissionClawbackTriggersResponseClass, any, {}>>;
775
+ /**
776
+ * 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.
777
+ * @summary Create the due commission clawbacks trigger
778
+ * @param {CommissionsApiTriggerDueCommissionClawbacksRequest} requestParameters Request parameters.
779
+ * @param {*} [options] Override http request option.
780
+ * @throws {RequiredError}
781
+ * @memberof CommissionsApi
782
+ */
783
+ triggerDueCommissionClawbacks(requestParameters: CommissionsApiTriggerDueCommissionClawbacksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TriggerDueCommissionClawbacksResponseClass, any, {}>>;
441
784
  /**
442
785
  * This will update commission.
443
786
  * @summary Update the commission