@emilgroup/commission-sdk-node 2.9.1-beta.13 → 2.9.1-beta.131
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/update-commission-agreement-request-dto.d.ts +2 -2
- package/dist/models/update-commission-agreement-request-dto.js +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/update-commission-agreement-request-dto.ts +2 -2
- package/package.json +1 -1
|
@@ -67,10 +67,11 @@ export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuratio
|
|
|
67
67
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
68
68
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
69
69
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
70
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
70
71
|
* @param {*} [options] Override http request option.
|
|
71
72
|
* @throws {RequiredError}
|
|
72
73
|
*/
|
|
73
|
-
getEvaluationDefaultData: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
|
+
getEvaluationDefaultData: (authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
75
|
/**
|
|
75
76
|
* Retrieves a list of commission agreement rules.
|
|
76
77
|
* @summary List commission agreement rules
|
|
@@ -143,10 +144,11 @@ export declare const CommissionAgreementRulesApiFp: (configuration?: Configurati
|
|
|
143
144
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
144
145
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
145
146
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
146
148
|
* @param {*} [options] Override http request option.
|
|
147
149
|
* @throws {RequiredError}
|
|
148
150
|
*/
|
|
149
|
-
getEvaluationDefaultData(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
|
|
151
|
+
getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEvaluationDefaultDataResponseClass>>;
|
|
150
152
|
/**
|
|
151
153
|
* Retrieves a list of commission agreement rules.
|
|
152
154
|
* @summary List commission agreement rules
|
|
@@ -219,10 +221,11 @@ export declare const CommissionAgreementRulesApiFactory: (configuration?: Config
|
|
|
219
221
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
220
222
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
221
223
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
224
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
222
225
|
* @param {*} [options] Override http request option.
|
|
223
226
|
* @throws {RequiredError}
|
|
224
227
|
*/
|
|
225
|
-
getEvaluationDefaultData(authorization?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
|
|
228
|
+
getEvaluationDefaultData(authorization?: string, commissionAgreementProductCode?: string, options?: any): AxiosPromise<GetEvaluationDefaultDataResponseClass>;
|
|
226
229
|
/**
|
|
227
230
|
* Retrieves a list of commission agreement rules.
|
|
228
231
|
* @summary List commission agreement rules
|
|
@@ -343,6 +346,12 @@ export interface CommissionAgreementRulesApiGetEvaluationDefaultDataRequest {
|
|
|
343
346
|
* @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
|
|
344
347
|
*/
|
|
345
348
|
readonly authorization?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
351
|
+
* @type {string}
|
|
352
|
+
* @memberof CommissionAgreementRulesApiGetEvaluationDefaultData
|
|
353
|
+
*/
|
|
354
|
+
readonly commissionAgreementProductCode?: string;
|
|
346
355
|
}
|
|
347
356
|
/**
|
|
348
357
|
* Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.
|
|
@@ -300,10 +300,11 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
|
|
|
300
300
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
301
301
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
302
302
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
303
304
|
* @param {*} [options] Override http request option.
|
|
304
305
|
* @throws {RequiredError}
|
|
305
306
|
*/
|
|
306
|
-
getEvaluationDefaultData: function (authorization, options) {
|
|
307
|
+
getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
|
|
307
308
|
if (options === void 0) { options = {}; }
|
|
308
309
|
return __awaiter(_this, void 0, void 0, function () {
|
|
309
310
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -326,6 +327,9 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
|
|
|
326
327
|
// authentication bearer required
|
|
327
328
|
// http bearer authentication required
|
|
328
329
|
_a.sent();
|
|
330
|
+
if (commissionAgreementProductCode !== undefined) {
|
|
331
|
+
localVarQueryParameter['commissionAgreementProductCode'] = commissionAgreementProductCode;
|
|
332
|
+
}
|
|
329
333
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
330
334
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
331
335
|
}
|
|
@@ -564,15 +568,16 @@ var CommissionAgreementRulesApiFp = function (configuration) {
|
|
|
564
568
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
565
569
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
566
570
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
571
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
567
572
|
* @param {*} [options] Override http request option.
|
|
568
573
|
* @throws {RequiredError}
|
|
569
574
|
*/
|
|
570
|
-
getEvaluationDefaultData: function (authorization, options) {
|
|
575
|
+
getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
|
|
571
576
|
return __awaiter(this, void 0, void 0, function () {
|
|
572
577
|
var localVarAxiosArgs;
|
|
573
578
|
return __generator(this, function (_a) {
|
|
574
579
|
switch (_a.label) {
|
|
575
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getEvaluationDefaultData(authorization, options)];
|
|
580
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options)];
|
|
576
581
|
case 1:
|
|
577
582
|
localVarAxiosArgs = _a.sent();
|
|
578
583
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -688,11 +693,12 @@ var CommissionAgreementRulesApiFactory = function (configuration, basePath, axio
|
|
|
688
693
|
* Returns stub policy, invoice, product, and premium for preview evaluation (same shape as evaluate request data).
|
|
689
694
|
* @summary Retrieve the commission agreement rule evaluation default data
|
|
690
695
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
696
|
+
* @param {string} [commissionAgreementProductCode] Commission agreement product to derive the available insured object fields from. Omitted, the response contains the generic stub only.
|
|
691
697
|
* @param {*} [options] Override http request option.
|
|
692
698
|
* @throws {RequiredError}
|
|
693
699
|
*/
|
|
694
|
-
getEvaluationDefaultData: function (authorization, options) {
|
|
695
|
-
return localVarFp.getEvaluationDefaultData(authorization, options).then(function (request) { return request(axios, basePath); });
|
|
700
|
+
getEvaluationDefaultData: function (authorization, commissionAgreementProductCode, options) {
|
|
701
|
+
return localVarFp.getEvaluationDefaultData(authorization, commissionAgreementProductCode, options).then(function (request) { return request(axios, basePath); });
|
|
696
702
|
},
|
|
697
703
|
/**
|
|
698
704
|
* Retrieves a list of commission agreement rules.
|
|
@@ -796,7 +802,7 @@ var CommissionAgreementRulesApi = /** @class */ (function (_super) {
|
|
|
796
802
|
CommissionAgreementRulesApi.prototype.getEvaluationDefaultData = function (requestParameters, options) {
|
|
797
803
|
var _this = this;
|
|
798
804
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
799
|
-
return (0, exports.CommissionAgreementRulesApiFp)(this.configuration).getEvaluationDefaultData(requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
805
|
+
return (0, exports.CommissionAgreementRulesApiFp)(this.configuration).getEvaluationDefaultData(requestParameters.authorization, requestParameters.commissionAgreementProductCode, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
800
806
|
};
|
|
801
807
|
/**
|
|
802
808
|
* Retrieves a list of commission agreement rules.
|
|
@@ -61,7 +61,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
|
|
|
61
61
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
62
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
63
63
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
64
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
64
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
65
65
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
66
66
|
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
67
67
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
@@ -69,7 +69,7 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
|
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
|
-
listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
|
+
listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
74
|
* This will publish multiple commission settlements.
|
|
75
75
|
* @summary Create the commission settlement publish
|
|
@@ -138,7 +138,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
|
|
|
138
138
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
139
139
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
140
140
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
141
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
141
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
142
142
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
143
143
|
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
144
144
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
@@ -146,7 +146,7 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
|
|
|
146
146
|
* @param {*} [options] Override http request option.
|
|
147
147
|
* @throws {RequiredError}
|
|
148
148
|
*/
|
|
149
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
|
|
149
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
|
|
150
150
|
/**
|
|
151
151
|
* This will publish multiple commission settlements.
|
|
152
152
|
* @summary Create the commission settlement publish
|
|
@@ -215,7 +215,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
|
|
|
215
215
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
216
216
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
217
217
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
218
|
-
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
218
|
+
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
219
219
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
220
220
|
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
221
221
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
@@ -223,7 +223,7 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
|
|
|
223
223
|
* @param {*} [options] Override http request option.
|
|
224
224
|
* @throws {RequiredError}
|
|
225
225
|
*/
|
|
226
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
|
|
226
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
|
|
227
227
|
/**
|
|
228
228
|
* This will publish multiple commission settlements.
|
|
229
229
|
* @summary Create the commission settlement publish
|
|
@@ -342,10 +342,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
342
342
|
readonly pageToken?: string;
|
|
343
343
|
/**
|
|
344
344
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
345
|
-
* @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
|
|
345
|
+
* @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode'}
|
|
346
346
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
347
347
|
*/
|
|
348
|
-
readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
|
|
348
|
+
readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'commissions.commissionAgreementCode' | 'commissions.commissionAgreementVersionCode';
|
|
349
349
|
/**
|
|
350
350
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
351
351
|
* @type {string}
|
|
@@ -253,7 +253,7 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
|
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
254
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
|
-
* @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.
|
|
256
|
+
* @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.
|
|
257
257
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
258
|
* @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.
|
|
259
259
|
* @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.
|
|
@@ -550,7 +550,7 @@ var CommissionSettlementsApiFp = function (configuration) {
|
|
|
550
550
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
551
551
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
552
552
|
* @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.
|
|
553
|
-
* @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.
|
|
553
|
+
* @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.
|
|
554
554
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
555
555
|
* @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.
|
|
556
556
|
* @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.
|
|
@@ -685,7 +685,7 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
|
|
|
685
685
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
686
686
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
687
687
|
* @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.
|
|
688
|
-
* @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.
|
|
688
|
+
* @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.
|
|
689
689
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
690
690
|
* @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.
|
|
691
691
|
* @param {'commissions'} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
@@ -19,6 +19,7 @@ import { CreateCommissionResponseClass } from '../models';
|
|
|
19
19
|
import { EstimateCommissionsRequestDto } from '../models';
|
|
20
20
|
import { EstimateCommissionsResponseClass } from '../models';
|
|
21
21
|
import { GetCommissionResponseClass } from '../models';
|
|
22
|
+
import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
|
|
22
23
|
import { ListCommissionsResponseClass } from '../models';
|
|
23
24
|
import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
|
|
24
25
|
import { TriggerDueCommissionClawbacksRequestDto } from '../models';
|
|
@@ -77,6 +78,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
77
78
|
* @throws {RequiredError}
|
|
78
79
|
*/
|
|
79
80
|
getCommission: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
81
|
+
/**
|
|
82
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
83
|
+
* @summary List commission paid invoice entries
|
|
84
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
85
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
86
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
87
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
88
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
89
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
90
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
91
|
+
* @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>
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
listCommissionPaidInvoiceEntries: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
96
|
/**
|
|
81
97
|
* Retrieves a list of commissions.
|
|
82
98
|
* @summary List commissions
|
|
@@ -179,6 +195,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
|
|
|
179
195
|
* @throws {RequiredError}
|
|
180
196
|
*/
|
|
181
197
|
getCommission(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionResponseClass>>;
|
|
198
|
+
/**
|
|
199
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
200
|
+
* @summary List commission paid invoice entries
|
|
201
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
203
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
204
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
205
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
206
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
207
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
208
|
+
* @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>
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>>;
|
|
182
213
|
/**
|
|
183
214
|
* Retrieves a list of commissions.
|
|
184
215
|
* @summary List commissions
|
|
@@ -281,6 +312,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
|
|
|
281
312
|
* @throws {RequiredError}
|
|
282
313
|
*/
|
|
283
314
|
getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass>;
|
|
315
|
+
/**
|
|
316
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
317
|
+
* @summary List commission paid invoice entries
|
|
318
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
319
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
320
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
321
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
322
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
323
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
324
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
325
|
+
* @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>
|
|
326
|
+
* @param {*} [options] Override http request option.
|
|
327
|
+
* @throws {RequiredError}
|
|
328
|
+
*/
|
|
329
|
+
listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>;
|
|
284
330
|
/**
|
|
285
331
|
* Retrieves a list of commissions.
|
|
286
332
|
* @summary List commissions
|
|
@@ -438,6 +484,61 @@ export interface CommissionsApiGetCommissionRequest {
|
|
|
438
484
|
*/
|
|
439
485
|
readonly authorization?: string;
|
|
440
486
|
}
|
|
487
|
+
/**
|
|
488
|
+
* Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
|
|
489
|
+
* @export
|
|
490
|
+
* @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
|
|
491
|
+
*/
|
|
492
|
+
export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
|
|
493
|
+
/**
|
|
494
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
495
|
+
* @type {string}
|
|
496
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
497
|
+
*/
|
|
498
|
+
readonly authorization?: string;
|
|
499
|
+
/**
|
|
500
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
501
|
+
* @type {number}
|
|
502
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
503
|
+
*/
|
|
504
|
+
readonly pageSize?: number;
|
|
505
|
+
/**
|
|
506
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
509
|
+
*/
|
|
510
|
+
readonly pageToken?: string;
|
|
511
|
+
/**
|
|
512
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
513
|
+
* @type {string}
|
|
514
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
515
|
+
*/
|
|
516
|
+
readonly filter?: string;
|
|
517
|
+
/**
|
|
518
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
519
|
+
* @type {string}
|
|
520
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
521
|
+
*/
|
|
522
|
+
readonly search?: string;
|
|
523
|
+
/**
|
|
524
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo</i>
|
|
525
|
+
* @type {string}
|
|
526
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
527
|
+
*/
|
|
528
|
+
readonly order?: string;
|
|
529
|
+
/**
|
|
530
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
531
|
+
* @type {string}
|
|
532
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
533
|
+
*/
|
|
534
|
+
readonly expand?: string;
|
|
535
|
+
/**
|
|
536
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
537
|
+
* @type {string}
|
|
538
|
+
* @memberof CommissionsApiListCommissionPaidInvoiceEntries
|
|
539
|
+
*/
|
|
540
|
+
readonly filters?: string;
|
|
541
|
+
}
|
|
441
542
|
/**
|
|
442
543
|
* Request parameters for listCommissions operation in CommissionsApi.
|
|
443
544
|
* @export
|
|
@@ -644,6 +745,15 @@ export declare class CommissionsApi extends BaseAPI {
|
|
|
644
745
|
* @memberof CommissionsApi
|
|
645
746
|
*/
|
|
646
747
|
getCommission(requestParameters: CommissionsApiGetCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionResponseClass, any, {}>>;
|
|
748
|
+
/**
|
|
749
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
750
|
+
* @summary List commission paid invoice entries
|
|
751
|
+
* @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
* @memberof CommissionsApi
|
|
755
|
+
*/
|
|
756
|
+
listCommissionPaidInvoiceEntries(requestParameters?: CommissionsApiListCommissionPaidInvoiceEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionPaidInvoiceEntriesResponseClass, any, {}>>;
|
|
647
757
|
/**
|
|
648
758
|
* Retrieves a list of commissions.
|
|
649
759
|
* @summary List commissions
|
|
@@ -349,6 +349,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
349
349
|
});
|
|
350
350
|
});
|
|
351
351
|
},
|
|
352
|
+
/**
|
|
353
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
354
|
+
* @summary List commission paid invoice entries
|
|
355
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
356
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
357
|
+
* @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.
|
|
358
|
+
* @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>
|
|
359
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
360
|
+
* @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>
|
|
361
|
+
* @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/>
|
|
362
|
+
* @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>
|
|
363
|
+
* @param {*} [options] Override http request option.
|
|
364
|
+
* @throws {RequiredError}
|
|
365
|
+
*/
|
|
366
|
+
listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
367
|
+
if (options === void 0) { options = {}; }
|
|
368
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
369
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
370
|
+
return __generator(this, function (_a) {
|
|
371
|
+
switch (_a.label) {
|
|
372
|
+
case 0:
|
|
373
|
+
localVarPath = "/commissionservice/v1/commissions/paid-invoice-entries";
|
|
374
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
375
|
+
if (configuration) {
|
|
376
|
+
baseOptions = configuration.baseOptions;
|
|
377
|
+
baseAccessToken = configuration.accessToken;
|
|
378
|
+
}
|
|
379
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
380
|
+
localVarHeaderParameter = {};
|
|
381
|
+
localVarQueryParameter = {};
|
|
382
|
+
// authentication bearer required
|
|
383
|
+
// http bearer authentication required
|
|
384
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
385
|
+
case 1:
|
|
386
|
+
// authentication bearer required
|
|
387
|
+
// http bearer authentication required
|
|
388
|
+
_a.sent();
|
|
389
|
+
if (pageSize !== undefined) {
|
|
390
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
391
|
+
}
|
|
392
|
+
if (pageToken !== undefined) {
|
|
393
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
394
|
+
}
|
|
395
|
+
if (filter !== undefined) {
|
|
396
|
+
localVarQueryParameter['filter'] = filter;
|
|
397
|
+
}
|
|
398
|
+
if (search !== undefined) {
|
|
399
|
+
localVarQueryParameter['search'] = search;
|
|
400
|
+
}
|
|
401
|
+
if (order !== undefined) {
|
|
402
|
+
localVarQueryParameter['order'] = order;
|
|
403
|
+
}
|
|
404
|
+
if (expand !== undefined) {
|
|
405
|
+
localVarQueryParameter['expand'] = expand;
|
|
406
|
+
}
|
|
407
|
+
if (filters !== undefined) {
|
|
408
|
+
localVarQueryParameter['filters'] = filters;
|
|
409
|
+
}
|
|
410
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
411
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
412
|
+
}
|
|
413
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
414
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
415
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
416
|
+
return [2 /*return*/, {
|
|
417
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
418
|
+
options: localVarRequestOptions,
|
|
419
|
+
}];
|
|
420
|
+
}
|
|
421
|
+
});
|
|
422
|
+
});
|
|
423
|
+
},
|
|
352
424
|
/**
|
|
353
425
|
* Retrieves a list of commissions.
|
|
354
426
|
* @summary List commissions
|
|
@@ -712,6 +784,33 @@ var CommissionsApiFp = function (configuration) {
|
|
|
712
784
|
});
|
|
713
785
|
});
|
|
714
786
|
},
|
|
787
|
+
/**
|
|
788
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
789
|
+
* @summary List commission paid invoice entries
|
|
790
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
791
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
792
|
+
* @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.
|
|
793
|
+
* @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>
|
|
794
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
795
|
+
* @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>
|
|
796
|
+
* @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/>
|
|
797
|
+
* @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>
|
|
798
|
+
* @param {*} [options] Override http request option.
|
|
799
|
+
* @throws {RequiredError}
|
|
800
|
+
*/
|
|
801
|
+
listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
802
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
803
|
+
var localVarAxiosArgs;
|
|
804
|
+
return __generator(this, function (_a) {
|
|
805
|
+
switch (_a.label) {
|
|
806
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
807
|
+
case 1:
|
|
808
|
+
localVarAxiosArgs = _a.sent();
|
|
809
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
810
|
+
}
|
|
811
|
+
});
|
|
812
|
+
});
|
|
813
|
+
},
|
|
715
814
|
/**
|
|
716
815
|
* Retrieves a list of commissions.
|
|
717
816
|
* @summary List commissions
|
|
@@ -876,6 +975,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
876
975
|
getCommission: function (code, expand, authorization, options) {
|
|
877
976
|
return localVarFp.getCommission(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
878
977
|
},
|
|
978
|
+
/**
|
|
979
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
980
|
+
* @summary List commission paid invoice entries
|
|
981
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
982
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
983
|
+
* @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.
|
|
984
|
+
* @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>
|
|
985
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
986
|
+
* @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>
|
|
987
|
+
* @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/>
|
|
988
|
+
* @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>
|
|
989
|
+
* @param {*} [options] Override http request option.
|
|
990
|
+
* @throws {RequiredError}
|
|
991
|
+
*/
|
|
992
|
+
listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
993
|
+
return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
994
|
+
},
|
|
879
995
|
/**
|
|
880
996
|
* Retrieves a list of commissions.
|
|
881
997
|
* @summary List commissions
|
|
@@ -1007,6 +1123,19 @@ var CommissionsApi = /** @class */ (function (_super) {
|
|
|
1007
1123
|
var _this = this;
|
|
1008
1124
|
return (0, exports.CommissionsApiFp)(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1009
1125
|
};
|
|
1126
|
+
/**
|
|
1127
|
+
* Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
|
|
1128
|
+
* @summary List commission paid invoice entries
|
|
1129
|
+
* @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
|
|
1130
|
+
* @param {*} [options] Override http request option.
|
|
1131
|
+
* @throws {RequiredError}
|
|
1132
|
+
* @memberof CommissionsApi
|
|
1133
|
+
*/
|
|
1134
|
+
CommissionsApi.prototype.listCommissionPaidInvoiceEntries = function (requestParameters, options) {
|
|
1135
|
+
var _this = this;
|
|
1136
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
1137
|
+
return (0, exports.CommissionsApiFp)(this.configuration).listCommissionPaidInvoiceEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1138
|
+
};
|
|
1010
1139
|
/**
|
|
1011
1140
|
* Retrieves a list of commissions.
|
|
1012
1141
|
* @summary List commissions
|
|
@@ -33,4 +33,10 @@ export interface ClawbackConfigClass {
|
|
|
33
33
|
* @memberof ClawbackConfigClass
|
|
34
34
|
*/
|
|
35
35
|
'intermediarySwitched': boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Allow automatic commission clawback creation for reopened invoices.
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof ClawbackConfigClass
|
|
40
|
+
*/
|
|
41
|
+
'invoiceReopened': boolean;
|
|
36
42
|
}
|
|
@@ -33,4 +33,10 @@ export interface ClawbackConfigDto {
|
|
|
33
33
|
* @memberof ClawbackConfigDto
|
|
34
34
|
*/
|
|
35
35
|
'intermediarySwitched': boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Allow automatic commission clawback creation for reopened invoices.
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof ClawbackConfigDto
|
|
40
|
+
*/
|
|
41
|
+
'invoiceReopened': boolean;
|
|
36
42
|
}
|
|
@@ -60,7 +60,7 @@ export interface CommissionAgreementClass {
|
|
|
60
60
|
*/
|
|
61
61
|
'description'?: string;
|
|
62
62
|
/**
|
|
63
|
-
* Frequency at which commissions are billed (e.g.,
|
|
63
|
+
* Frequency at which commissions are billed (e.g., manual, monthly, quarterly, halfYearly, yearly)
|
|
64
64
|
* @type {string}
|
|
65
65
|
* @memberof CommissionAgreementClass
|
|
66
66
|
*/
|
|
@@ -104,7 +104,7 @@ export declare const CommissionAgreementClassStatusEnum: {
|
|
|
104
104
|
};
|
|
105
105
|
export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
|
|
106
106
|
export declare const CommissionAgreementClassBillingFrequencyEnum: {
|
|
107
|
-
readonly
|
|
107
|
+
readonly Manual: "manual";
|
|
108
108
|
readonly Monthly: "monthly";
|
|
109
109
|
readonly Quarterly: "quarterly";
|
|
110
110
|
readonly HalfYearly: "halfYearly";
|
|
@@ -21,7 +21,7 @@ exports.CommissionAgreementClassStatusEnum = {
|
|
|
21
21
|
Archived: 'archived'
|
|
22
22
|
};
|
|
23
23
|
exports.CommissionAgreementClassBillingFrequencyEnum = {
|
|
24
|
-
|
|
24
|
+
Manual: 'manual',
|
|
25
25
|
Monthly: 'monthly',
|
|
26
26
|
Quarterly: 'quarterly',
|
|
27
27
|
HalfYearly: 'halfYearly',
|