@emilgroup/commission-sdk 1.0.0-beta.9 → 1.1.1-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/.openapi-generator/FILES +40 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +55 -13
  4. package/api/commission-agreement-rules-api.ts +800 -0
  5. package/api/commission-agreements-api.ts +160 -27
  6. package/api/commission-candidates-api.ts +693 -0
  7. package/api/commission-recipients-api.ts +4 -4
  8. package/api/commission-settlements-api.ts +800 -0
  9. package/api/commissions-api.ts +125 -18
  10. package/api.ts +6 -0
  11. package/dist/api/commission-agreement-products-api.d.ts +35 -8
  12. package/dist/api/commission-agreement-products-api.js +29 -11
  13. package/dist/api/commission-agreement-rules-api.d.ts +450 -0
  14. package/dist/api/commission-agreement-rules-api.js +737 -0
  15. package/dist/api/commission-agreements-api.d.ts +98 -23
  16. package/dist/api/commission-agreements-api.js +127 -22
  17. package/dist/api/commission-candidates-api.d.ts +393 -0
  18. package/dist/api/commission-candidates-api.js +644 -0
  19. package/dist/api/commission-recipients-api.d.ts +4 -4
  20. package/dist/api/commission-recipients-api.js +3 -3
  21. package/dist/api/commission-settlements-api.d.ts +450 -0
  22. package/dist/api/commission-settlements-api.js +737 -0
  23. package/dist/api/commissions-api.d.ts +75 -18
  24. package/dist/api/commissions-api.js +102 -9
  25. package/dist/api.d.ts +3 -0
  26. package/dist/api.js +3 -0
  27. package/dist/models/commission-agreement-class.d.ts +27 -3
  28. package/dist/models/commission-agreement-class.js +5 -1
  29. package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
  30. package/dist/models/commission-agreement-metadata-dto.js +15 -0
  31. package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
  32. package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
  33. package/dist/models/commission-agreement-product-class.d.ts +6 -7
  34. package/dist/models/commission-agreement-rule-class.d.ts +93 -0
  35. package/dist/models/commission-agreement-rule-class.js +21 -0
  36. package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
  37. package/dist/models/commission-agreement-rule-config-dto.js +15 -0
  38. package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
  39. package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
  40. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  41. package/dist/models/commission-candidate-class.d.ts +95 -0
  42. package/dist/models/commission-candidate-class.js +20 -0
  43. package/dist/models/commission-class.d.ts +37 -6
  44. package/dist/models/commission-conditions-dto.d.ts +24 -0
  45. package/dist/models/commission-conditions-dto.js +15 -0
  46. package/dist/models/commission-config-dto.d.ts +63 -0
  47. package/dist/models/commission-config-dto.js +34 -0
  48. package/dist/models/commission-estimate-class.d.ts +59 -0
  49. package/dist/models/commission-estimate-class.js +25 -0
  50. package/dist/models/commission-recipient-class.d.ts +6 -6
  51. package/dist/models/commission-settlement-class.d.ts +124 -0
  52. package/dist/models/commission-settlement-class.js +35 -0
  53. package/dist/models/create-commission-agreement-request-dto.d.ts +14 -3
  54. package/dist/models/create-commission-agreement-request-dto.js +5 -1
  55. package/dist/models/create-commission-agreement-rule-request-dto.d.ts +37 -0
  56. package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
  57. package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
  58. package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
  59. package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
  60. package/dist/models/create-commission-candidate-request-dto.d.ts +65 -0
  61. package/dist/models/create-commission-candidate-request-dto.js +25 -0
  62. package/dist/models/create-commission-candidate-response-class.d.ts +25 -0
  63. package/dist/models/create-commission-candidate-response-class.js +15 -0
  64. package/dist/models/create-commission-recipient-request-dto.d.ts +2 -2
  65. package/dist/models/create-commission-request-dto.d.ts +3 -9
  66. package/dist/models/create-commission-settlement-request-dto.d.ts +57 -0
  67. package/dist/models/create-commission-settlement-request-dto.js +35 -0
  68. package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
  69. package/dist/models/create-commission-settlement-response-class.js +15 -0
  70. package/dist/models/estimate-commissions-request-dto.d.ts +30 -0
  71. package/dist/models/estimate-commissions-request-dto.js +15 -0
  72. package/dist/models/estimate-commissions-response-class.d.ts +73 -0
  73. package/dist/models/estimate-commissions-response-class.js +15 -0
  74. package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
  75. package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
  76. package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
  77. package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
  78. package/dist/models/evaluated-commission-class.d.ts +54 -0
  79. package/dist/models/evaluated-commission-class.js +21 -0
  80. package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
  81. package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
  82. package/dist/models/get-commission-candidate-response-class.d.ts +25 -0
  83. package/dist/models/get-commission-candidate-response-class.js +15 -0
  84. package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
  85. package/dist/models/get-commission-settlement-response-class.js +15 -0
  86. package/dist/models/index.d.ts +37 -0
  87. package/dist/models/index.js +37 -0
  88. package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
  89. package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
  90. package/dist/models/list-commission-candidates-response-class.d.ts +43 -0
  91. package/dist/models/list-commission-candidates-response-class.js +15 -0
  92. package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
  93. package/dist/models/list-commission-settlements-response-class.js +15 -0
  94. package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
  95. package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
  96. package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
  97. package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
  98. package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
  99. package/dist/models/publish-commission-settlements-request-dto.js +15 -0
  100. package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
  101. package/dist/models/publish-commission-settlements-response-class.js +15 -0
  102. package/dist/models/update-commission-agreement-request-dto.d.ts +3 -1
  103. package/dist/models/update-commission-agreement-request-dto.js +2 -0
  104. package/dist/models/update-commission-agreement-rule-request-dto.d.ts +49 -0
  105. package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
  106. package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
  107. package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
  108. package/dist/models/update-commission-candidate-request-dto.d.ts +71 -0
  109. package/dist/models/update-commission-candidate-request-dto.js +25 -0
  110. package/dist/models/update-commission-candidate-response-class.d.ts +25 -0
  111. package/dist/models/update-commission-candidate-response-class.js +15 -0
  112. package/dist/models/update-commission-request-dto.d.ts +5 -3
  113. package/dist/models/update-commission-request-dto.js +4 -2
  114. package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
  115. package/dist/models/update-commission-settlement-request-dto.js +22 -0
  116. package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
  117. package/dist/models/update-commission-settlement-response-class.js +15 -0
  118. package/models/commission-agreement-class.ts +27 -3
  119. package/models/commission-agreement-metadata-dto.ts +31 -0
  120. package/models/commission-agreement-metadata-partner-dto.ts +36 -0
  121. package/models/commission-agreement-product-class.ts +6 -7
  122. package/models/commission-agreement-rule-class.ts +102 -0
  123. package/models/commission-agreement-rule-config-dto.ts +31 -0
  124. package/models/commission-agreement-rule-evaluation-class.ts +37 -0
  125. package/models/commission-agreement-version-class.ts +7 -0
  126. package/models/commission-candidate-class.ts +104 -0
  127. package/models/commission-class.ts +37 -6
  128. package/models/commission-conditions-dto.ts +30 -0
  129. package/models/commission-config-dto.ts +73 -0
  130. package/models/commission-estimate-class.ts +69 -0
  131. package/models/commission-recipient-class.ts +6 -6
  132. package/models/commission-settlement-class.ts +134 -0
  133. package/models/create-commission-agreement-request-dto.ts +14 -3
  134. package/models/create-commission-agreement-rule-request-dto.ts +43 -0
  135. package/models/create-commission-agreement-rule-response-class.ts +31 -0
  136. package/models/create-commission-agreement-version-request-dto.ts +1 -1
  137. package/models/create-commission-candidate-request-dto.ts +75 -0
  138. package/models/create-commission-candidate-response-class.ts +31 -0
  139. package/models/create-commission-recipient-request-dto.ts +2 -2
  140. package/models/create-commission-request-dto.ts +3 -9
  141. package/models/create-commission-settlement-request-dto.ts +67 -0
  142. package/models/create-commission-settlement-response-class.ts +31 -0
  143. package/models/estimate-commissions-request-dto.ts +36 -0
  144. package/models/estimate-commissions-response-class.ts +79 -0
  145. package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
  146. package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
  147. package/models/evaluated-commission-class.ts +63 -0
  148. package/models/get-commission-agreement-rule-response-class.ts +31 -0
  149. package/models/get-commission-candidate-response-class.ts +31 -0
  150. package/models/get-commission-settlement-response-class.ts +31 -0
  151. package/models/index.ts +37 -0
  152. package/models/list-commission-agreement-rules-response-class.ts +49 -0
  153. package/models/list-commission-candidates-response-class.ts +49 -0
  154. package/models/list-commission-settlements-response-class.ts +49 -0
  155. package/models/patch-commission-agreement-status-request-dto.ts +46 -0
  156. package/models/patch-commission-agreement-status-response-class.ts +31 -0
  157. package/models/publish-commission-settlements-request-dto.ts +30 -0
  158. package/models/publish-commission-settlements-response-class.ts +31 -0
  159. package/models/update-commission-agreement-request-dto.ts +3 -1
  160. package/models/update-commission-agreement-rule-request-dto.ts +58 -0
  161. package/models/update-commission-agreement-rule-response-class.ts +31 -0
  162. package/models/update-commission-candidate-request-dto.ts +81 -0
  163. package/models/update-commission-candidate-response-class.ts +31 -0
  164. package/models/update-commission-request-dto.ts +5 -3
  165. package/models/update-commission-settlement-request-dto.ts +52 -0
  166. package/models/update-commission-settlement-response-class.ts +31 -0
  167. package/package.json +2 -1
