@cosmotech/aip-client 0.2.0-dev4 → 0.2.0-dev6

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 (280) hide show
  1. package/README.md +12 -8
  2. package/api/default-api.ts +1 -1
  3. package/api/impact-api.ts +1 -1
  4. package/api/investment-api.ts +182 -94
  5. package/api/metric-api.ts +1 -1
  6. package/api/metric-costs-api.ts +1 -1
  7. package/api/metric-costs-per-year-api.ts +1 -1
  8. package/api/objective-api.ts +1 -1
  9. package/api/objective-weight-api.ts +1 -1
  10. package/api/objective-weights-api.ts +1 -1
  11. package/api/option-api.ts +89 -1
  12. package/api/{favored-option-api.ts → preferred-option-api.ts} +40 -40
  13. package/api/value-framework-api.ts +1 -1
  14. package/api/value-framework-costs-api.ts +1 -1
  15. package/api/value-framework-weights-api.ts +1 -1
  16. package/api.ts +2 -2
  17. package/base.ts +1 -1
  18. package/common.ts +1 -1
  19. package/configuration.ts +1 -1
  20. package/dist/api/default-api.d.ts +1 -1
  21. package/dist/api/default-api.js +1 -1
  22. package/dist/api/impact-api.d.ts +1 -1
  23. package/dist/api/impact-api.js +1 -1
  24. package/dist/api/investment-api.d.ts +84 -43
  25. package/dist/api/investment-api.js +170 -87
  26. package/dist/api/metric-api.d.ts +1 -1
  27. package/dist/api/metric-api.js +1 -1
  28. package/dist/api/metric-costs-api.d.ts +1 -1
  29. package/dist/api/metric-costs-api.js +1 -1
  30. package/dist/api/metric-costs-per-year-api.d.ts +1 -1
  31. package/dist/api/metric-costs-per-year-api.js +1 -1
  32. package/dist/api/objective-api.d.ts +1 -1
  33. package/dist/api/objective-api.js +1 -1
  34. package/dist/api/objective-weight-api.d.ts +1 -1
  35. package/dist/api/objective-weight-api.js +1 -1
  36. package/dist/api/objective-weights-api.d.ts +1 -1
  37. package/dist/api/objective-weights-api.js +1 -1
  38. package/dist/api/option-api.d.ts +42 -1
  39. package/dist/api/option-api.js +84 -1
  40. package/dist/api/{favored-option-api.d.ts → preferred-option-api.d.ts} +23 -23
  41. package/dist/api/{favored-option-api.js → preferred-option-api.js} +43 -43
  42. package/dist/api/value-framework-api.d.ts +1 -1
  43. package/dist/api/value-framework-api.js +1 -1
  44. package/dist/api/value-framework-costs-api.d.ts +1 -1
  45. package/dist/api/value-framework-costs-api.js +1 -1
  46. package/dist/api/value-framework-weights-api.d.ts +1 -1
  47. package/dist/api/value-framework-weights-api.js +1 -1
  48. package/dist/api.d.ts +2 -2
  49. package/dist/api.js +2 -2
  50. package/dist/base.d.ts +1 -1
  51. package/dist/base.js +1 -1
  52. package/dist/common.d.ts +1 -1
  53. package/dist/common.js +1 -1
  54. package/dist/configuration.d.ts +1 -1
  55. package/dist/configuration.js +1 -1
  56. package/dist/esm/api/default-api.d.ts +1 -1
  57. package/dist/esm/api/default-api.js +1 -1
  58. package/dist/esm/api/impact-api.d.ts +1 -1
  59. package/dist/esm/api/impact-api.js +1 -1
  60. package/dist/esm/api/investment-api.d.ts +84 -43
  61. package/dist/esm/api/investment-api.js +170 -87
  62. package/dist/esm/api/metric-api.d.ts +1 -1
  63. package/dist/esm/api/metric-api.js +1 -1
  64. package/dist/esm/api/metric-costs-api.d.ts +1 -1
  65. package/dist/esm/api/metric-costs-api.js +1 -1
  66. package/dist/esm/api/metric-costs-per-year-api.d.ts +1 -1
  67. package/dist/esm/api/metric-costs-per-year-api.js +1 -1
  68. package/dist/esm/api/objective-api.d.ts +1 -1
  69. package/dist/esm/api/objective-api.js +1 -1
  70. package/dist/esm/api/objective-weight-api.d.ts +1 -1
  71. package/dist/esm/api/objective-weight-api.js +1 -1
  72. package/dist/esm/api/objective-weights-api.d.ts +1 -1
  73. package/dist/esm/api/objective-weights-api.js +1 -1
  74. package/dist/esm/api/option-api.d.ts +42 -1
  75. package/dist/esm/api/option-api.js +84 -1
  76. package/dist/esm/api/{favored-option-api.d.ts → preferred-option-api.d.ts} +23 -23
  77. package/dist/esm/api/{favored-option-api.js → preferred-option-api.js} +38 -38
  78. package/dist/esm/api/value-framework-api.d.ts +1 -1
  79. package/dist/esm/api/value-framework-api.js +1 -1
  80. package/dist/esm/api/value-framework-costs-api.d.ts +1 -1
  81. package/dist/esm/api/value-framework-costs-api.js +1 -1
  82. package/dist/esm/api/value-framework-weights-api.d.ts +1 -1
  83. package/dist/esm/api/value-framework-weights-api.js +1 -1
  84. package/dist/esm/api.d.ts +2 -2
  85. package/dist/esm/api.js +2 -2
  86. package/dist/esm/base.d.ts +1 -1
  87. package/dist/esm/base.js +1 -1
  88. package/dist/esm/common.d.ts +1 -1
  89. package/dist/esm/common.js +1 -1
  90. package/dist/esm/configuration.d.ts +1 -1
  91. package/dist/esm/configuration.js +1 -1
  92. package/dist/esm/index.d.ts +1 -1
  93. package/dist/esm/index.js +1 -1
  94. package/dist/esm/models/evolution-type.d.ts +1 -1
  95. package/dist/esm/models/evolution-type.js +1 -1
  96. package/dist/esm/models/httpvalidation-error.d.ts +1 -1
  97. package/dist/esm/models/httpvalidation-error.js +1 -1
  98. package/dist/esm/models/impact-apiresponse.d.ts +1 -1
  99. package/dist/esm/models/impact-apiresponse.js +1 -1
  100. package/dist/esm/models/impact-create.d.ts +1 -1
  101. package/dist/esm/models/impact-create.js +1 -1
  102. package/dist/esm/models/impact-update.d.ts +1 -1
  103. package/dist/esm/models/impact-update.js +1 -1
  104. package/dist/esm/models/index.d.ts +4 -2
  105. package/dist/esm/models/index.js +4 -2
  106. package/dist/esm/models/investment-create.d.ts +1 -1
  107. package/dist/esm/models/investment-create.js +1 -1
  108. package/dist/esm/models/investment-response.d.ts +1 -1
  109. package/dist/esm/models/investment-response.js +1 -1
  110. package/dist/esm/models/investment-update.d.ts +1 -1
  111. package/dist/esm/models/investment-update.js +1 -1
  112. package/dist/esm/models/location-inner.d.ts +1 -1
  113. package/dist/esm/models/location-inner.js +1 -1
  114. package/dist/esm/models/measurement-type.d.ts +1 -1
  115. package/dist/esm/models/measurement-type.js +1 -1
  116. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
  117. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  118. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
  119. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  120. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
  121. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  122. package/dist/esm/models/metric-create.d.ts +1 -1
  123. package/dist/esm/models/metric-create.js +1 -1
  124. package/dist/esm/models/metric-response.d.ts +1 -1
  125. package/dist/esm/models/metric-response.js +1 -1
  126. package/dist/esm/models/metric-type.d.ts +1 -1
  127. package/dist/esm/models/metric-type.js +1 -1
  128. package/dist/esm/models/metric-update.d.ts +1 -1
  129. package/dist/esm/models/metric-update.js +1 -1
  130. package/dist/esm/models/objective-create.d.ts +1 -1
  131. package/dist/esm/models/objective-create.js +1 -1
  132. package/dist/esm/models/objective-response.d.ts +1 -1
  133. package/dist/esm/models/objective-response.js +1 -1
  134. package/dist/esm/models/objective-update.d.ts +1 -1
  135. package/dist/esm/models/objective-update.js +1 -1
  136. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  137. package/dist/esm/models/objective-weight-create.js +1 -1
  138. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  139. package/dist/esm/models/objective-weight-response.js +1 -1
  140. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  141. package/dist/esm/models/objective-weight-update.js +1 -1
  142. package/dist/esm/models/option-chart-kpi.d.ts +29 -0
  143. package/dist/esm/models/{favored-option-request.js → option-chart-kpi.js} +1 -1
  144. package/dist/esm/models/option-chart-kpis-yearly.d.ts +29 -0
  145. package/dist/esm/models/{favored-option-response.js → option-chart-kpis-yearly.js} +1 -1
  146. package/dist/esm/models/option-create.d.ts +2 -2
  147. package/dist/esm/models/option-create.js +1 -1
  148. package/dist/esm/models/option-response.d.ts +1 -1
  149. package/dist/esm/models/option-response.js +1 -1
  150. package/dist/esm/models/option-update.d.ts +1 -1
  151. package/dist/esm/models/option-update.js +1 -1
  152. package/dist/esm/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  153. package/dist/esm/models/preferred-option-request.js +14 -0
  154. package/dist/esm/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  155. package/dist/esm/models/preferred-option-response.js +14 -0
  156. package/dist/esm/models/validation-error.d.ts +1 -1
  157. package/dist/esm/models/validation-error.js +1 -1
  158. package/dist/esm/models/value-framework-create.d.ts +1 -1
  159. package/dist/esm/models/value-framework-create.js +1 -1
  160. package/dist/esm/models/value-framework-response.d.ts +1 -1
  161. package/dist/esm/models/value-framework-response.js +1 -1
  162. package/dist/esm/models/value-framework-update.d.ts +1 -1
  163. package/dist/esm/models/value-framework-update.js +1 -1
  164. package/dist/index.d.ts +1 -1
  165. package/dist/index.js +1 -1
  166. package/dist/models/evolution-type.d.ts +1 -1
  167. package/dist/models/evolution-type.js +1 -1
  168. package/dist/models/httpvalidation-error.d.ts +1 -1
  169. package/dist/models/httpvalidation-error.js +1 -1
  170. package/dist/models/impact-apiresponse.d.ts +1 -1
  171. package/dist/models/impact-apiresponse.js +1 -1
  172. package/dist/models/impact-create.d.ts +1 -1
  173. package/dist/models/impact-create.js +1 -1
  174. package/dist/models/impact-update.d.ts +1 -1
  175. package/dist/models/impact-update.js +1 -1
  176. package/dist/models/index.d.ts +4 -2
  177. package/dist/models/index.js +4 -2
  178. package/dist/models/investment-create.d.ts +1 -1
  179. package/dist/models/investment-create.js +1 -1
  180. package/dist/models/investment-response.d.ts +1 -1
  181. package/dist/models/investment-response.js +1 -1
  182. package/dist/models/investment-update.d.ts +1 -1
  183. package/dist/models/investment-update.js +1 -1
  184. package/dist/models/location-inner.d.ts +1 -1
  185. package/dist/models/location-inner.js +1 -1
  186. package/dist/models/measurement-type.d.ts +1 -1
  187. package/dist/models/measurement-type.js +1 -1
  188. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  189. package/dist/models/metric-costs-per-year-create.js +1 -1
  190. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  191. package/dist/models/metric-costs-per-year-response.js +1 -1
  192. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  193. package/dist/models/metric-costs-per-year-update.js +1 -1
  194. package/dist/models/metric-create.d.ts +1 -1
  195. package/dist/models/metric-create.js +1 -1
  196. package/dist/models/metric-response.d.ts +1 -1
  197. package/dist/models/metric-response.js +1 -1
  198. package/dist/models/metric-type.d.ts +1 -1
  199. package/dist/models/metric-type.js +1 -1
  200. package/dist/models/metric-update.d.ts +1 -1
  201. package/dist/models/metric-update.js +1 -1
  202. package/dist/models/objective-create.d.ts +1 -1
  203. package/dist/models/objective-create.js +1 -1
  204. package/dist/models/objective-response.d.ts +1 -1
  205. package/dist/models/objective-response.js +1 -1
  206. package/dist/models/objective-update.d.ts +1 -1
  207. package/dist/models/objective-update.js +1 -1
  208. package/dist/models/objective-weight-create.d.ts +1 -1
  209. package/dist/models/objective-weight-create.js +1 -1
  210. package/dist/models/objective-weight-response.d.ts +1 -1
  211. package/dist/models/objective-weight-response.js +1 -1
  212. package/dist/models/objective-weight-update.d.ts +1 -1
  213. package/dist/models/objective-weight-update.js +1 -1
  214. package/dist/models/option-chart-kpi.d.ts +29 -0
  215. package/dist/models/{favored-option-request.js → option-chart-kpi.js} +1 -1
  216. package/dist/models/option-chart-kpis-yearly.d.ts +29 -0
  217. package/dist/models/{favored-option-response.js → option-chart-kpis-yearly.js} +1 -1
  218. package/dist/models/option-create.d.ts +2 -2
  219. package/dist/models/option-create.js +1 -1
  220. package/dist/models/option-response.d.ts +1 -1
  221. package/dist/models/option-response.js +1 -1
  222. package/dist/models/option-update.d.ts +1 -1
  223. package/dist/models/option-update.js +1 -1
  224. package/dist/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  225. package/dist/models/preferred-option-request.js +15 -0
  226. package/dist/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  227. package/dist/models/preferred-option-response.js +15 -0
  228. package/dist/models/validation-error.d.ts +1 -1
  229. package/dist/models/validation-error.js +1 -1
  230. package/dist/models/value-framework-create.d.ts +1 -1
  231. package/dist/models/value-framework-create.js +1 -1
  232. package/dist/models/value-framework-response.d.ts +1 -1
  233. package/dist/models/value-framework-response.js +1 -1
  234. package/dist/models/value-framework-update.d.ts +1 -1
  235. package/dist/models/value-framework-update.js +1 -1
  236. package/docs/InvestmentApi.md +122 -63
  237. package/docs/OptionApi.md +59 -0
  238. package/docs/OptionChartKPI.md +27 -0
  239. package/docs/OptionChartKPIsYearly.md +25 -0
  240. package/docs/OptionCreate.md +1 -1
  241. package/docs/{FavoredOptionApi.md → PreferredOptionApi.md} +19 -19
  242. package/docs/{FavoredOptionRequest.md → PreferredOptionRequest.md} +3 -3
  243. package/docs/{FavoredOptionResponse.md → PreferredOptionResponse.md} +4 -4
  244. package/index.ts +1 -1
  245. package/models/evolution-type.ts +1 -1
  246. package/models/httpvalidation-error.ts +1 -1
  247. package/models/impact-apiresponse.ts +1 -1
  248. package/models/impact-create.ts +1 -1
  249. package/models/impact-update.ts +1 -1
  250. package/models/index.ts +4 -2
  251. package/models/investment-create.ts +1 -1
  252. package/models/investment-response.ts +1 -1
  253. package/models/investment-update.ts +1 -1
  254. package/models/location-inner.ts +1 -1
  255. package/models/measurement-type.ts +1 -1
  256. package/models/metric-costs-per-year-create.ts +1 -1
  257. package/models/metric-costs-per-year-response.ts +1 -1
  258. package/models/metric-costs-per-year-update.ts +1 -1
  259. package/models/metric-create.ts +1 -1
  260. package/models/metric-response.ts +1 -1
  261. package/models/metric-type.ts +1 -1
  262. package/models/metric-update.ts +1 -1
  263. package/models/objective-create.ts +1 -1
  264. package/models/objective-response.ts +1 -1
  265. package/models/objective-update.ts +1 -1
  266. package/models/objective-weight-create.ts +1 -1
  267. package/models/objective-weight-response.ts +1 -1
  268. package/models/objective-weight-update.ts +1 -1
  269. package/models/option-chart-kpi.ts +35 -0
  270. package/models/option-chart-kpis-yearly.ts +37 -0
  271. package/models/option-create.ts +2 -2
  272. package/models/option-response.ts +1 -1
  273. package/models/option-update.ts +1 -1
  274. package/models/{favored-option-request.ts → preferred-option-request.ts} +2 -2
  275. package/models/{favored-option-response.ts → preferred-option-response.ts} +3 -3
  276. package/models/validation-error.ts +1 -1
  277. package/models/value-framework-create.ts +1 -1
  278. package/models/value-framework-response.ts +1 -1
  279. package/models/value-framework-update.ts +1 -1
  280. package/package.json +1 -1
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -219,39 +219,6 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
219
219
  options: localVarRequestOptions,
