@emilgroup/commission-sdk 2.10.1-beta.6 → 2.10.1-beta.61

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 (85) hide show
  1. package/.openapi-generator/FILES +13 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-rules-api.ts +20 -6
  4. package/api/commission-settlements-api.ts +8 -8
  5. package/api/commissions-api.ts +376 -0
  6. package/dist/api/commission-agreement-rules-api.d.ts +12 -3
  7. package/dist/api/commission-agreement-rules-api.js +12 -6
  8. package/dist/api/commission-settlements-api.d.ts +8 -8
  9. package/dist/api/commission-settlements-api.js +3 -3
  10. package/dist/api/commissions-api.d.ts +220 -0
  11. package/dist/api/commissions-api.js +258 -0
  12. package/dist/models/clawback-config-class.d.ts +42 -0
  13. package/dist/models/clawback-config-class.js +15 -0
  14. package/dist/models/clawback-config-dto.d.ts +12 -6
  15. package/dist/models/commission-agreement-class.d.ts +2 -2
  16. package/dist/models/commission-agreement-class.js +1 -1
  17. package/dist/models/commission-agreement-version-class.d.ts +4 -4
  18. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  19. package/dist/models/commission-agreement-version-config-class.js +15 -0
  20. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  21. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  22. package/dist/models/commission-class.d.ts +13 -6
  23. package/dist/models/commission-class.js +2 -1
  24. package/dist/models/commission-creation-config-class.d.ts +43 -0
  25. package/dist/models/commission-creation-config-class.js +20 -0
  26. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  27. package/dist/models/commission-creation-config-dto.js +20 -0
  28. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  29. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  30. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  31. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  32. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  33. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  34. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  35. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  36. package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
  37. package/dist/models/commission-paid-invoice-entry-class.js +22 -0
  38. package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
  39. package/dist/models/create-commission-agreement-request-dto.js +1 -1
  40. package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
  41. package/dist/models/create-commission-candidate-request-dto.d.ts +13 -1
  42. package/dist/models/create-commission-clawback-response-class.d.ts +4 -6
  43. package/dist/models/create-commission-clawback-response-class.js +3 -5
  44. package/dist/models/create-commission-request-dto.d.ts +6 -0
  45. package/dist/models/index.d.ts +13 -0
  46. package/dist/models/index.js +13 -0
  47. package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
  48. package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
  49. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  50. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  51. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  52. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  53. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  54. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  55. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +1 -1
  56. package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
  57. package/dist/models/update-commission-agreement-request-dto.js +1 -1
  58. package/models/clawback-config-class.ts +48 -0
  59. package/models/clawback-config-dto.ts +12 -6
  60. package/models/commission-agreement-class.ts +2 -2
  61. package/models/commission-agreement-version-class.ts +4 -4
  62. package/models/commission-agreement-version-config-class.ts +38 -0
  63. package/models/commission-agreement-version-config-dto.ts +38 -0
  64. package/models/commission-class.ts +14 -7
  65. package/models/commission-creation-config-class.ts +52 -0
  66. package/models/commission-creation-config-dto.ts +52 -0
  67. package/models/commission-creation-invoice-config-class.ts +30 -0
  68. package/models/commission-creation-invoice-config-dto.ts +30 -0
  69. package/models/commission-creation-renewal-config-class.ts +38 -0
  70. package/models/commission-creation-renewal-config-dto.ts +38 -0
  71. package/models/commission-paid-invoice-entry-class.ts +124 -0
  72. package/models/create-commission-agreement-request-dto.ts +5 -5
  73. package/models/create-commission-agreement-version-request-dto.ts +4 -4
  74. package/models/create-commission-candidate-request-dto.ts +13 -1
  75. package/models/create-commission-clawback-response-class.ts +4 -6
  76. package/models/create-commission-request-dto.ts +6 -0
  77. package/models/index.ts +13 -0
  78. package/models/list-commission-agreement-versions-response-class.ts +10 -10
  79. package/models/list-commission-agreements-response-class.ts +10 -10
  80. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  81. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  82. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  83. package/models/trigger-due-commission-clawbacks-request-dto.ts +1 -1
  84. package/models/update-commission-agreement-request-dto.ts +2 -2
  85. package/package.json +1 -1
@@ -61,7 +61,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
61
61
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
62
62
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
63
63
  * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
64
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
64
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
65
65
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
66
66
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
67
67
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -69,7 +69,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
69
69
  * @param {*} [options] Override http request option.
70
70
  * @throws {RequiredError}
71
71
  */
