@emilgroup/commission-sdk-node 2.9.1-beta.11 → 2.9.1-beta.110
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.
- package/.openapi-generator/FILES +10 -0
- package/README.md +2 -2
- package/api/commission-agreement-products-api.ts +4 -4
- package/api/commission-agreement-rules-api.ts +20 -6
- package/api/commission-settlements-api.ts +8 -8
- package/api/commissions-api.ts +188 -0
- package/dist/api/commission-agreement-products-api.d.ts +4 -4
- package/dist/api/commission-agreement-products-api.js +3 -3
- package/dist/api/commission-agreement-rules-api.d.ts +12 -3
- package/dist/api/commission-agreement-rules-api.js +12 -6
- package/dist/api/commission-settlements-api.d.ts +8 -8
- package/dist/api/commission-settlements-api.js +3 -3
- package/dist/api/commissions-api.d.ts +110 -0
- package/dist/api/commissions-api.js +129 -0
- package/dist/models/clawback-config-class.d.ts +6 -0
- package/dist/models/clawback-config-dto.d.ts +6 -0
- package/dist/models/commission-agreement-class.d.ts +2 -2
- package/dist/models/commission-agreement-class.js +1 -1
- package/dist/models/commission-agreement-version-class.d.ts +4 -4
- package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
- package/dist/models/commission-agreement-version-config-class.js +15 -0
- package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
- package/dist/models/commission-agreement-version-config-dto.js +15 -0
- package/dist/models/commission-class.d.ts +15 -7
- package/dist/models/commission-class.js +3 -1
- package/dist/models/commission-creation-config-class.d.ts +43 -0
- package/dist/models/commission-creation-config-class.js +20 -0
- package/dist/models/commission-creation-config-dto.d.ts +43 -0
- package/dist/models/commission-creation-config-dto.js +20 -0
- package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
- package/dist/models/commission-creation-invoice-config-class.js +15 -0
- package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
- package/dist/models/commission-creation-invoice-config-dto.js +15 -0
- package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
- package/dist/models/commission-creation-renewal-config-class.js +20 -0
- package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
- package/dist/models/commission-creation-renewal-config-dto.js +20 -0
- package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
- package/dist/models/commission-paid-invoice-entry-class.js +22 -0
- package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
- package/dist/models/create-commission-agreement-request-dto.js +1 -1
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
- package/dist/models/estimate-commissions-request-dto.d.ts +6 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
- package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
- package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
- package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
- package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +1 -0
- package/dist/models/scheduled-commission-clawback-trigger-class.js +2 -1
- package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +1 -1
- package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
- package/dist/models/update-commission-agreement-request-dto.js +1 -1
- package/dist/models/update-commission-request-dto.d.ts +1 -1
- package/models/clawback-config-class.ts +6 -0
- package/models/clawback-config-dto.ts +6 -0
- package/models/commission-agreement-class.ts +2 -2
- package/models/commission-agreement-version-class.ts +4 -4
- package/models/commission-agreement-version-config-class.ts +38 -0
- package/models/commission-agreement-version-config-dto.ts +38 -0
- package/models/commission-class.ts +16 -8
- package/models/commission-creation-config-class.ts +52 -0
- package/models/commission-creation-config-dto.ts +52 -0
- package/models/commission-creation-invoice-config-class.ts +30 -0
- package/models/commission-creation-invoice-config-dto.ts +30 -0
- package/models/commission-creation-renewal-config-class.ts +38 -0
- package/models/commission-creation-renewal-config-dto.ts +38 -0
- package/models/commission-paid-invoice-entry-class.ts +124 -0
- package/models/create-commission-agreement-request-dto.ts +5 -5
- package/models/create-commission-agreement-version-request-dto.ts +4 -4
- package/models/estimate-commissions-request-dto.ts +6 -0
- package/models/index.ts +10 -0
- package/models/list-commission-agreement-versions-response-class.ts +10 -10
- package/models/list-commission-agreements-response-class.ts +10 -10
- package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
- package/models/scheduled-commission-clawback-trigger-class.ts +2 -1
- package/models/trigger-due-commission-clawbacks-request-dto.ts +1 -1
- package/models/update-commission-agreement-request-dto.ts +2 -2
- package/models/update-commission-request-dto.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -27,12 +27,21 @@ models/commission-agreement-rule-class.ts
|
|
|
27
27
|
models/commission-agreement-rule-config-dto.ts
|
|
28
28
|
models/commission-agreement-rule-evaluation-class.ts
|
|
29
29
|
models/commission-agreement-version-class.ts
|
|
30
|
+
models/commission-agreement-version-config-class.ts
|
|
31
|
+
models/commission-agreement-version-config-dto.ts
|
|
30
32
|
models/commission-candidate-class.ts
|
|
31
33
|
models/commission-class.ts
|
|
32
34
|
models/commission-conditions-dto.ts
|
|
33
35
|
models/commission-config-dto.ts
|
|
36
|
+
models/commission-creation-config-class.ts
|
|
37
|
+
models/commission-creation-config-dto.ts
|
|
38
|
+
models/commission-creation-invoice-config-class.ts
|
|
39
|
+
models/commission-creation-invoice-config-dto.ts
|
|
40
|
+
models/commission-creation-renewal-config-class.ts
|
|
41
|
+
models/commission-creation-renewal-config-dto.ts
|
|
34
42
|
models/commission-estimate-class.ts
|
|
35
43
|
models/commission-item-class.ts
|
|
44
|
+
models/commission-paid-invoice-entry-class.ts
|
|
36
45
|
models/commission-recipient-class.ts
|
|
37
46
|
models/commission-settlement-class.ts
|
|
38
47
|
models/create-commission-agreement-product-request-dto.ts
|
|
@@ -78,6 +87,7 @@ models/list-commission-agreement-rules-response-class.ts
|
|
|
78
87
|
models/list-commission-agreement-versions-response-class.ts
|
|
79
88
|
models/list-commission-agreements-response-class.ts
|
|
80
89
|
models/list-commission-candidates-response-class.ts
|
|
90
|
+
models/list-commission-paid-invoice-entries-response-class.ts
|
|
81
91
|
models/list-commission-recipients-response-class.ts
|
|
82
92
|
models/list-commission-settlements-response-class.ts
|
|
83
93
|
models/list-commissions-response-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/commission-sdk-node@2.9.1-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk-node@2.9.1-beta.110 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk-node@2.9.1-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk-node@2.9.1-beta.110
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -194,7 +194,7 @@ export const CommissionAgreementProductsApiAxiosParamCreator = function (configu
|
|
|
194
194
|
* @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.
|
|
195
195
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
196
196
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
197
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
197
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
198
198
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
199
199
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
@@ -368,7 +368,7 @@ export const CommissionAgreementProductsApiFp = function(configuration?: Configu
|
|
|
368
368
|
* @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.
|
|
369
369
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
370
370
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
371
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
371
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
372
372
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
373
373
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
@@ -443,7 +443,7 @@ export const CommissionAgreementProductsApiFactory = function (configuration?: C
|
|
|
443
443
|
* @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.
|
|
444
444
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
445
445
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
446
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
446
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
447
447
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
448
448
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
@@ -579,7 +579,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
579
579
|
readonly search?: string
|
|
580
580
|
|
|
581
581
|
/**
|
|
582
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
582
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
583
583
|
* @type {string}
|
|
584
584
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
585
585
|
*/
|
|
@@ -243,10 +243,11 @@ export const CommissionAgreementRulesApiAxiosParamCreator = function (configurat
|
|
|
243
243
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
244
244
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
245
245
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
246
247
|
* @param {*} [options] Override http request option.
|
|
247
248
|
* @throws {RequiredError}
|
|
248
249
|
*/
|
|
249
|
-
getEvaluationDefaultData: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
250
|
+
getEvaluationDefaultData: async (authorization?: string, commissionAgreementProductCode?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
250
251
|
const localVarPath = `/commissionservice/v1/agreement-rules/evaluation-default-data`;
|
|
251
252
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
252
253
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -265,6 +266,10 @@ export const CommissionAgreementRulesApiAxiosParamCreator = function (configurat
|
|
|
265
266
|
// http bearer authentication required
|
|
266
267
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
267
268
|
|
|
269
|
+
if (commissionAgreementProductCode !== undefined) {
|
|
270
|
+
localVarQueryParameter['commissionAgreementProductCode'] = commissionAgreementProductCode;
|
|
271
|
+
}
|
|
272
|
+
|
|
268
273
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
269
274
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
270
275
|
}
|
|
@@ -470,11 +475,12 @@ export const CommissionAgreementRulesApiFp = function(configuration?: Configurat
|
|
|
470
475
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
471
476
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
472
477
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
478
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
473
479
|
* @param {*} [options] Override http request option.
|
|
474
480
|
* @throws {RequiredError}
|
|
475
481
|
*/
|
|
476
|
-
async getEvaluationDefaultData(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>> {
|
|
477
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluationDefaultData(authorization, options);
|
|
482
|
+
async getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>> {
|
|
483
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options);
|
|
478
484
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
479
485
|
},
|
|
480
486
|
/**
|
|
@@ -567,11 +573,12 @@ export const CommissionAgreementRulesApiFactory = function (configuration?: Conf
|
|
|
567
573
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
568
574
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
569
575
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
576
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
570
577
|
* @param {*} [options] Override http request option.
|
|
571
578
|
* @throws {RequiredError}
|
|
572
579
|
*/
|
|
573
|
-
getEvaluationDefaultData(authorization?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass> {
|
|
574
|
-
return localVarFp.getEvaluationDefaultData(authorization, options).then((request) => request(axios, basePath));
|
|
580
|
+
getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass> {
|
|
581
|
+
return localVarFp.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options).then((request) => request(axios, basePath));
|
|
575
582
|
},
|
|
576
583
|
/**
|
|
577
584
|
* Retrieves a list of commission agreement rules.
|
|
@@ -708,6 +715,13 @@ export interface CommissionAgreementRulesApiGetEvaluationDefaultDataRequest {
|
|
|
708
715
|
* @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
|
|
709
716
|
*/
|
|
710
717
|
readonly authorization?: string
|
|
718
|
+
|
|
719
|
+
/**
|
|
720
|
+
* Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
721
|
+
* @type {string}
|
|
722
|
+
* @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
|
|
723
|
+
*/
|
|
724
|
+
readonly commissionAgreementProductCode?: string
|
|
711
725
|
}
|
|
712
726
|
|
|
713
727
|
/**
|
|
@@ -865,7 +879,7 @@ export class CommissionAgreementRulesApi extends BaseAPI {
|
|
|
865
879
|
* @memberof CommissionAgreementRulesApi
|
|
866
880
|
*/
|
|
867
881
|
public getEvaluationDefaultData(requestParameters: CommissionAgreementRulesApiGetEvaluationDefaultDataRequest = {}, options?: AxiosRequestConfig) {
|
|
868
|
-
return CommissionAgreementRulesApiFp(this.configuration).getEvaluationDefaultData(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
882
|
+
return CommissionAgreementRulesApiFp(this.configuration).getEvaluationDefaultData(requestParameters.authorization, requestParameters.commissionAgreementProductCode, options).then((request) => request(this.axios, this.basePath));
|
|
869
883
|
}
|
|
870
884
|
|
|
871
885
|
/**
|
|
@@ -200,7 +200,7 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
|
|
|
200
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
201
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
202
202
|
* @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.
|
|
203
|
-
* @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.
|
|
203
|
+
* @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.
|
|
204
204
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
205
205
|
* @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.
|
|
206
206
|
* @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.
|
|
@@ -208,7 +208,7 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
|
|
|
208
208
|
* @param {*} [options] Override http request option.
|
|
209
209
|
* @throws {RequiredError}
|
|
210
210
|
*/
|
|
211
|
-
listCommissionSettlements: async (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> => {
|
|
211
|
+
listCommissionSettlements: async (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> => {
|
|
212
212
|
const localVarPath = `/commissionservice/v1/commission-settlements`;
|
|
213
213
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
214
214
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -468,7 +468,7 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
|
|
|
468
468
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
469
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
470
470
|
* @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.
|
|
471
|
-
* @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.
|
|
471
|
+
* @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.
|
|
472
472
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
473
473
|
* @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.
|
|
474
474
|
* @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.
|
|
@@ -476,7 +476,7 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
|
|
|
476
476
|
* @param {*} [options] Override http request option.
|
|
477
477
|
* @throws {RequiredError}
|
|
478
478
|
*/
|
|
479
|
-
async 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>> {
|
|
479
|
+
async 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>> {
|
|
480
480
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
481
481
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
482
482
|
},
|
|
@@ -567,7 +567,7 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
|
|
|
567
567
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
568
568
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
569
569
|
* @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.
|
|
570
|
-
* @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.
|
|
570
|
+
* @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.
|
|
571
571
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
572
572
|
* @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.
|
|
573
573
|
* @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.
|
|
@@ -575,7 +575,7 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
|
|
|
575
575
|
* @param {*} [options] Override http request option.
|
|
576
576
|
* @throws {RequiredError}
|
|
577
577
|
*/
|
|
578
|
-
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> {
|
|
578
|
+
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> {
|
|
579
579
|
return localVarFp.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
580
580
|
},
|
|
581
581
|
/**
|
|
@@ -714,10 +714,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
714
714
|
|
|
715
715
|
/**
|
|
716
716
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
717
|
-
* @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
|
|
717
|
+
* @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
|
|
718
718
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
719
719
|
*/
|
|
720
|
-
readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'
|
|
720
|
+
readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'
|
|
721
721
|
|
|
722
722
|
/**
|
|
723
723
|
* To search the list by any field, pass search=xxx to fetch the result.
|
package/api/commissions-api.ts
CHANGED
|
@@ -35,6 +35,8 @@ import { EstimateCommissionsResponseClass } from '../models';
|
|
|
35
35
|
// @ts-ignore
|
|
36
36
|
import { GetCommissionResponseClass } from '../models';
|
|
37
37
|
// @ts-ignore
|
|
38
|
+
import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
|
|
39
|
+
// @ts-ignore
|
|
38
40
|
import { ListCommissionsResponseClass } from '../models';
|
|
39
41
|
// @ts-ignore
|
|
40
42
|
import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
|
|
@@ -289,6 +291,82 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
289
291
|
|
|
290
292
|
|
|
291
293
|
|
|
294
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
295
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
296
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
297
|
+
|
|
298
|
+
return {
|
|
299
|
+
url: toPathString(localVarUrlObj),
|
|
300
|
+
options: localVarRequestOptions,
|
|
301
|
+
};
|
|
302
|
+
},
|
|
303
|
+
/**
|
|
304
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
305
|
+
* @summary List commission paid invoice entries
|
|
306
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
307
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
308
|
+
* @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.
|
|
309
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
310
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
311
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
312
|
+
* @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.<br/> <br/>
|
|
313
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
*/
|
|
317
|
+
listCommissionPaidInvoiceEntries: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
318
|
+
const localVarPath = `/commissionservice/v1/commissions/paid-invoice-entries`;
|
|
319
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
320
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
321
|
+
let baseOptions;
|
|
322
|
+
let baseAccessToken;
|
|
323
|
+
if (configuration) {
|
|
324
|
+
baseOptions = configuration.baseOptions;
|
|
325
|
+
baseAccessToken = configuration.accessToken;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
329
|
+
const localVarHeaderParameter = {} as any;
|
|
330
|
+
const localVarQueryParameter = {} as any;
|
|
331
|
+
|
|
332
|
+
// authentication bearer required
|
|
333
|
+
// http bearer authentication required
|
|
334
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
335
|
+
|
|
336
|
+
if (pageSize !== undefined) {
|
|
337
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
if (pageToken !== undefined) {
|
|
341
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
if (filter !== undefined) {
|
|
345
|
+
localVarQueryParameter['filter'] = filter;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
if (search !== undefined) {
|
|
349
|
+
localVarQueryParameter['search'] = search;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
if (order !== undefined) {
|
|
353
|
+
localVarQueryParameter['order'] = order;
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
if (expand !== undefined) {
|
|
357
|
+
localVarQueryParameter['expand'] = expand;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
if (filters !== undefined) {
|
|
361
|
+
localVarQueryParameter['filters'] = filters;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
365
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
292
370
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
293
371
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
294
372
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -620,6 +698,24 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
620
698
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCommission(code, expand, authorization, options);
|
|
621
699
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
622
700
|
},
|
|
701
|
+
/**
|
|
702
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
703
|
+
* @summary List commission paid invoice entries
|
|
704
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
705
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
706
|
+
* @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.
|
|
707
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
708
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
709
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
710
|
+
* @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.<br/> <br/>
|
|
711
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
712
|
+
* @param {*} [options] Override http request option.
|
|
713
|
+
* @throws {RequiredError}
|
|
714
|
+
*/
|
|
715
|
+
async listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>> {
|
|
716
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
717
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
718
|
+
},
|
|
623
719
|
/**
|
|
624
720
|
* Retrieves a list of commissions.
|
|
625
721
|
* @summary List commissions
|
|
@@ -748,6 +844,23 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
748
844
|
getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass> {
|
|
749
845
|
return localVarFp.getCommission(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
750
846
|
},
|
|
847
|
+
/**
|
|
848
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
849
|
+
* @summary List commission paid invoice entries
|
|
850
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
851
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
852
|
+
* @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.
|
|
853
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
854
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
855
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
856
|
+
* @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.<br/> <br/>
|
|
857
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
858
|
+
* @param {*} [options] Override http request option.
|
|
859
|
+
* @throws {RequiredError}
|
|
860
|
+
*/
|
|
861
|
+
listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass> {
|
|
862
|
+
return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
863
|
+
},
|
|
751
864
|
/**
|
|
752
865
|
* Retrieves a list of commissions.
|
|
753
866
|
* @summary List commissions
|
|
@@ -927,6 +1040,69 @@ export interface CommissionsApiGetCommissionRequest {
|
|
|
927
1040
|
readonly authorization?: string
|
|
928
1041
|
}
|
|
929
1042
|
|
|
1043
|
+
/**
|
|
1044
|
+
* Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
|
|
1045
|
+
* @export
|
|
1046
|
+
* @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
|
|
1047
|
+
*/
|
|
1048
|
+
export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
|
|
1049
|
+
/**
|
|
1050
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1051
|
+
* @type {string}
|
|
1052
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1053
|
+
*/
|
|
1054
|
+
readonly authorization?: string
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1058
|
+
* @type {number}
|
|
1059
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1060
|
+
*/
|
|
1061
|
+
readonly pageSize?: number
|
|
1062
|
+
|
|
1063
|
+
/**
|
|
1064
|
+
* 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.
|
|
1065
|
+
* @type {string}
|
|
1066
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1067
|
+
*/
|
|
1068
|
+
readonly pageToken?: string
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1072
|
+
* @type {string}
|
|
1073
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1074
|
+
*/
|
|
1075
|
+
readonly filter?: string
|
|
1076
|
+
|
|
1077
|
+
/**
|
|
1078
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1079
|
+
* @type {string}
|
|
1080
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1081
|
+
*/
|
|
1082
|
+
readonly search?: string
|
|
1083
|
+
|
|
1084
|
+
/**
|
|
1085
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
1086
|
+
* @type {string}
|
|
1087
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1088
|
+
*/
|
|
1089
|
+
readonly order?: string
|
|
1090
|
+
|
|
1091
|
+
/**
|
|
1092
|
+
* 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.<br/> <br/>
|
|
1093
|
+
* @type {string}
|
|
1094
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1095
|
+
*/
|
|
1096
|
+
readonly expand?: string
|
|
1097
|
+
|
|
1098
|
+
/**
|
|
1099
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1100
|
+
* @type {string}
|
|
1101
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
1102
|
+
*/
|
|
1103
|
+
readonly filters?: string
|
|
1104
|
+
}
|
|
1105
|
+
|
|
930
1106
|
/**
|
|
931
1107
|
* Request parameters for listCommissions operation in CommissionsApi.
|
|
932
1108
|
* @export
|
|
@@ -1169,6 +1345,18 @@ export class CommissionsApi extends BaseAPI {
|
|
|
1169
1345
|
return CommissionsApiFp(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1170
1346
|
}
|
|
1171
1347
|
|
|
1348
|
+
/**
|
|
1349
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
1350
|
+
* @summary List commission paid invoice entries
|
|
1351
|
+
* @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
|
|
1352
|
+
* @param {*} [options] Override http request option.
|
|
1353
|
+
* @throws {RequiredError}
|
|
1354
|
+
* @memberof CommissionsApi
|
|
1355
|
+
*/
|
|
1356
|
+
public listCommissionPaidInvoiceEntries(requestParameters: CommissionsApiListCommissionPaidInvoiceEntriesRequest = {}, options?: AxiosRequestConfig) {
|
|
1357
|
+
return CommissionsApiFp(this.configuration).listCommissionPaidInvoiceEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1358
|
+
}
|
|
1359
|
+
|
|
1172
1360
|
/**
|
|
1173
1361
|
* Retrieves a list of commissions.
|
|
1174
1362
|
* @summary List commissions
|
|
@@ -59,7 +59,7 @@ export declare const CommissionAgreementProductsApiAxiosParamCreator: (configura
|
|
|
59
59
|
* @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.
|
|
60
60
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
61
61
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
62
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
62
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
63
63
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
64
64
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
@@ -118,7 +118,7 @@ export declare const CommissionAgreementProductsApiFp: (configuration?: Configur
|
|
|
118
118
|
* @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.
|
|
119
119
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
120
120
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
121
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
121
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
122
122
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
123
123
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
@@ -177,7 +177,7 @@ export declare const CommissionAgreementProductsApiFactory: (configuration?: Con
|
|
|
177
177
|
* @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.
|
|
178
178
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
179
179
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
180
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
180
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
181
181
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
182
182
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
@@ -295,7 +295,7 @@ export interface CommissionAgreementProductsApiListCommissionAgreementProductsRe
|
|
|
295
295
|
*/
|
|
296
296
|
readonly search?: string;
|
|
297
297
|
/**
|
|
298
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
298
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
299
299
|
* @type {string}
|
|
300
300
|
* @memberof CommissionAgreementProductsApiListCommissionAgreementProducts
|
|
301
301
|
*/
|
|
@@ -255,7 +255,7 @@ var CommissionAgreementProductsApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
* @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.
|
|
256
256
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
257
257
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
258
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
258
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
259
259
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
260
260
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -454,7 +454,7 @@ var CommissionAgreementProductsApiFp = function (configuration) {
|
|
|
454
454
|
* @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.
|
|
455
455
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
456
456
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
457
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
457
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
458
458
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
459
459
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
460
460
|
* @param {*} [options] Override http request option.
|
|
@@ -547,7 +547,7 @@ var CommissionAgreementProductsApiFactory = function (configuration, basePath, a
|
|
|
547
547
|
* @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.
|
|
548
548
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
549
549
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, productSlug</i>
|
|
550
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status</i>
|
|
550
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, productSlug, status, id</i>
|
|
551
551
|
* @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.<br/> <br/> <i>Allowed values: version<i>
|
|
552
552
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, productSlug, status, createdAt</i>
|
|
553
553
|
* @param {*} [options] Override http request option.
|