@emilgroup/commission-sdk 1.0.0-beta.22 → 1.0.0-beta.24
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/README.md +2 -2
- package/api/commissions-api.ts +8 -8
- package/dist/api/commissions-api.d.ts +8 -8
- package/dist/api/commissions-api.js +3 -3
- package/dist/models/commission-class.d.ts +6 -0
- package/dist/models/commission-config-dto.d.ts +1 -1
- package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +1 -1
- package/models/commission-class.ts +6 -0
- package/models/commission-config-dto.ts +1 -1
- package/models/evaluate-commission-agreement-rule-request-dto.ts +1 -1
- package/package.json +1 -1
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@1.0.0-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk@1.0.0-beta.24 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk@1.0.0-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk@1.0.0-beta.24
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
package/api/commissions-api.ts
CHANGED
|
@@ -188,7 +188,7 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @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.
|
|
191
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
191
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
192
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
193
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
194
194
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -196,7 +196,7 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
199
|
-
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
199
|
+
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
200
|
const localVarPath = `/commissionservice/v1/commissions`;
|
|
201
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -362,7 +362,7 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @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.
|
|
365
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
365
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
366
366
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
367
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
368
368
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -370,7 +370,7 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
373
|
-
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
373
|
+
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
374
374
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
375
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
376
376
|
},
|
|
@@ -437,7 +437,7 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @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.
|
|
440
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
440
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
441
441
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
442
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
443
443
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -445,7 +445,7 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
448
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
448
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
449
449
|
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
@@ -562,10 +562,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
564
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
565
|
-
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'}
|
|
565
|
+
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'}
|
|
566
566
|
* @memberof CommissionsApiListCommissions
|
|
567
567
|
*/
|
|
568
|
-
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'
|
|
568
|
+
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'
|
|
569
569
|
|
|
570
570
|
/**
|
|
571
571
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
@@ -57,7 +57,7 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
60
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
61
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
62
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
63
63
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -65,7 +65,7 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
68
|
-
listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
69
|
/**
|
|
70
70
|
* This will update commission.
|
|
71
71
|
* @summary Update the commission
|
|
@@ -116,7 +116,7 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
|
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
119
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
120
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
121
121
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
122
122
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -124,7 +124,7 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
|
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
|
|
127
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
|
|
128
128
|
/**
|
|
129
129
|
* This will update commission.
|
|
130
130
|
* @summary Update the commission
|
|
@@ -175,7 +175,7 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
|
|
|
175
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
178
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
179
179
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
180
180
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
181
181
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -183,7 +183,7 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
|
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
|
|
186
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode', search?: string, order?: 'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
|
|
187
187
|
/**
|
|
188
188
|
* This will update commission.
|
|
189
189
|
* @summary Update the commission
|
|
@@ -284,10 +284,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
286
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
287
|
-
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'}
|
|
287
|
+
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'}
|
|
288
288
|
* @memberof CommissionsApiListCommissions
|
|
289
289
|
*/
|
|
290
|
-
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes';
|
|
290
|
+
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode';
|
|
291
291
|
/**
|
|
292
292
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
293
293
|
* @type {string}
|
|
@@ -249,7 +249,7 @@ var CommissionsApiAxiosParamCreator = 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [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' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [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=xxx to fetch the result.
|
|
254
254
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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 {'items' | 'agreement'} [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.
|
|
@@ -448,7 +448,7 @@ var CommissionsApiFp = function (configuration) {
|
|
|
448
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
449
449
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
450
|
* @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.
|
|
451
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
451
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
452
452
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
453
453
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
454
454
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -541,7 +541,7 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
541
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
542
542
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
543
|
* @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.
|
|
544
|
-
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
544
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'partnerCodes' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
545
545
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
546
546
|
* @param {'commissionAgreementCode' | 'policyCode' | 'partnerCode' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
547
547
|
* @param {'items' | 'agreement'} [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.
|
|
@@ -71,6 +71,12 @@ export interface CommissionClass {
|
|
|
71
71
|
* @memberof CommissionClass
|
|
72
72
|
*/
|
|
73
73
|
'status': string;
|
|
74
|
+
/**
|
|
75
|
+
* The code of the settlement this commission is associated with
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof CommissionClass
|
|
78
|
+
*/
|
|
79
|
+
'settlementCode'?: string;
|
|
74
80
|
/**
|
|
75
81
|
* Time at which the object was created.
|
|
76
82
|
* @type {string}
|
|
@@ -23,7 +23,7 @@ export interface CommissionConfigDto {
|
|
|
23
23
|
*/
|
|
24
24
|
'type': CommissionConfigDtoTypeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* Mathematical expression to calculate commission (e.g., \'invoice.
|
|
26
|
+
* Mathematical expression to calculate commission (e.g., \'invoice.netAmount * 0.10\'). Always return value in cents.
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof CommissionConfigDto
|
|
29
29
|
*/
|
|
@@ -17,7 +17,7 @@ import { CommissionAgreementRuleConfigDto } from './commission-agreement-rule-co
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EvaluateCommissionAgreementRuleRequestDto {
|
|
19
19
|
/**
|
|
20
|
-
* Mock data object containing invoice, policy, and other data needed for expression evaluation (e.g., { invoice: {
|
|
20
|
+
* Mock data object containing invoice, policy, and other data needed for expression evaluation (e.g., { invoice: { netAmount: 1000 }, policy: { ... } })
|
|
21
21
|
* @type {object}
|
|
22
22
|
* @memberof EvaluateCommissionAgreementRuleRequestDto
|
|
23
23
|
*/
|
|
@@ -76,6 +76,12 @@ export interface CommissionClass {
|
|
|
76
76
|
* @memberof CommissionClass
|
|
77
77
|
*/
|
|
78
78
|
'status': string;
|
|
79
|
+
/**
|
|
80
|
+
* The code of the settlement this commission is associated with
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof CommissionClass
|
|
83
|
+
*/
|
|
84
|
+
'settlementCode'?: string;
|
|
79
85
|
/**
|
|
80
86
|
* Time at which the object was created.
|
|
81
87
|
* @type {string}
|
|
@@ -28,7 +28,7 @@ export interface CommissionConfigDto {
|
|
|
28
28
|
*/
|
|
29
29
|
'type': CommissionConfigDtoTypeEnum;
|
|
30
30
|
/**
|
|
31
|
-
* Mathematical expression to calculate commission (e.g., \'invoice.
|
|
31
|
+
* Mathematical expression to calculate commission (e.g., \'invoice.netAmount * 0.10\'). Always return value in cents.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CommissionConfigDto
|
|
34
34
|
*/
|
|
@@ -22,7 +22,7 @@ import { CommissionAgreementRuleConfigDto } from './commission-agreement-rule-co
|
|
|
22
22
|
*/
|
|
23
23
|
export interface EvaluateCommissionAgreementRuleRequestDto {
|
|
24
24
|
/**
|
|
25
|
-
* Mock data object containing invoice, policy, and other data needed for expression evaluation (e.g., { invoice: {
|
|
25
|
+
* Mock data object containing invoice, policy, and other data needed for expression evaluation (e.g., { invoice: { netAmount: 1000 }, policy: { ... } })
|
|
26
26
|
* @type {object}
|
|
27
27
|
* @memberof EvaluateCommissionAgreementRuleRequestDto
|
|
28
28
|
*/
|