220
220
  };
221
221
  }),
222
- /**
223
- * Get the preferred option for an investment.
224
- * @summary Get the preferred option for an investment
225
- * @param {string} investmentId UUID of the investment
226
- * @param {*} [options] Override http request option.
227
- * @throws {RequiredError}
228
- */
229
- getFavoredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
230
- // verify required parameter 'investmentId' is not null or undefined
231
- assertParamExists('getFavoredOption', 'investmentId', investmentId);
232
- const localVarPath = `/investment/{investment_id}/favored_option`
233
- .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
234
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
235
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
236
- let baseOptions;
237
- if (configuration) {
238
- baseOptions = configuration.baseOptions;
239
- }
240
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
241
- const localVarHeaderParameter = {};
242
- const localVarQueryParameter = {};
243
- // authentication OAuth2AuthorizationCodeBearer required
244
- // oauth required
245
- yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
246
- localVarHeaderParameter['Accept'] = 'application/json';
247
- setSearchParams(localVarUrlObj, localVarQueryParameter);
248
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
249
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
250
- return {
251
- url: toPathString(localVarUrlObj),
252
- options: localVarRequestOptions,
253
- };
254
- }),
255
222
  /**
256
223
  * Retrieve a specific impact for the option.
257
224
  * @summary Get an impact for this option
@@ -445,6 +412,47 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
445
412
  options: localVarRequestOptions,
446
413
  };
447
414
  }),
415
+ /**
416
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
417
+ * @summary Get the kpis for a given option inside a value framework
418
+ * @param {string} investmentId UUID of the investment
419
+ * @param {string} optionId UUID of the option
420
+ * @param {string} valueFrameworkId UUID of the value framework
421
+ * @param {*} [options] Override http request option.
422
+ * @throws {RequiredError}
423
+ */
424
+ getOptionKpis: (investmentId_1, optionId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, optionId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, optionId, valueFrameworkId, options = {}) {
425
+ // verify required parameter 'investmentId' is not null or undefined
426
+ assertParamExists('getOptionKpis', 'investmentId', investmentId);
427
+ // verify required parameter 'optionId' is not null or undefined
428
+ assertParamExists('getOptionKpis', 'optionId', optionId);
429
+ // verify required parameter 'valueFrameworkId' is not null or undefined
430
+ assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId);
431
+ const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
432
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
433
+ .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
434
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
435
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
436
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
437
+ let baseOptions;
438
+ if (configuration) {
439
+ baseOptions = configuration.baseOptions;
440
+ }
441
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
442
+ const localVarHeaderParameter = {};
443
+ const localVarQueryParameter = {};
444
+ // authentication OAuth2AuthorizationCodeBearer required
445
+ // oauth required
446
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
447
+ localVarHeaderParameter['Accept'] = 'application/json';
448
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
449
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
450
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
451
+ return {
452
+ url: toPathString(localVarUrlObj),
453
+ options: localVarRequestOptions,
454
+ };
455
+ }),
448
456
  /**
449
457
  * Retrieve a paginated list of all options for a specific investment.
450
458
  * @summary List options for this investment
@@ -486,6 +494,39 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
486
494
  options: localVarRequestOptions,
487
495
  };
488
496
  }),
497
+ /**
498
+ * Get the preferred option for an investment.
499
+ * @summary Get the preferred option for an investment
500
+ * @param {string} investmentId UUID of the investment
501
+ * @param {*} [options] Override http request option.
502
+ * @throws {RequiredError}
503
+ */
504
+ getPreferredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
505
+ // verify required parameter 'investmentId' is not null or undefined
506
+ assertParamExists('getPreferredOption', 'investmentId', investmentId);
507
+ const localVarPath = `/investment/{investment_id}/preferred_option`
508
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
509
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
510
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
511
+ let baseOptions;
512
+ if (configuration) {
513
+ baseOptions = configuration.baseOptions;
514
+ }
515
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
516
+ const localVarHeaderParameter = {};
517
+ const localVarQueryParameter = {};
518
+ // authentication OAuth2AuthorizationCodeBearer required
519
+ // oauth required
520
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
521
+ localVarHeaderParameter['Accept'] = 'application/json';
522
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
523
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
524
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
525
+ return {
526
+ url: toPathString(localVarUrlObj),
527
+ options: localVarRequestOptions,
528
+ };
529
+ }),
489
530
  /**
490
531
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
491
532
  * @summary Partially update an impact for this option
@@ -650,16 +691,16 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
650
691
  * Set the preferred option for an investment.
651
692
  * @summary Set the preferred option for an investment
652
693
  * @param {string} investmentId UUID of the investment
653
- * @param {FavoredOptionRequest} favoredOptionRequest
694
+ * @param {PreferredOptionRequest} preferredOptionRequest
654
695
  * @param {*} [options] Override http request option.
655
696
  * @throws {RequiredError}
656
697
  */