@@ -0,0 +1,800 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { CreateCommissionAgreementRuleRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateCommissionAgreementRuleResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { EvaluateCommissionAgreementRuleRequestDto } from '../models';
29
+ // @ts-ignore
30
+ import { EvaluateCommissionAgreementRuleResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { GetCommissionAgreementRuleResponseClass } from '../models';
33
+ // @ts-ignore
34
+ import { ListCommissionAgreementRulesResponseClass } from '../models';
35
+ // @ts-ignore
36
+ import { UpdateCommissionAgreementRuleRequestDto } from '../models';
37
+ // @ts-ignore
38
+ import { UpdateCommissionAgreementRuleResponseClass } from '../models';
39
+ /**
40
+ * CommissionAgreementRulesApi - axios parameter creator
41
+ * @export
42
+ */
43
+ export const CommissionAgreementRulesApiAxiosParamCreator = function (configuration?: Configuration) {
44
+ return {
45
+ /**
46
+ * This will create commission agreement rule.
47
+ * @summary Create the commission agreement rule
48
+ * @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
49
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ createCommissionAgreementRule: async (createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54
+ // verify required parameter 'createCommissionAgreementRuleRequestDto' is not null or undefined
55
+ assertParamExists('createCommissionAgreementRule', 'createCommissionAgreementRuleRequestDto', createCommissionAgreementRuleRequestDto)
56
+ const localVarPath = `/commissionservice/v1/agreement-rules`;
57
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
58
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
59
+ let baseOptions;
60
+ let baseAccessToken;
61
+ if (configuration) {
62
+ baseOptions = configuration.baseOptions;
63
+ baseAccessToken = configuration.accessToken;
64
+ }
65
+
66
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
67
+ const localVarHeaderParameter = {} as any;
68
+ const localVarQueryParameter = {} as any;
69
+
70
+ // authentication bearer required
71
+ // http bearer authentication required
72
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
73
+
74
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
75
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
76
+ }
77
+
78
+
79
+
80
+ localVarHeaderParameter['Content-Type'] = 'application/json';
81
+
82
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
83
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
84
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
85
+ localVarRequestOptions.data = serializeDataIfNeeded(createCommissionAgreementRuleRequestDto, localVarRequestOptions, configuration)
86
+
87
+ return {
88
+ url: toPathString(localVarUrlObj),
89
+ options: localVarRequestOptions,
90
+ };
91
+ },
92
+ /**
93
+ * This will delete commission agreement rule.
94
+ * @summary Delete the commission agreement rule
95
+ * @param {string} code Unique identifier for the object.
96
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ deleteCommissionAgreementRule: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
101
+ // verify required parameter 'code' is not null or undefined
102
+ assertParamExists('deleteCommissionAgreementRule', 'code', code)
103
+ const localVarPath = `/commissionservice/v1/agreement-rules/{code}`
104
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
105
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
106
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
107
+ let baseOptions;
108
+ let baseAccessToken;
109
+ if (configuration) {
110
+ baseOptions = configuration.baseOptions;
111
+ baseAccessToken = configuration.accessToken;
112
+ }
113
+
114
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
115
+ const localVarHeaderParameter = {} as any;
116
+ const localVarQueryParameter = {} as any;
117
+
118
+ // authentication bearer required
119
+ // http bearer authentication required
120
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
121
+
122
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
123
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
124
+ }
125
+
126
+
127
+
128
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
129
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
130
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
131
+
132
+ return {
133
+ url: toPathString(localVarUrlObj),
134
+ options: localVarRequestOptions,
135
+ };
136
+ },
137
+ /**
138
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
139
+ * @summary Create the commission agreement rule evaluation
140
+ * @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ evaluateCommissionAgreementRule: async (evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
146
+ // verify required parameter 'evaluateCommissionAgreementRuleRequestDto' is not null or undefined
147
+ assertParamExists('evaluateCommissionAgreementRule', 'evaluateCommissionAgreementRuleRequestDto', evaluateCommissionAgreementRuleRequestDto)
148
+ const localVarPath = `/commissionservice/v1/agreement-rules/evaluate`;
149
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
150
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
+ let baseOptions;
152
+ let baseAccessToken;
153
+ if (configuration) {
154
+ baseOptions = configuration.baseOptions;
155
+ baseAccessToken = configuration.accessToken;
156
+ }
157
+
158
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
159
+ const localVarHeaderParameter = {} as any;
160
+ const localVarQueryParameter = {} as any;
161
+
162
+ // authentication bearer required
163
+ // http bearer authentication required
164
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
165
+
166
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
167
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
168
+ }
169
+
170
+
171
+
172
+ localVarHeaderParameter['Content-Type'] = 'application/json';
173
+
174
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
175
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
176
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
177
+ localVarRequestOptions.data = serializeDataIfNeeded(evaluateCommissionAgreementRuleRequestDto, localVarRequestOptions, configuration)
178
+
179
+ return {
180
+ url: toPathString(localVarUrlObj),
181
+ options: localVarRequestOptions,
182
+ };
183
+ },
184
+ /**
185
+ * This will get commission agreement rule.
186
+ * @summary Retrieve the commission agreement rule
187
+ * @param {string} code
188
+ * @param {string} expand
189
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ getCommissionAgreementRule: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
194
+ // verify required parameter 'code' is not null or undefined
195
+ assertParamExists('getCommissionAgreementRule', 'code', code)
196
+ // verify required parameter 'expand' is not null or undefined
197
+ assertParamExists('getCommissionAgreementRule', 'expand', expand)
198
+ const localVarPath = `/commissionservice/v1/agreement-rules/{code}`
199
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
200
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
201
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
202
+ let baseOptions;
203
+ let baseAccessToken;
204
+ if (configuration) {
205
+ baseOptions = configuration.baseOptions;
206
+ baseAccessToken = configuration.accessToken;
207
+ }
208
+
209
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
210
+ const localVarHeaderParameter = {} as any;
211
+ const localVarQueryParameter = {} as any;
212
+
213
+ // authentication bearer required
214
+ // http bearer authentication required
215
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
216
+
217
+ if (expand !== undefined) {
218
+ localVarQueryParameter['expand'] = expand;
219
+ }
220
+
221
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
222
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
223
+ }
224
+
225
+
226
+
227
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
228
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
229
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
230
+
231
+ return {
232
+ url: toPathString(localVarUrlObj),
233
+ options: localVarRequestOptions,
234
+ };
235
+ },
236
+ /**
237
+ * Retrieves a list of commission agreement rules.
238
+ * @summary List commission agreement rules
239
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
240
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
241
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
242
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
243
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
244
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
245
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
246
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
247
+ * @param {*} [options] Override http request option.
248
+ * @throws {RequiredError}
249
+ */
250
+ listCommissionAgreementRules: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
251
+ const localVarPath = `/commissionservice/v1/agreement-rules`;
252
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
253
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
254
+ let baseOptions;
255
+ let baseAccessToken;
256
+ if (configuration) {
257
+ baseOptions = configuration.baseOptions;
258
+ baseAccessToken = configuration.accessToken;
259
+ }
260
+
261
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
262
+ const localVarHeaderParameter = {} as any;
263
+ const localVarQueryParameter = {} as any;
264
+
265
+ // authentication bearer required
266
+ // http bearer authentication required
267
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
268
+
269
+ if (pageSize !== undefined) {
270
+ localVarQueryParameter['pageSize'] = pageSize;
271
+ }
272
+
273
+ if (pageToken !== undefined) {
274
+ localVarQueryParameter['pageToken'] = pageToken;
275
+ }
276
+
277
+ if (filter !== undefined) {
278
+ localVarQueryParameter['filter'] = filter;
279
+ }
280
+
281
+ if (search !== undefined) {
282
+ localVarQueryParameter['search'] = search;
283
+ }
284
+
285
+ if (order !== undefined) {
286
+ localVarQueryParameter['order'] = order;
287
+ }
288
+
289
+ if (expand !== undefined) {
290
+ localVarQueryParameter['expand'] = expand;
291
+ }
292
+
293
+ if (filters !== undefined) {
294
+ localVarQueryParameter['filters'] = filters;
295
+ }
296
+
297
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
298
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
299
+ }
300
+
301
+
302
+
303
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
304
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
305
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
306
+
307
+ return {
308
+ url: toPathString(localVarUrlObj),
309
+ options: localVarRequestOptions,
310
+ };
311
+ },
312
+ /**
313
+ * This will update commission agreement rule.
314
+ * @summary Update the commission agreement rule
315
+ * @param {string} code Unique identifier for the object.
316
+ * @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
317
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
318
+ * @param {*} [options] Override http request option.
319
+ * @throws {RequiredError}
320
+ */
321
+ updateCommissionAgreementRule: async (code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
322
+ // verify required parameter 'code' is not null or undefined
323
+ assertParamExists('updateCommissionAgreementRule', 'code', code)
324
+ // verify required parameter 'updateCommissionAgreementRuleRequestDto' is not null or undefined
325
+ assertParamExists('updateCommissionAgreementRule', 'updateCommissionAgreementRuleRequestDto', updateCommissionAgreementRuleRequestDto)
326
+ const localVarPath = `/commissionservice/v1/agreement-rules/{code}`
327
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
328
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
329
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
330
+ let baseOptions;
331
+ let baseAccessToken;
332
+ if (configuration) {
333
+ baseOptions = configuration.baseOptions;
334
+ baseAccessToken = configuration.accessToken;
335
+ }
336
+
337
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
338
+ const localVarHeaderParameter = {} as any;
339
+ const localVarQueryParameter = {} as any;
340
+
341
+ // authentication bearer required
342
+ // http bearer authentication required
343
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
344
+
345
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
346
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
347
+ }
348
+
349
+
350
+
351
+ localVarHeaderParameter['Content-Type'] = 'application/json';
352
+
353
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
354
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
355
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
356
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCommissionAgreementRuleRequestDto, localVarRequestOptions, configuration)
357
+
358
+ return {
359
+ url: toPathString(localVarUrlObj),
360
+ options: localVarRequestOptions,
361
+ };
362
+ },
363
+ }
364
+ };
365
+
366
+ /**
367
+ * CommissionAgreementRulesApi - functional programming interface
368
+ * @export
369
+ */
370
+ export const CommissionAgreementRulesApiFp = function(configuration?: Configuration) {
371
+ const localVarAxiosParamCreator = CommissionAgreementRulesApiAxiosParamCreator(configuration)
372
+ return {
373
+ /**
374
+ * This will create commission agreement rule.
375
+ * @summary Create the commission agreement rule
376
+ * @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
377
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ */
381
+ async createCommissionAgreementRule(createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementRuleResponseClass>> {
382
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createCommissionAgreementRule(createCommissionAgreementRuleRequestDto, authorization, options);
383
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
384
+ },
385
+ /**
386
+ * This will delete commission agreement rule.
387
+ * @summary Delete the commission agreement rule
388
+ * @param {string} code Unique identifier for the object.
389
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
390
+ * @param {*} [options] Override http request option.
391
+ * @throws {RequiredError}
392
+ */
393
+ async deleteCommissionAgreementRule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
394
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCommissionAgreementRule(code, authorization, options);
395
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
396
+ },
397
+ /**
398
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
399
+ * @summary Create the commission agreement rule evaluation
400
+ * @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
401
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
402
+ * @param {*} [options] Override http request option.
403
+ * @throws {RequiredError}
404
+ */
405
+ async evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EvaluateCommissionAgreementRuleResponseClass>> {
406
+ const localVarAxiosArgs = await localVarAxiosParamCreator.evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto, authorization, options);
407
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
408
+ },
409
+ /**
410
+ * This will get commission agreement rule.
411
+ * @summary Retrieve the commission agreement rule
412
+ * @param {string} code
413
+ * @param {string} expand
414
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
415
+ * @param {*} [options] Override http request option.
416
+ * @throws {RequiredError}
417
+ */
418
+ async getCommissionAgreementRule(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementRuleResponseClass>> {
419
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCommissionAgreementRule(code, expand, authorization, options);
420
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
421
+ },
422
+ /**
423
+ * Retrieves a list of commission agreement rules.
424
+ * @summary List commission agreement rules
425
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
426
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
427
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
428
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
429
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
430
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
431
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
432
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
433
+ * @param {*} [options] Override http request option.
434
+ * @throws {RequiredError}
435
+ */
436
+ async listCommissionAgreementRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementRulesResponseClass>> {
437
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementRules(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
438
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
439
+ },
440
+ /**
441
+ * This will update commission agreement rule.
442
+ * @summary Update the commission agreement rule
443
+ * @param {string} code Unique identifier for the object.
444
+ * @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
445
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
446
+ * @param {*} [options] Override http request option.
447
+ * @throws {RequiredError}
448
+ */
449
+ async updateCommissionAgreementRule(code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementRuleResponseClass>> {
450
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionAgreementRule(code, updateCommissionAgreementRuleRequestDto, authorization, options);
451
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
452
+ },
453
+ }
454
+ };
455
+
456
+ /**
457
+ * CommissionAgreementRulesApi - factory interface
458
+ * @export
459
+ */
460
+ export const CommissionAgreementRulesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
461
+ const localVarFp = CommissionAgreementRulesApiFp(configuration)
462
+ return {
463
+ /**
464
+ * This will create commission agreement rule.
465
+ * @summary Create the commission agreement rule
466
+ * @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
467
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
468
+ * @param {*} [options] Override http request option.
469
+ * @throws {RequiredError}
470
+ */
471
+ createCommissionAgreementRule(createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementRuleResponseClass> {
472
+ return localVarFp.createCommissionAgreementRule(createCommissionAgreementRuleRequestDto, authorization, options).then((request) => request(axios, basePath));
473
+ },
474
+ /**
475
+ * This will delete commission agreement rule.
476
+ * @summary Delete the commission agreement rule
477
+ * @param {string} code Unique identifier for the object.
478
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
479
+ * @param {*} [options] Override http request option.
480
+ * @throws {RequiredError}
481
+ */
482
+ deleteCommissionAgreementRule(code: string, authorization?: string, options?: any): AxiosPromise<void> {
483
+ return localVarFp.deleteCommissionAgreementRule(code, authorization, options).then((request) => request(axios, basePath));
484
+ },
485
+ /**
486
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
487
+ * @summary Create the commission agreement rule evaluation
488
+ * @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
489
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
490
+ * @param {*} [options] Override http request option.
491
+ * @throws {RequiredError}
492
+ */
493
+ evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<EvaluateCommissionAgreementRuleResponseClass> {
494
+ return localVarFp.evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto, authorization, options).then((request) => request(axios, basePath));
495
+ },
496
+ /**
497
+ * This will get commission agreement rule.
498
+ * @summary Retrieve the commission agreement rule
499
+ * @param {string} code
500
+ * @param {string} expand
501
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
502
+ * @param {*} [options] Override http request option.
503
+ * @throws {RequiredError}
504
+ */
505
+ getCommissionAgreementRule(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementRuleResponseClass> {
506
+ return localVarFp.getCommissionAgreementRule(code, expand, authorization, options).then((request) => request(axios, basePath));
507
+ },
508
+ /**
509
+ * Retrieves a list of commission agreement rules.
510
+ * @summary List commission agreement rules
511
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
512
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
513
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
514
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
515
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
516
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
517
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
518
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
519
+ * @param {*} [options] Override http request option.
520
+ * @throws {RequiredError}
521
+ */
522
+ listCommissionAgreementRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementRulesResponseClass> {
523
+ return localVarFp.listCommissionAgreementRules(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
524
+ },
525
+ /**
526
+ * This will update commission agreement rule.
527
+ * @summary Update the commission agreement rule
528
+ * @param {string} code Unique identifier for the object.
529
+ * @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
530
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
531
+ * @param {*} [options] Override http request option.
532
+ * @throws {RequiredError}
533
+ */
534
+ updateCommissionAgreementRule(code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementRuleResponseClass> {
535
+ return localVarFp.updateCommissionAgreementRule(code, updateCommissionAgreementRuleRequestDto, authorization, options).then((request) => request(axios, basePath));
536
+ },
537
+ };
538
+ };
539
+
540
+ /**
541
+ * Request parameters for createCommissionAgreementRule operation in CommissionAgreementRulesApi.
542
+ * @export
543
+ * @interface CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest
544
+ */
545
+ export interface CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest {
546
+ /**
547
+ *
548
+ * @type {CreateCommissionAgreementRuleRequestDto}
549
+ * @memberof CommissionAgreementRulesApiCreateCommissionAgreementRule
550
+ */
551
+ readonly createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto
552
+
553
+ /**
554
+ * Bearer Token: provided by the login endpoint under the name accessToken.
555
+ * @type {string}
556
+ * @memberof CommissionAgreementRulesApiCreateCommissionAgreementRule
557
+ */
558
+ readonly authorization?: string
559
+ }
560
+
561
+ /**
562
+ * Request parameters for deleteCommissionAgreementRule operation in CommissionAgreementRulesApi.
563
+ * @export
564
+ * @interface CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest
565
+ */
566
+ export interface CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest {
567
+ /**
568
+ * Unique identifier for the object.
569
+ * @type {string}
570
+ * @memberof CommissionAgreementRulesApiDeleteCommissionAgreementRule
571
+ */
572
+ readonly code: string
573
+
574
+ /**
575
+ * Bearer Token: provided by the login endpoint under the name accessToken.
576
+ * @type {string}
577
+ * @memberof CommissionAgreementRulesApiDeleteCommissionAgreementRule
578
+ */
579
+ readonly authorization?: string
580
+ }
581
+
582
+ /**
583
+ * Request parameters for evaluateCommissionAgreementRule operation in CommissionAgreementRulesApi.
584
+ * @export
585
+ * @interface CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest
586
+ */
587
+ export interface CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest {
588
+ /**
589
+ *
590
+ * @type {EvaluateCommissionAgreementRuleRequestDto}
591
+ * @memberof CommissionAgreementRulesApiEvaluateCommissionAgreementRule
592
+ */
593
+ readonly evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto
594
+
595
+ /**
596
+ * Bearer Token: provided by the login endpoint under the name accessToken.
597
+ * @type {string}
598
+ * @memberof CommissionAgreementRulesApiEvaluateCommissionAgreementRule
599
+ */
600
+ readonly authorization?: string
601
+ }
602
+
603
+ /**
604
+ * Request parameters for getCommissionAgreementRule operation in CommissionAgreementRulesApi.
605
+ * @export
606
+ * @interface CommissionAgreementRulesApiGetCommissionAgreementRuleRequest
607
+ */
608
+ export interface CommissionAgreementRulesApiGetCommissionAgreementRuleRequest {
609
+ /**
610
+ *
611
+ * @type {string}
612
+ * @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
613
+ */
614
+ readonly code: string
615
+
616
+ /**
617
+ *
618
+ * @type {string}
619
+ * @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
620
+ */
621
+ readonly expand: string
622
+
623
+ /**
624
+ * Bearer Token: provided by the login endpoint under the name accessToken.
625
+ * @type {string}
626
+ * @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
627
+ */
628
+ readonly authorization?: string
629
+ }
630
+
631
+ /**
632
+ * Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.
633
+ * @export
634
+ * @interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
635
+ */
636
+ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest {
637
+ /**
638
+ * Bearer Token: provided by the login endpoint under the name accessToken.
639
+ * @type {string}
640
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
641
+ */
642
+ readonly authorization?: string
643
+
644
+ /**
645
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
646
+ * @type {number}
647
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
648
+ */
649
+ readonly pageSize?: number
650
+
651
+ /**
652
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
653
+ * @type {string}
654
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
655
+ */
656
+ readonly pageToken?: string
657
+
658
+ /**
659
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
660
+ * @type {string}
661
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
662
+ */
663
+ readonly filter?: string
664
+
665
+ /**
666
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
667
+ * @type {string}
668
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
669
+ */
670
+ readonly search?: string
671
+
672
+ /**
673
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
674
+ * @type {string}
675
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
676
+ */
677
+ readonly order?: string
678
+
679
+ /**
680
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
681
+ * @type {string}
682
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
683
+ */
684
+ readonly expand?: string
685
+
686
+ /**
687
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
688
+ * @type {string}
689
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
690
+ */
691
+ readonly filters?: string
692
+ }
693
+
694
+ /**
695
+ * Request parameters for updateCommissionAgreementRule operation in CommissionAgreementRulesApi.
696
+ * @export
697
+ * @interface CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest
698
+ */
699
+ export interface CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest {
700
+ /**
701
+ * Unique identifier for the object.
702
+ * @type {string}
703
+ * @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
704
+ */
705
+ readonly code: string
706
+
707
+ /**
708
+ *
709
+ * @type {UpdateCommissionAgreementRuleRequestDto}
710
+ * @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
711
+ */
712
+ readonly updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto
713
+
714
+ /**
715
+ * Bearer Token: provided by the login endpoint under the name accessToken.
716
+ * @type {string}
717
+ * @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
718
+ */
719
+ readonly authorization?: string
720
+ }
721
+
722
+ /**
723
+ * CommissionAgreementRulesApi - object-oriented interface
724
+ * @export
725
+ * @class CommissionAgreementRulesApi
726
+ * @extends {BaseAPI}
727
+ */
728
+ export class CommissionAgreementRulesApi extends BaseAPI {
729
+ /**
730
+ * This will create commission agreement rule.
731
+ * @summary Create the commission agreement rule
732
+ * @param {CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest} requestParameters Request parameters.
733
+ * @param {*} [options] Override http request option.
734
+ * @throws {RequiredError}
735
+ * @memberof CommissionAgreementRulesApi
736
+ */
737
+ public createCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest, options?: AxiosRequestConfig) {
738
+ return CommissionAgreementRulesApiFp(this.configuration).createCommissionAgreementRule(requestParameters.createCommissionAgreementRuleRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
739
+ }
740
+
741
+ /**
742
+ * This will delete commission agreement rule.
743
+ * @summary Delete the commission agreement rule
744
+ * @param {CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest} requestParameters Request parameters.
745
+ * @param {*} [options] Override http request option.
746
+ * @throws {RequiredError}
747
+ * @memberof CommissionAgreementRulesApi
748
+ */
749
+ public deleteCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest, options?: AxiosRequestConfig) {
750
+ return CommissionAgreementRulesApiFp(this.configuration).deleteCommissionAgreementRule(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
751
+ }
752
+
753
+ /**
754
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
755
+ * @summary Create the commission agreement rule evaluation
756
+ * @param {CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest} requestParameters Request parameters.
757
+ * @param {*} [options] Override http request option.
758
+ * @throws {RequiredError}
759
+ * @memberof CommissionAgreementRulesApi
760
+ */
761
+ public evaluateCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest, options?: AxiosRequestConfig) {
762
+ return CommissionAgreementRulesApiFp(this.configuration).evaluateCommissionAgreementRule(requestParameters.evaluateCommissionAgreementRuleRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
763
+ }
764
+
765
+ /**
766
+ * This will get commission agreement rule.
767
+ * @summary Retrieve the commission agreement rule
768
+ * @param {CommissionAgreementRulesApiGetCommissionAgreementRuleRequest} requestParameters Request parameters.
769
+ * @param {*} [options] Override http request option.
770
+ * @throws {RequiredError}
771
+ * @memberof CommissionAgreementRulesApi
772
+ */
773
+ public getCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiGetCommissionAgreementRuleRequest, options?: AxiosRequestConfig) {
774
+ return CommissionAgreementRulesApiFp(this.configuration).getCommissionAgreementRule(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
775
+ }
776
+
777
+ /**
778
+ * Retrieves a list of commission agreement rules.
779
+ * @summary List commission agreement rules
780
+ * @param {CommissionAgreementRulesApiListCommissionAgreementRulesRequest} requestParameters Request parameters.
781
+ * @param {*} [options] Override http request option.
782
+ * @throws {RequiredError}
783
+ * @memberof CommissionAgreementRulesApi
784
+ */
785
+ public listCommissionAgreementRules(requestParameters: CommissionAgreementRulesApiListCommissionAgreementRulesRequest = {}, options?: AxiosRequestConfig) {
786
+ return CommissionAgreementRulesApiFp(this.configuration).listCommissionAgreementRules(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
787
+ }
788
+
789
+ /**
790
+ * This will update commission agreement rule.
791
+ * @summary Update the commission agreement rule
792
+ * @param {CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest} requestParameters Request parameters.
793
+ * @param {*} [options] Override http request option.
794
+ * @throws {RequiredError}
795
+ * @memberof CommissionAgreementRulesApi
796
+ */
797
+ public updateCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest, options?: AxiosRequestConfig) {
798
+ return CommissionAgreementRulesApiFp(this.configuration).updateCommissionAgreementRule(requestParameters.code, requestParameters.updateCommissionAgreementRuleRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
799
+ }
800
+ }