72
- listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
72
+ listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
73
73
  /**
74
74
  * This will publish multiple commission settlements.
75
75
  * @summary Create the commission settlement publish
@@ -138,7 +138,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
138
138
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
139
139
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
140
140
  * @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.
141
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
141
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
142
142
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
143
143
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
144
144
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -146,7 +146,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
146
146
  * @param {*} [options] Override http request option.
147
147
  * @throws {RequiredError}
148
148
  */
149
- listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
149
+ listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
150
150
  /**
151
151
  * This will publish multiple commission settlements.
152
152
  * @summary Create the commission settlement publish
@@ -215,7 +215,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
215
215
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
216
216
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
217
217
  * @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.
218
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
218
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
219
219
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
220
220
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
221
221
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -223,7 +223,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
223
223
  * @param {*} [options] Override http request option.
224
224
  * @throws {RequiredError}
225
225
  */
226
- listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
226
+ listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
227
227
  /**
228
228
  * This will publish multiple commission settlements.
229
229
  * @summary Create the commission settlement publish
@@ -342,10 +342,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
342
342
  readonly pageToken?: string;
343
343
  /**
344
344
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
345
- * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
345
+ * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
346
346
  * @memberof CommissionSettlementsApiListCommissionSettlements
347
347
  */
348
- readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
348
+ readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode';
349
349
  /**
350
350
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
351
351
  * @type {string}
@@ -249,7 +249,7 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
249
249
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
250
250
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
251
251
  * @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.
252
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
253
253
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
254
254
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
255
255
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -546,7 +546,7 @@ var CommissionSettlementsApiFp = function (configuration) {
546
546
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
547
547
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
548
548
  * @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.
549
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
549
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
550
550
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
551
551
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
552
552
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -681,7 +681,7 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
681
681
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
682
682
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
683
683
  * @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.
684
- * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
684
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
685
685
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
686
686
  * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
687
687
  * @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
@@ -19,7 +19,9 @@ import { CreateCommissionResponseClass } from '../models';
19
19
  import { EstimateCommissionsRequestDto } from '../models';
20
20
  import { EstimateCommissionsResponseClass } from '../models';
21
21
  import { GetCommissionResponseClass } from '../models';
22
+ import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
22
23
  import { ListCommissionsResponseClass } from '../models';
24
+ import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
23
25
  import { TriggerDueCommissionClawbacksRequestDto } from '../models';
24
26
  import { TriggerDueCommissionClawbacksResponseClass } from '../models';
25
27
  import { UpdateCommissionRequestDto } from '../models';
@@ -76,6 +78,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
76
78
  * @throws {RequiredError}
77
79
  */
78
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>;
79
96
  /**
80
97
  * Retrieves a list of commissions.
81
98
  * @summary List commissions
@@ -91,6 +108,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
91
108
  * @throws {RequiredError}
92
109
  */
93
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>;
94
126
  /**
95
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.
96
128
  * @summary Create the due commission clawbacks trigger
@@ -163,6 +195,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
163
195
  * @throws {RequiredError}
164
196
  */
165
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>>;
166
213
  /**
167
214
  * Retrieves a list of commissions.
168
215
  * @summary List commissions
@@ -178,6 +225,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
178
225
  * @throws {RequiredError}
179
226
  */
180
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>>;
181
243
  /**
182
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.
183
245
  * @summary Create the due commission clawbacks trigger
@@ -250,6 +312,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
250
312
  * @throws {RequiredError}
251
313
  */
252
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>;
253
330
  /**
254
331
  * Retrieves a list of commissions.
255
332
  * @summary List commissions
@@ -265,6 +342,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
265
342
  * @throws {RequiredError}
266
343
  */
267
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>;
268
360
  /**
269
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.
270
362
  * @summary Create the due commission clawbacks trigger
@@ -392,6 +484,61 @@ export interface CommissionsApiGetCommissionRequest {
392
484
  */
393
485
  readonly authorization?: string;
394
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
+ }
395
542
  /**
396
543
  * Request parameters for listCommissions operation in CommissionsApi.
397
544
  * @export
@@ -447,6 +594,61 @@ export interface CommissionsApiListCommissionsRequest {
447
594
  */
448
595
  readonly filters?: string;
449
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
+ }
450
652
  /**
451
653
  * Request parameters for triggerDueCommissionClawbacks operation in CommissionsApi.
452
654
  * @export
@@ -543,6 +745,15 @@ export declare class CommissionsApi extends BaseAPI {
543
745
  * @memberof CommissionsApi
544
746
  */
545
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, {}>>;
546
757
  /**
547
758
  * Retrieves a list of commissions.
548
759
  * @summary List commissions
@@ -552,6 +763,15 @@ export declare class CommissionsApi extends BaseAPI {
552
763
  * @memberof CommissionsApi
553
764
  */
554
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, {}>>;
555
775
  /**
556
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.
557
777
  * @summary Create the due commission clawbacks trigger