657
- setFavoredOption: (investmentId_1, favoredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, favoredOptionRequest_1, ...args_1], void 0, function* (investmentId, favoredOptionRequest, options = {}) {
698
+ setPreferredOption: (investmentId_1, preferredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, preferredOptionRequest_1, ...args_1], void 0, function* (investmentId, preferredOptionRequest, options = {}) {
658
699
  // verify required parameter 'investmentId' is not null or undefined
659
- assertParamExists('setFavoredOption', 'investmentId', investmentId);
660
- // verify required parameter 'favoredOptionRequest' is not null or undefined
661
- assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest);
662
- const localVarPath = `/investment/{investment_id}/favored_option`
700
+ assertParamExists('setPreferredOption', 'investmentId', investmentId);
701
+ // verify required parameter 'preferredOptionRequest' is not null or undefined
702
+ assertParamExists('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest);
703
+ const localVarPath = `/investment/{investment_id}/preferred_option`
663
704
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
664
705
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
665
706
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -678,7 +719,7 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
678
719
  setSearchParams(localVarUrlObj, localVarQueryParameter);
679
720
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
680
721
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
681
- localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration);
722
+ localVarRequestOptions.data = serializeDataIfNeeded(preferredOptionRequest, localVarRequestOptions, configuration);
682
723
  return {
683
724
  url: toPathString(localVarUrlObj),
684
725
  options: localVarRequestOptions,
@@ -778,22 +819,6 @@ export const InvestmentApiFp = function (configuration) {
778
819
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
779
820
  });
780
821
  },
