@emilgroup/commission-sdk-node 1.0.0-beta.4 → 1.0.0-beta.40
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 +39 -0
- package/README.md +2 -2
- package/api/commission-agreement-products-api.ts +655 -0
- package/api/commission-agreement-rules-api.ts +762 -0
- package/api/commission-agreements-api.ts +160 -27
- package/api/commission-recipients-api.ts +92 -37
- package/api/commission-settlements-api.ts +804 -0
- package/api/commissions-api.ts +121 -18
- package/api.ts +6 -0
- package/dist/api/commission-agreement-products-api.d.ts +366 -0
- package/dist/api/commission-agreement-products-api.js +630 -0
- package/dist/api/commission-agreement-rules-api.d.ts +423 -0
- package/dist/api/commission-agreement-rules-api.js +723 -0
- package/dist/api/commission-agreements-api.d.ts +98 -23
- package/dist/api/commission-agreements-api.js +127 -22
- package/dist/api/commission-recipients-api.d.ts +63 -27
- package/dist/api/commission-recipients-api.js +53 -29
- package/dist/api/commission-settlements-api.d.ts +450 -0
- package/dist/api/commission-settlements-api.js +741 -0
- package/dist/api/commissions-api.d.ts +74 -18
- package/dist/api/commissions-api.js +101 -9
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/models/commission-agreement-class.d.ts +27 -3
- package/dist/models/commission-agreement-class.js +5 -1
- package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
- package/dist/models/commission-agreement-metadata-dto.js +15 -0
- package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
- package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
- package/dist/models/commission-agreement-product-class.d.ts +77 -0
- package/dist/models/commission-agreement-product-class.js +20 -0
- package/dist/models/commission-agreement-rule-class.d.ts +93 -0
- package/dist/models/commission-agreement-rule-class.js +21 -0
- package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
- package/dist/models/commission-agreement-rule-config-dto.js +15 -0
- package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
- package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
- package/dist/models/commission-agreement-version-class.d.ts +7 -0
- package/dist/models/commission-class.d.ts +37 -6
- package/dist/models/commission-conditions-dto.d.ts +24 -0
- package/dist/models/commission-conditions-dto.js +15 -0
- package/dist/models/commission-config-dto.d.ts +63 -0
- package/dist/models/commission-config-dto.js +34 -0
- package/dist/models/commission-estimate-class.d.ts +59 -0
- package/dist/models/commission-estimate-class.js +25 -0
- package/dist/models/commission-settlement-class.d.ts +124 -0
- package/dist/models/commission-settlement-class.js +35 -0
- package/dist/models/create-commission-agreement-product-request-dto.d.ts +30 -0
- package/dist/models/create-commission-agreement-product-request-dto.js +15 -0
- package/dist/models/create-commission-agreement-product-response-class.d.ts +25 -0
- package/dist/models/create-commission-agreement-product-response-class.js +15 -0
- package/dist/models/create-commission-agreement-request-dto.d.ts +14 -3
- package/dist/models/create-commission-agreement-request-dto.js +5 -1
- package/dist/models/create-commission-agreement-rule-request-dto.d.ts +37 -0
- package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
- package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
- package/dist/models/create-commission-request-dto.d.ts +3 -9
- package/dist/models/create-commission-settlement-request-dto.d.ts +57 -0
- package/dist/models/create-commission-settlement-request-dto.js +35 -0
- package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
- package/dist/models/create-commission-settlement-response-class.js +15 -0
- package/dist/models/estimate-commissions-response-class.d.ts +73 -0
- package/dist/models/estimate-commissions-response-class.js +15 -0
- package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
- package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
- package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/evaluated-commission-class.d.ts +54 -0
- package/dist/models/evaluated-commission-class.js +21 -0
- package/dist/models/get-commission-agreement-product-response-class.d.ts +25 -0
- package/dist/models/get-commission-agreement-product-response-class.js +15 -0
- package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
- package/dist/models/get-commission-settlement-response-class.js +15 -0
- package/dist/models/index.d.ts +36 -0
- package/dist/models/index.js +36 -0
- package/dist/models/list-commission-agreement-products-response-class.d.ts +43 -0
- package/dist/models/list-commission-agreement-products-response-class.js +15 -0
- package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
- package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
- package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
- package/dist/models/list-commission-settlements-response-class.js +15 -0
- package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
- package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
- package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
- package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
- package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
- package/dist/models/publish-commission-settlements-request-dto.js +15 -0
- package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
- package/dist/models/publish-commission-settlements-response-class.js +15 -0
- package/dist/models/update-commission-agreement-product-request-dto.d.ts +41 -0
- package/dist/models/update-commission-agreement-product-request-dto.js +20 -0
- package/dist/models/update-commission-agreement-product-response-class.d.ts +25 -0
- package/dist/models/update-commission-agreement-product-response-class.js +15 -0
- package/dist/models/update-commission-agreement-request-dto.d.ts +3 -1
- package/dist/models/update-commission-agreement-request-dto.js +2 -0
- package/dist/models/update-commission-agreement-rule-request-dto.d.ts +49 -0
- package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
- package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
- package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
- package/dist/models/update-commission-request-dto.d.ts +5 -3
- package/dist/models/update-commission-request-dto.js +4 -2
- package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
- package/dist/models/update-commission-settlement-request-dto.js +22 -0
- package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
- package/dist/models/update-commission-settlement-response-class.js +15 -0
- package/models/commission-agreement-class.ts +27 -3
- package/models/commission-agreement-metadata-dto.ts +31 -0
- package/models/commission-agreement-metadata-partner-dto.ts +36 -0
- package/models/commission-agreement-product-class.ts +86 -0
- package/models/commission-agreement-rule-class.ts +102 -0
- package/models/commission-agreement-rule-config-dto.ts +31 -0
- package/models/commission-agreement-rule-evaluation-class.ts +37 -0
- package/models/commission-agreement-version-class.ts +7 -0
- package/models/commission-class.ts +37 -6
- package/models/commission-conditions-dto.ts +30 -0
- package/models/commission-config-dto.ts +73 -0
- package/models/commission-estimate-class.ts +69 -0
- package/models/commission-settlement-class.ts +134 -0
- package/models/create-commission-agreement-product-request-dto.ts +36 -0
- package/models/create-commission-agreement-product-response-class.ts +31 -0
- package/models/create-commission-agreement-request-dto.ts +14 -3
- package/models/create-commission-agreement-rule-request-dto.ts +43 -0
- package/models/create-commission-agreement-rule-response-class.ts +31 -0
- package/models/create-commission-agreement-version-request-dto.ts +1 -1
- package/models/create-commission-request-dto.ts +3 -9
- package/models/create-commission-settlement-request-dto.ts +67 -0
- package/models/create-commission-settlement-response-class.ts +31 -0
- package/models/estimate-commissions-response-class.ts +79 -0
- package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
- package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
- package/models/evaluated-commission-class.ts +63 -0
- package/models/get-commission-agreement-product-response-class.ts +31 -0
- package/models/get-commission-agreement-rule-response-class.ts +31 -0
- package/models/get-commission-settlement-response-class.ts +31 -0
- package/models/index.ts +36 -0
- package/models/list-commission-agreement-products-response-class.ts +49 -0
- package/models/list-commission-agreement-rules-response-class.ts +49 -0
- package/models/list-commission-settlements-response-class.ts +49 -0
- package/models/patch-commission-agreement-status-request-dto.ts +46 -0
- package/models/patch-commission-agreement-status-response-class.ts +31 -0
- package/models/publish-commission-settlements-request-dto.ts +30 -0
- package/models/publish-commission-settlements-response-class.ts +31 -0
- package/models/update-commission-agreement-product-request-dto.ts +50 -0
- package/models/update-commission-agreement-product-response-class.ts +31 -0
- package/models/update-commission-agreement-request-dto.ts +3 -1
- package/models/update-commission-agreement-rule-request-dto.ts +58 -0
- package/models/update-commission-agreement-rule-response-class.ts +31 -0
- package/models/update-commission-request-dto.ts +5 -3
- package/models/update-commission-settlement-request-dto.ts +52 -0
- package/models/update-commission-settlement-response-class.ts +31 -0
- package/package.json +1 -1
|
@@ -0,0 +1,423 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL CommissionService
|
|
3
|
+
* The EMIL CommissionService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreateCommissionAgreementRuleRequestDto } from '../models';
|
|
16
|
+
import { CreateCommissionAgreementRuleResponseClass } from '../models';
|
|
17
|
+
import { EvaluateCommissionAgreementRuleRequestDto } from '../models';
|
|
18
|
+
import { EvaluateCommissionAgreementRuleResponseClass } from '../models';
|
|
19
|
+
import { GetCommissionAgreementRuleResponseClass } from '../models';
|
|
20
|
+
import { ListCommissionAgreementRulesResponseClass } from '../models';
|
|
21
|
+
import { UpdateCommissionAgreementRuleRequestDto } from '../models';
|
|
22
|
+
import { UpdateCommissionAgreementRuleResponseClass } from '../models';
|
|
23
|
+
/**
|
|
24
|
+
* CommissionAgreementRulesApi - axios parameter creator
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* This will create commission agreement rule.
|
|
30
|
+
* @summary Create the commission agreement rule
|
|
31
|
+
* @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
|
|
32
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
createCommissionAgreementRule: (createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* This will delete commission agreement rule.
|
|
39
|
+
* @summary Delete the commission agreement rule
|
|
40
|
+
* @param {string} code Unique identifier for the object.
|
|
41
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
deleteCommissionAgreementRule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
+
/**
|
|
47
|
+
* Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
|
|
48
|
+
* @summary Create the commission agreement rule evaluation
|
|
49
|
+
* @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
|
|
50
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
evaluateCommissionAgreementRule: (evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* This will get commission agreement rule.
|
|
57
|
+
* @summary Retrieve the commission agreement rule
|
|
58
|
+
* @param {string} code
|
|
59
|
+
* @param {string} expand
|
|
60
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
61
|
+
* @param {*} [options] Override http request option.
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
*/
|
|
64
|
+
getCommissionAgreementRule: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
|
+
/**
|
|
66
|
+
* Retrieves a list of commission agreement rules.
|
|
67
|
+
* @summary List commission agreement rules
|
|
68
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
69
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
70
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
71
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, status</i>
|
|
72
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
listCommissionAgreementRules: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
+
/**
|
|
78
|
+
* This will update commission agreement rule.
|
|
79
|
+
* @summary Update the commission agreement rule
|
|
80
|
+
* @param {string} code Unique identifier for the object.
|
|
81
|
+
* @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
|
|
82
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
updateCommissionAgreementRule: (code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
* CommissionAgreementRulesApi - functional programming interface
|
|
90
|
+
* @export
|
|
91
|
+
*/
|
|
92
|
+
export declare const CommissionAgreementRulesApiFp: (configuration?: Configuration) => {
|
|
93
|
+
/**
|
|
94
|
+
* This will create commission agreement rule.
|
|
95
|
+
* @summary Create the commission agreement rule
|
|
96
|
+
* @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
|
|
97
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
+
* @param {*} [options] Override http request option.
|
|
99
|
+
* @throws {RequiredError}
|
|
100
|
+
*/
|
|
101
|
+
createCommissionAgreementRule(createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementRuleResponseClass>>;
|
|
102
|
+
/**
|
|
103
|
+
* This will delete commission agreement rule.
|
|
104
|
+
* @summary Delete the commission agreement rule
|
|
105
|
+
* @param {string} code Unique identifier for the object.
|
|
106
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
deleteCommissionAgreementRule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
111
|
+
/**
|
|
112
|
+
* Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
|
|
113
|
+
* @summary Create the commission agreement rule evaluation
|
|
114
|
+
* @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
|
|
115
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EvaluateCommissionAgreementRuleResponseClass>>;
|
|
120
|
+
/**
|
|
121
|
+
* This will get commission agreement rule.
|
|
122
|
+
* @summary Retrieve the commission agreement rule
|
|
123
|
+
* @param {string} code
|
|
124
|
+
* @param {string} expand
|
|
125
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
getCommissionAgreementRule(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementRuleResponseClass>>;
|
|
130
|
+
/**
|
|
131
|
+
* Retrieves a list of commission agreement rules.
|
|
132
|
+
* @summary List commission agreement rules
|
|
133
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
135
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
136
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, status</i>
|
|
137
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
listCommissionAgreementRules(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementRulesResponseClass>>;
|
|
142
|
+
/**
|
|
143
|
+
* This will update commission agreement rule.
|
|
144
|
+
* @summary Update the commission agreement rule
|
|
145
|
+
* @param {string} code Unique identifier for the object.
|
|
146
|
+
* @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
|
|
147
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
updateCommissionAgreementRule(code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementRuleResponseClass>>;
|
|
152
|
+
};
|
|
153
|
+
/**
|
|
154
|
+
* CommissionAgreementRulesApi - factory interface
|
|
155
|
+
* @export
|
|
156
|
+
*/
|
|
157
|
+
export declare const CommissionAgreementRulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
158
|
+
/**
|
|
159
|
+
* This will create commission agreement rule.
|
|
160
|
+
* @summary Create the commission agreement rule
|
|
161
|
+
* @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
|
|
162
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
createCommissionAgreementRule(createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementRuleResponseClass>;
|
|
167
|
+
/**
|
|
168
|
+
* This will delete commission agreement rule.
|
|
169
|
+
* @summary Delete the commission agreement rule
|
|
170
|
+
* @param {string} code Unique identifier for the object.
|
|
171
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
172
|
+
* @param {*} [options] Override http request option.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
*/
|
|
175
|
+
deleteCommissionAgreementRule(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
176
|
+
/**
|
|
177
|
+
* Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
|
|
178
|
+
* @summary Create the commission agreement rule evaluation
|
|
179
|
+
* @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
|
|
180
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<EvaluateCommissionAgreementRuleResponseClass>;
|
|
185
|
+
/**
|
|
186
|
+
* This will get commission agreement rule.
|
|
187
|
+
* @summary Retrieve the commission agreement rule
|
|
188
|
+
* @param {string} code
|
|
189
|
+
* @param {string} expand
|
|
190
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
getCommissionAgreementRule(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementRuleResponseClass>;
|
|
195
|
+
/**
|
|
196
|
+
* Retrieves a list of commission agreement rules.
|
|
197
|
+
* @summary List commission agreement rules
|
|
198
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
199
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
200
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
201
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, status</i>
|
|
202
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
203
|
+
* @param {*} [options] Override http request option.
|
|
204
|
+
* @throws {RequiredError}
|
|
205
|
+
*/
|
|
206
|
+
listCommissionAgreementRules(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCommissionAgreementRulesResponseClass>;
|
|
207
|
+
/**
|
|
208
|
+
* This will update commission agreement rule.
|
|
209
|
+
* @summary Update the commission agreement rule
|
|
210
|
+
* @param {string} code Unique identifier for the object.
|
|
211
|
+
* @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
|
|
212
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
213
|
+
* @param {*} [options] Override http request option.
|
|
214
|
+
* @throws {RequiredError}
|
|
215
|
+
*/
|
|
216
|
+
updateCommissionAgreementRule(code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementRuleResponseClass>;
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* Request parameters for createCommissionAgreementRule operation in CommissionAgreementRulesApi.
|
|
220
|
+
* @export
|
|
221
|
+
* @interface CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest
|
|
222
|
+
*/
|
|
223
|
+
export interface CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest {
|
|
224
|
+
/**
|
|
225
|
+
*
|
|
226
|
+
* @type {CreateCommissionAgreementRuleRequestDto}
|
|
227
|
+
* @memberof CommissionAgreementRulesApiCreateCommissionAgreementRule
|
|
228
|
+
*/
|
|
229
|
+
readonly createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto;
|
|
230
|
+
/**
|
|
231
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
|
+
* @type {string}
|
|
233
|
+
* @memberof CommissionAgreementRulesApiCreateCommissionAgreementRule
|
|
234
|
+
*/
|
|
235
|
+
readonly authorization?: string;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Request parameters for deleteCommissionAgreementRule operation in CommissionAgreementRulesApi.
|
|
239
|
+
* @export
|
|
240
|
+
* @interface CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest
|
|
241
|
+
*/
|
|
242
|
+
export interface CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest {
|
|
243
|
+
/**
|
|
244
|
+
* Unique identifier for the object.
|
|
245
|
+
* @type {string}
|
|
246
|
+
* @memberof CommissionAgreementRulesApiDeleteCommissionAgreementRule
|
|
247
|
+
*/
|
|
248
|
+
readonly code: string;
|
|
249
|
+
/**
|
|
250
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
|
+
* @type {string}
|
|
252
|
+
* @memberof CommissionAgreementRulesApiDeleteCommissionAgreementRule
|
|
253
|
+
*/
|
|
254
|
+
readonly authorization?: string;
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* Request parameters for evaluateCommissionAgreementRule operation in CommissionAgreementRulesApi.
|
|
258
|
+
* @export
|
|
259
|
+
* @interface CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest
|
|
260
|
+
*/
|
|
261
|
+
export interface CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest {
|
|
262
|
+
/**
|
|
263
|
+
*
|
|
264
|
+
* @type {EvaluateCommissionAgreementRuleRequestDto}
|
|
265
|
+
* @memberof CommissionAgreementRulesApiEvaluateCommissionAgreementRule
|
|
266
|
+
*/
|
|
267
|
+
readonly evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto;
|
|
268
|
+
/**
|
|
269
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
+
* @type {string}
|
|
271
|
+
* @memberof CommissionAgreementRulesApiEvaluateCommissionAgreementRule
|
|
272
|
+
*/
|
|
273
|
+
readonly authorization?: string;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* Request parameters for getCommissionAgreementRule operation in CommissionAgreementRulesApi.
|
|
277
|
+
* @export
|
|
278
|
+
* @interface CommissionAgreementRulesApiGetCommissionAgreementRuleRequest
|
|
279
|
+
*/
|
|
280
|
+
export interface CommissionAgreementRulesApiGetCommissionAgreementRuleRequest {
|
|
281
|
+
/**
|
|
282
|
+
*
|
|
283
|
+
* @type {string}
|
|
284
|
+
* @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
|
|
285
|
+
*/
|
|
286
|
+
readonly code: string;
|
|
287
|
+
/**
|
|
288
|
+
*
|
|
289
|
+
* @type {string}
|
|
290
|
+
* @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
|
|
291
|
+
*/
|
|
292
|
+
readonly expand: string;
|
|
293
|
+
/**
|
|
294
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
295
|
+
* @type {string}
|
|
296
|
+
* @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
|
|
297
|
+
*/
|
|
298
|
+
readonly authorization?: string;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.
|
|
302
|
+
* @export
|
|
303
|
+
* @interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
304
|
+
*/
|
|
305
|
+
export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest {
|
|
306
|
+
/**
|
|
307
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
+
* @type {string}
|
|
309
|
+
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
310
|
+
*/
|
|
311
|
+
readonly authorization?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
314
|
+
* @type {string}
|
|
315
|
+
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
316
|
+
*/
|
|
317
|
+
readonly filter?: string;
|
|
318
|
+
/**
|
|
319
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
320
|
+
* @type {string}
|
|
321
|
+
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
322
|
+
*/
|
|
323
|
+
readonly filters?: string;
|
|
324
|
+
/**
|
|
325
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, status</i>
|
|
326
|
+
* @type {string}
|
|
327
|
+
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
328
|
+
*/
|
|
329
|
+
readonly order?: string;
|
|
330
|
+
/**
|
|
331
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
332
|
+
* @type {string}
|
|
333
|
+
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
334
|
+
*/
|
|
335
|
+
readonly expand?: string;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* Request parameters for updateCommissionAgreementRule operation in CommissionAgreementRulesApi.
|
|
339
|
+
* @export
|
|
340
|
+
* @interface CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest
|
|
341
|
+
*/
|
|
342
|
+
export interface CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest {
|
|
343
|
+
/**
|
|
344
|
+
* Unique identifier for the object.
|
|
345
|
+
* @type {string}
|
|
346
|
+
* @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
|
|
347
|
+
*/
|
|
348
|
+
readonly code: string;
|
|
349
|
+
/**
|
|
350
|
+
*
|
|
351
|
+
* @type {UpdateCommissionAgreementRuleRequestDto}
|
|
352
|
+
* @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
|
|
353
|
+
*/
|
|
354
|
+
readonly updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto;
|
|
355
|
+
/**
|
|
356
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
|
+
* @type {string}
|
|
358
|
+
* @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
|
|
359
|
+
*/
|
|
360
|
+
readonly authorization?: string;
|
|
361
|
+
}
|
|
362
|
+
/**
|
|
363
|
+
* CommissionAgreementRulesApi - object-oriented interface
|
|
364
|
+
* @export
|
|
365
|
+
* @class CommissionAgreementRulesApi
|
|
366
|
+
* @extends {BaseAPI}
|
|
367
|
+
*/
|
|
368
|
+
export declare class CommissionAgreementRulesApi extends BaseAPI {
|
|
369
|
+
/**
|
|
370
|
+
* This will create commission agreement rule.
|
|
371
|
+
* @summary Create the commission agreement rule
|
|
372
|
+
* @param {CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest} requestParameters Request parameters.
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
* @memberof CommissionAgreementRulesApi
|
|
376
|
+
*/
|
|
377
|
+
createCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementRuleResponseClass, any, {}>>;
|
|
378
|
+
/**
|
|
379
|
+
* This will delete commission agreement rule.
|
|
380
|
+
* @summary Delete the commission agreement rule
|
|
381
|
+
* @param {CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest} requestParameters Request parameters.
|
|
382
|
+
* @param {*} [options] Override http request option.
|
|
383
|
+
* @throws {RequiredError}
|
|
384
|
+
* @memberof CommissionAgreementRulesApi
|
|
385
|
+
*/
|
|
386
|
+
deleteCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
387
|
+
/**
|
|
388
|
+
* Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
|
|
389
|
+
* @summary Create the commission agreement rule evaluation
|
|
390
|
+
* @param {CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest} requestParameters Request parameters.
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
* @memberof CommissionAgreementRulesApi
|
|
394
|
+
*/
|
|
395
|
+
evaluateCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EvaluateCommissionAgreementRuleResponseClass, any, {}>>;
|
|
396
|
+
/**
|
|
397
|
+
* This will get commission agreement rule.
|
|
398
|
+
* @summary Retrieve the commission agreement rule
|
|
399
|
+
* @param {CommissionAgreementRulesApiGetCommissionAgreementRuleRequest} requestParameters Request parameters.
|
|
400
|
+
* @param {*} [options] Override http request option.
|
|
401
|
+
* @throws {RequiredError}
|
|
402
|
+
* @memberof CommissionAgreementRulesApi
|
|
403
|
+
*/
|
|
404
|
+
getCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiGetCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementRuleResponseClass, any, {}>>;
|
|
405
|
+
/**
|
|
406
|
+
* Retrieves a list of commission agreement rules.
|
|
407
|
+
* @summary List commission agreement rules
|
|
408
|
+
* @param {CommissionAgreementRulesApiListCommissionAgreementRulesRequest} requestParameters Request parameters.
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
* @memberof CommissionAgreementRulesApi
|
|
412
|
+
*/
|
|
413
|
+
listCommissionAgreementRules(requestParameters?: CommissionAgreementRulesApiListCommissionAgreementRulesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementRulesResponseClass, any, {}>>;
|
|
414
|
+
/**
|
|
415
|
+
* This will update commission agreement rule.
|
|
416
|
+
* @summary Update the commission agreement rule
|
|
417
|
+
* @param {CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest} requestParameters Request parameters.
|
|
418
|
+
* @param {*} [options] Override http request option.
|
|
419
|
+
* @throws {RequiredError}
|
|
420
|
+
* @memberof CommissionAgreementRulesApi
|
|
421
|
+
*/
|
|
422
|
+
updateCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionAgreementRuleResponseClass, any, {}>>;
|
|
423
|
+
}
|