781
- /**
782
- * Get the preferred option for an investment.
783
- * @summary Get the preferred option for an investment
784
- * @param {string} investmentId UUID of the investment
785
- * @param {*} [options] Override http request option.
786
- * @throws {RequiredError}
787
- */
788
- getFavoredOption(investmentId, options) {
789
- return __awaiter(this, void 0, void 0, function* () {
790
- var _a, _b, _c;
791
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getFavoredOption(investmentId, options);
792
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
793
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.getFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
794
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
795
- });
796
- },
797
822
  /**
798
823
  * Retrieve a specific impact for the option.
799
824
  * @summary Get an impact for this option
@@ -881,6 +906,24 @@ export const InvestmentApiFp = function (configuration) {
881
906
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
882
907
  });
883
908
  },
909
+ /**
910
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
911
+ * @summary Get the kpis for a given option inside a value framework
912
+ * @param {string} investmentId UUID of the investment
913
+ * @param {string} optionId UUID of the option
914
+ * @param {string} valueFrameworkId UUID of the value framework
915
+ * @param {*} [options] Override http request option.
916
+ * @throws {RequiredError}
917
+ */
918
+ getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
919
+ return __awaiter(this, void 0, void 0, function* () {
920
+ var _a, _b, _c;
921
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
922
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
923
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.getOptionKpis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
924
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
925
+ });
926
+ },
884
927
  /**
885
928
  * Retrieve a paginated list of all options for a specific investment.
886
929
  * @summary List options for this investment
@@ -899,6 +942,22 @@ export const InvestmentApiFp = function (configuration) {
899
942
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
900
943
  });
901
944
  },
945
+ /**
946
+ * Get the preferred option for an investment.
947
+ * @summary Get the preferred option for an investment
948
+ * @param {string} investmentId UUID of the investment
949
+ * @param {*} [options] Override http request option.
950
+ * @throws {RequiredError}
951
+ */
952
+ getPreferredOption(investmentId, options) {
953
+ return __awaiter(this, void 0, void 0, function* () {
954
+ var _a, _b, _c;
955
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPreferredOption(investmentId, options);
956
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
957
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.getPreferredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
958
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
959
+ });
960
+ },
902
961
  /**
903
962
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
904
963
  * @summary Partially update an impact for this option
@@ -973,16 +1032,16 @@ export const InvestmentApiFp = function (configuration) {
973
1032
  * Set the preferred option for an investment.
974
1033
  * @summary Set the preferred option for an investment
975
1034
  * @param {string} investmentId UUID of the investment
976
- * @param {FavoredOptionRequest} favoredOptionRequest
1035
+ * @param {PreferredOptionRequest} preferredOptionRequest
977
1036
  * @param {*} [options] Override http request option.
978
1037
  * @throws {RequiredError}
979
1038
  */
980
- setFavoredOption(investmentId, favoredOptionRequest, options) {
1039
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
981
1040
  return __awaiter(this, void 0, void 0, function* () {
982
1041
  var _a, _b, _c;
983
- const localVarAxiosArgs = yield localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
1042
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
984
1043
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
985
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.setFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1044
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.setPreferredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
986
1045
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
987
1046
  });
988
1047
  },
@@ -1050,16 +1109,6 @@ export const InvestmentApiFactory = function (configuration, basePath, axios) {
1050
1109
  deleteOptionForInvestment(optionId, investmentId, options) {
1051
1110
  return localVarFp.deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1052
1111
  },
1053
- /**
1054
- * Get the preferred option for an investment.
1055
- * @summary Get the preferred option for an investment
1056
- * @param {string} investmentId UUID of the investment
1057
- * @param {*} [options] Override http request option.
1058
- * @throws {RequiredError}
1059
- */
1060
- getFavoredOption(investmentId, options) {
1061
- return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
1062
- },
1063
1112
  /**
1064
1113
  * Retrieve a specific impact for the option.
1065
1114
  * @summary Get an impact for this option
@@ -1117,6 +1166,18 @@ export const InvestmentApiFactory = function (configuration, basePath, axios) {
1117
1166
  getOptionForInvestment(optionId, investmentId, options) {
1118
1167
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1119
1168
  },
1169
+ /**
1170
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1171
+ * @summary Get the kpis for a given option inside a value framework
1172
+ * @param {string} investmentId UUID of the investment
1173
+ * @param {string} optionId UUID of the option
1174
+ * @param {string} valueFrameworkId UUID of the value framework
1175
+ * @param {*} [options] Override http request option.
1176
+ * @throws {RequiredError}
1177
+ */
1178
+ getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
1179
+ return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
1180
+ },
1120
1181
  /**
1121
1182
  * Retrieve a paginated list of all options for a specific investment.
1122
1183
  * @summary List options for this investment
@@ -1129,6 +1190,16 @@ export const InvestmentApiFactory = function (configuration, basePath, axios) {
1129
1190
  getOptionsForInvestment(investmentId, offset, limit, options) {
1130
1191
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
1131
1192
  },
1193
+ /**
1194
+ * Get the preferred option for an investment.
1195
+ * @summary Get the preferred option for an investment
1196
+ * @param {string} investmentId UUID of the investment
1197
+ * @param {*} [options] Override http request option.
1198
+ * @throws {RequiredError}
1199
+ */
1200
+ getPreferredOption(investmentId, options) {
1201
+ return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
1202
+ },
1132
1203
  /**
1133
1204
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1134
1205
  * @summary Partially update an impact for this option
@@ -1179,12 +1250,12 @@ export const InvestmentApiFactory = function (configuration, basePath, axios) {
1179
1250
  * Set the preferred option for an investment.
1180
1251
  * @summary Set the preferred option for an investment
1181
1252
  * @param {string} investmentId UUID of the investment
1182
- * @param {FavoredOptionRequest} favoredOptionRequest
1253
+ * @param {PreferredOptionRequest} preferredOptionRequest
1183
1254
  * @param {*} [options] Override http request option.
1184
1255
  * @throws {RequiredError}
1185
1256
  */
1186
- setFavoredOption(investmentId, favoredOptionRequest, options) {
1187
- return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
1257
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
1258
+ return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
1188
1259
  },
1189
1260
  };
1190
1261
  };
@@ -1248,16 +1319,6 @@ export class InvestmentApi extends BaseAPI {
1248
1319
  deleteOptionForInvestment(optionId, investmentId, options) {
1249
1320
  return InvestmentApiFp(this.configuration).deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1250
1321
  }
1251
- /**
1252
- * Get the preferred option for an investment.
1253
- * @summary Get the preferred option for an investment
1254
- * @param {string} investmentId UUID of the investment
1255
- * @param {*} [options] Override http request option.
1256
- * @throws {RequiredError}
1257
- */
1258
- getFavoredOption(investmentId, options) {
1259
- return InvestmentApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1260
- }
1261
1322
  /**
1262
1323
  * Retrieve a specific impact for the option.
1263
1324
  * @summary Get an impact for this option
@@ -1315,6 +1376,18 @@ export class InvestmentApi extends BaseAPI {
1315
1376
  getOptionForInvestment(optionId, investmentId, options) {
1316
1377
  return InvestmentApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1317
1378
  }
1379
+ /**
1380
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1381
+ * @summary Get the kpis for a given option inside a value framework
1382
+ * @param {string} investmentId UUID of the investment
1383
+ * @param {string} optionId UUID of the option
1384
+ * @param {string} valueFrameworkId UUID of the value framework
1385
+ * @param {*} [options] Override http request option.
1386
+ * @throws {RequiredError}
1387
+ */
1388
+ getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
1389
+ return InvestmentApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1390
+ }
1318
1391
  /**
1319
1392
  * Retrieve a paginated list of all options for a specific investment.
1320
1393
  * @summary List options for this investment
@@ -1327,6 +1400,16 @@ export class InvestmentApi extends BaseAPI {
1327
1400
  getOptionsForInvestment(investmentId, offset, limit, options) {
1328
1401
  return InvestmentApiFp(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1329
1402
  }
1403
+ /**
1404
+ * Get the preferred option for an investment.
1405
+ * @summary Get the preferred option for an investment
1406
+ * @param {string} investmentId UUID of the investment
1407
+ * @param {*} [options] Override http request option.
1408
+ * @throws {RequiredError}
1409
+ */
1410
+ getPreferredOption(investmentId, options) {
1411
+ return InvestmentApiFp(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1412
+ }
1330
1413
  /**
1331
1414
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1332
1415
  * @summary Partially update an impact for this option
@@ -1377,11 +1460,11 @@ export class InvestmentApi extends BaseAPI {
1377
1460
  * Set the preferred option for an investment.
1378
1461
  * @summary Set the preferred option for an investment
1379
1462
  * @param {string} investmentId UUID of the investment
1380
- * @param {FavoredOptionRequest} favoredOptionRequest
1463
+ * @param {PreferredOptionRequest} preferredOptionRequest
1381
1464
  * @param {*} [options] Override http request option.
1382
1465
  * @throws {RequiredError}
1383
1466
  */
1384
- setFavoredOption(investmentId, favoredOptionRequest, options) {
1385
- return InvestmentApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1467
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
1468
+ return InvestmentApiFp(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1386
1469
  }
1387
1470
  }
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { ImpactAPIResponse } from '../models';
16
16
  import type { ImpactCreate } from '../models';
17
17
  import type { ImpactUpdate } from '../models';
18
+ import type { OptionChartKPIsYearly } from '../models';
18
19
  import type { OptionCreate } from '../models';
19
20
  import type { OptionResponse } from '../models';
20
21
  import type { OptionUpdate } from '../models';
@@ -90,6 +91,16 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
90
91
  * @throws {RequiredError}
91
92
  */
92
93
  getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
94
+ /**
95
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
96
+ * @summary Get the kpis for a given option inside a value framework
97
+ * @param {string} investmentId UUID of the investment
98
+ * @param {string} optionId UUID of the option
99
+ * @param {string} valueFrameworkId UUID of the value framework
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
93
104
  /**
94
105
  * Retrieve a paginated list of all options for a specific investment.
95
106
  * @summary List options for this investment
@@ -194,6 +205,16 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
194
205
  * @throws {RequiredError}
195
206
  */
196
207
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
208
+ /**
209
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
210
+ * @summary Get the kpis for a given option inside a value framework
211
+ * @param {string} investmentId UUID of the investment
212
+ * @param {string} optionId UUID of the option
213
+ * @param {string} valueFrameworkId UUID of the value framework
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ */
217
+ getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
197
218
  /**
198
219
  * Retrieve a paginated list of all options for a specific investment.
199
220
  * @summary List options for this investment
@@ -298,6 +319,16 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
298
319
  * @throws {RequiredError}
299
320
  */
300
321
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
322
+ /**
323
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
324
+ * @summary Get the kpis for a given option inside a value framework
325
+ * @param {string} investmentId UUID of the investment
326
+ * @param {string} optionId UUID of the option
327
+ * @param {string} valueFrameworkId UUID of the value framework
328
+ * @param {*} [options] Override http request option.
329
+ * @throws {RequiredError}
330
+ */
331
+ getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
301
332
  /**
302
333
  * Retrieve a paginated list of all options for a specific investment.
303
334
  * @summary List options for this investment
@@ -402,6 +433,16 @@ export declare class OptionApi extends BaseAPI {
402
433
  * @throws {RequiredError}
403
434
  */
404
435
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
436
+ /**
437
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
438
+ * @summary Get the kpis for a given option inside a value framework
439
+ * @param {string} investmentId UUID of the investment
440
+ * @param {string} optionId UUID of the option
441
+ * @param {string} valueFrameworkId UUID of the value framework
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ */
445
+ getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
405
446
  /**
406
447
  * Retrieve a paginated list of all options for a specific investment.
407
448
  * @summary List options for this investment