@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
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -222,39 +222,6 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
222
222
  options: localVarRequestOptions,
223
223
  };
224
224
  }),
225
- /**
226
- * Get the preferred option for an investment.
227
- * @summary Get the preferred option for an investment
228
- * @param {string} investmentId UUID of the investment
229
- * @param {*} [options] Override http request option.
230
- * @throws {RequiredError}
231
- */
232
- getFavoredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
233
- // verify required parameter 'investmentId' is not null or undefined
234
- (0, common_1.assertParamExists)('getFavoredOption', 'investmentId', investmentId);
235
- const localVarPath = `/investment/{investment_id}/favored_option`
236
- .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
237
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
238
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
239
- let baseOptions;
240
- if (configuration) {
241
- baseOptions = configuration.baseOptions;
242
- }
243
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
244
- const localVarHeaderParameter = {};
245
- const localVarQueryParameter = {};
246
- // authentication OAuth2AuthorizationCodeBearer required
247
- // oauth required
248
- yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
249
- localVarHeaderParameter['Accept'] = 'application/json';
250
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
251
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
252
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
253
- return {
254
- url: (0, common_1.toPathString)(localVarUrlObj),
255
- options: localVarRequestOptions,
256
- };
257
- }),
258
225
  /**
259
226
  * Retrieve a specific impact for the option.
260
227
  * @summary Get an impact for this option
@@ -448,6 +415,47 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
448
415
  options: localVarRequestOptions,
449
416
  };
450
417
  }),
418
+ /**
419
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
420
+ * @summary Get the kpis for a given option inside a value framework
421
+ * @param {string} investmentId UUID of the investment
422
+ * @param {string} optionId UUID of the option
423
+ * @param {string} valueFrameworkId UUID of the value framework
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ */
427
+ 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 = {}) {
428
+ // verify required parameter 'investmentId' is not null or undefined
429
+ (0, common_1.assertParamExists)('getOptionKpis', 'investmentId', investmentId);
430
+ // verify required parameter 'optionId' is not null or undefined
431
+ (0, common_1.assertParamExists)('getOptionKpis', 'optionId', optionId);
432
+ // verify required parameter 'valueFrameworkId' is not null or undefined
433
+ (0, common_1.assertParamExists)('getOptionKpis', 'valueFrameworkId', valueFrameworkId);
434
+ const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
435
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
436
+ .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
437
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
438
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
439
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
440
+ let baseOptions;
441
+ if (configuration) {
442
+ baseOptions = configuration.baseOptions;
443
+ }
444
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
445
+ const localVarHeaderParameter = {};
446
+ const localVarQueryParameter = {};
447
+ // authentication OAuth2AuthorizationCodeBearer required
448
+ // oauth required
449
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
450
+ localVarHeaderParameter['Accept'] = 'application/json';
451
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
452
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
453
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
454
+ return {
455
+ url: (0, common_1.toPathString)(localVarUrlObj),
456
+ options: localVarRequestOptions,
457
+ };
458
+ }),
451
459
  /**
452
460
  * Retrieve a paginated list of all options for a specific investment.
453
461
  * @summary List options for this investment
@@ -489,6 +497,39 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
489
497
  options: localVarRequestOptions,
490
498
  };
491
499
  }),
500
+ /**
501
+ * Get the preferred option for an investment.
502
+ * @summary Get the preferred option for an investment
503
+ * @param {string} investmentId UUID of the investment
504
+ * @param {*} [options] Override http request option.
505
+ * @throws {RequiredError}
506
+ */
507
+ getPreferredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
508
+ // verify required parameter 'investmentId' is not null or undefined
509
+ (0, common_1.assertParamExists)('getPreferredOption', 'investmentId', investmentId);
510
+ const localVarPath = `/investment/{investment_id}/preferred_option`
511
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
512
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
513
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
514
+ let baseOptions;
515
+ if (configuration) {
516
+ baseOptions = configuration.baseOptions;
517
+ }
518
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
519
+ const localVarHeaderParameter = {};
520
+ const localVarQueryParameter = {};
521
+ // authentication OAuth2AuthorizationCodeBearer required
522
+ // oauth required
523
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
524
+ localVarHeaderParameter['Accept'] = 'application/json';
525
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
526
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
527
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
528
+ return {
529
+ url: (0, common_1.toPathString)(localVarUrlObj),
530
+ options: localVarRequestOptions,
531
+ };
532
+ }),
492
533
  /**
493
534
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
494
535
  * @summary Partially update an impact for this option
@@ -653,16 +694,16 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
653
694
  * Set the preferred option for an investment.
654
695
  * @summary Set the preferred option for an investment
655
696
  * @param {string} investmentId UUID of the investment
656
- * @param {FavoredOptionRequest} favoredOptionRequest
697
+ * @param {PreferredOptionRequest} preferredOptionRequest
657
698
  * @param {*} [options] Override http request option.
658
699
  * @throws {RequiredError}
659
700
  */
660
- setFavoredOption: (investmentId_1, favoredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, favoredOptionRequest_1, ...args_1], void 0, function* (investmentId, favoredOptionRequest, options = {}) {
701
+ setPreferredOption: (investmentId_1, preferredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, preferredOptionRequest_1, ...args_1], void 0, function* (investmentId, preferredOptionRequest, options = {}) {
661
702
  // verify required parameter 'investmentId' is not null or undefined
662
- (0, common_1.assertParamExists)('setFavoredOption', 'investmentId', investmentId);
663
- // verify required parameter 'favoredOptionRequest' is not null or undefined
664
- (0, common_1.assertParamExists)('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest);
665
- const localVarPath = `/investment/{investment_id}/favored_option`
703
+ (0, common_1.assertParamExists)('setPreferredOption', 'investmentId', investmentId);
704
+ // verify required parameter 'preferredOptionRequest' is not null or undefined
705
+ (0, common_1.assertParamExists)('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest);
706
+ const localVarPath = `/investment/{investment_id}/preferred_option`
666
707
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
667
708
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
668
709
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -681,7 +722,7 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
681
722
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
682
723
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
683
724
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
684
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(favoredOptionRequest, localVarRequestOptions, configuration);
725
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(preferredOptionRequest, localVarRequestOptions, configuration);
685
726
  return {
686
727
  url: (0, common_1.toPathString)(localVarUrlObj),
687
728
  options: localVarRequestOptions,
@@ -782,22 +823,6 @@ const InvestmentApiFp = function (configuration) {
782
823
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
783
824
  });
784
825
  },
785
- /**
786
- * Get the preferred option for an investment.
787
- * @summary Get the preferred option for an investment
788
- * @param {string} investmentId UUID of the investment
789
- * @param {*} [options] Override http request option.
790
- * @throws {RequiredError}
791
- */
792
- getFavoredOption(investmentId, options) {
793
- return __awaiter(this, void 0, void 0, function* () {
794
- var _a, _b, _c;
795
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getFavoredOption(investmentId, options);
796
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
797
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.getFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
798
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
799
- });
800
- },
801
826
  /**
802
827
  * Retrieve a specific impact for the option.
803
828
  * @summary Get an impact for this option
@@ -885,6 +910,24 @@ const InvestmentApiFp = function (configuration) {
885
910
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
886
911
  });
887
912
  },
913
+ /**
914
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
915
+ * @summary Get the kpis for a given option inside a value framework
916
+ * @param {string} investmentId UUID of the investment
917
+ * @param {string} optionId UUID of the option
918
+ * @param {string} valueFrameworkId UUID of the value framework
919
+ * @param {*} [options] Override http request option.
920
+ * @throws {RequiredError}
921
+ */
922
+ getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
923
+ return __awaiter(this, void 0, void 0, function* () {
924
+ var _a, _b, _c;
925
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
926
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
927
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.getOptionKpis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
928
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
929
+ });
930
+ },
888
931
  /**
889
932
  * Retrieve a paginated list of all options for a specific investment.
890
933
  * @summary List options for this investment
@@ -903,6 +946,22 @@ const InvestmentApiFp = function (configuration) {
903
946
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
904
947
  });
905
948
  },
949
+ /**
950
+ * Get the preferred option for an investment.
951
+ * @summary Get the preferred option for an investment
952
+ * @param {string} investmentId UUID of the investment
953
+ * @param {*} [options] Override http request option.
954
+ * @throws {RequiredError}
955
+ */
956
+ getPreferredOption(investmentId, options) {
957
+ return __awaiter(this, void 0, void 0, function* () {
958
+ var _a, _b, _c;
959
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPreferredOption(investmentId, options);
960
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
961
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.getPreferredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
962
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
963
+ });
964
+ },
906
965
  /**
907
966
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
908
967
  * @summary Partially update an impact for this option
@@ -977,16 +1036,16 @@ const InvestmentApiFp = function (configuration) {
977
1036
  * Set the preferred option for an investment.
978
1037
  * @summary Set the preferred option for an investment
979
1038
  * @param {string} investmentId UUID of the investment
980
- * @param {FavoredOptionRequest} favoredOptionRequest
1039
+ * @param {PreferredOptionRequest} preferredOptionRequest
981
1040
  * @param {*} [options] Override http request option.
982
1041
  * @throws {RequiredError}
983
1042
  */
984
- setFavoredOption(investmentId, favoredOptionRequest, options) {
1043
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
985
1044
  return __awaiter(this, void 0, void 0, function* () {
986
1045
  var _a, _b, _c;
987
- const localVarAxiosArgs = yield localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
1046
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
988
1047
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
989
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.setFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1048
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.setPreferredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
990
1049
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
991
1050
  });
992
1051
  },
@@ -1055,16 +1114,6 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1055
1114
  deleteOptionForInvestment(optionId, investmentId, options) {
1056
1115
  return localVarFp.deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1057
1116
  },
1058
- /**
1059
- * Get the preferred option for an investment.
1060
- * @summary Get the preferred option for an investment
1061
- * @param {string} investmentId UUID of the investment
1062
- * @param {*} [options] Override http request option.
1063
- * @throws {RequiredError}
1064
- */
1065
- getFavoredOption(investmentId, options) {
1066
- return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
1067
- },
1068
1117
  /**
1069
1118
  * Retrieve a specific impact for the option.
1070
1119
  * @summary Get an impact for this option
@@ -1122,6 +1171,18 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1122
1171
  getOptionForInvestment(optionId, investmentId, options) {
1123
1172
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1124
1173
  },
1174
+ /**
1175
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1176
+ * @summary Get the kpis for a given option inside a value framework
1177
+ * @param {string} investmentId UUID of the investment
1178
+ * @param {string} optionId UUID of the option
1179
+ * @param {string} valueFrameworkId UUID of the value framework
1180
+ * @param {*} [options] Override http request option.
1181
+ * @throws {RequiredError}
1182
+ */
1183
+ getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
1184
+ return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
1185
+ },
1125
1186
  /**
1126
1187
  * Retrieve a paginated list of all options for a specific investment.
1127
1188
  * @summary List options for this investment
@@ -1134,6 +1195,16 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1134
1195
  getOptionsForInvestment(investmentId, offset, limit, options) {
1135
1196
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
1136
1197
  },
1198
+ /**
1199
+ * Get the preferred option for an investment.
1200
+ * @summary Get the preferred option for an investment
1201
+ * @param {string} investmentId UUID of the investment
1202
+ * @param {*} [options] Override http request option.
1203
+ * @throws {RequiredError}
1204
+ */
1205
+ getPreferredOption(investmentId, options) {
1206
+ return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
1207
+ },
1137
1208
  /**
1138
1209
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1139
1210
  * @summary Partially update an impact for this option
@@ -1184,12 +1255,12 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1184
1255
  * Set the preferred option for an investment.
1185
1256
  * @summary Set the preferred option for an investment
1186
1257
  * @param {string} investmentId UUID of the investment
1187
- * @param {FavoredOptionRequest} favoredOptionRequest
1258
+ * @param {PreferredOptionRequest} preferredOptionRequest
1188
1259
  * @param {*} [options] Override http request option.
1189
1260
  * @throws {RequiredError}
1190
1261
  */
1191
- setFavoredOption(investmentId, favoredOptionRequest, options) {
1192
- return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
1262
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
1263
+ return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
1193
1264
  },
1194
1265
  };
1195
1266
  };
@@ -1254,16 +1325,6 @@ class InvestmentApi extends base_1.BaseAPI {
1254
1325
  deleteOptionForInvestment(optionId, investmentId, options) {
1255
1326
  return (0, exports.InvestmentApiFp)(this.configuration).deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1256
1327
  }
1257
- /**
1258
- * Get the preferred option for an investment.
1259
- * @summary Get the preferred option for an investment
1260
- * @param {string} investmentId UUID of the investment
1261
- * @param {*} [options] Override http request option.
1262
- * @throws {RequiredError}
1263
- */
1264
- getFavoredOption(investmentId, options) {
1265
- return (0, exports.InvestmentApiFp)(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1266
- }
1267
1328
  /**
1268
1329
  * Retrieve a specific impact for the option.
1269
1330
  * @summary Get an impact for this option
@@ -1321,6 +1382,18 @@ class InvestmentApi extends base_1.BaseAPI {
1321
1382
  getOptionForInvestment(optionId, investmentId, options) {
1322
1383
  return (0, exports.InvestmentApiFp)(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1323
1384
  }
1385
+ /**
1386
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1387
+ * @summary Get the kpis for a given option inside a value framework
1388
+ * @param {string} investmentId UUID of the investment
1389
+ * @param {string} optionId UUID of the option
1390
+ * @param {string} valueFrameworkId UUID of the value framework
1391
+ * @param {*} [options] Override http request option.
1392
+ * @throws {RequiredError}
1393
+ */
1394
+ getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
1395
+ return (0, exports.InvestmentApiFp)(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1396
+ }
1324
1397
  /**
1325
1398
  * Retrieve a paginated list of all options for a specific investment.
1326
1399
  * @summary List options for this investment
@@ -1333,6 +1406,16 @@ class InvestmentApi extends base_1.BaseAPI {
1333
1406
  getOptionsForInvestment(investmentId, offset, limit, options) {
1334
1407
  return (0, exports.InvestmentApiFp)(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1335
1408
  }
1409
+ /**
1410
+ * Get the preferred option for an investment.
1411
+ * @summary Get the preferred option for an investment
1412
+ * @param {string} investmentId UUID of the investment
1413
+ * @param {*} [options] Override http request option.
1414
+ * @throws {RequiredError}
1415
+ */
1416
+ getPreferredOption(investmentId, options) {
1417
+ return (0, exports.InvestmentApiFp)(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1418
+ }
1336
1419
  /**
1337
1420
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1338
1421
  * @summary Partially update an impact for this option
@@ -1383,12 +1466,12 @@ class InvestmentApi extends base_1.BaseAPI {
1383
1466
  * Set the preferred option for an investment.
1384
1467
  * @summary Set the preferred option for an investment
1385
1468
  * @param {string} investmentId UUID of the investment
1386
- * @param {FavoredOptionRequest} favoredOptionRequest
1469
+ * @param {PreferredOptionRequest} preferredOptionRequest
1387
1470
  * @param {*} [options] Override http request option.
1388
1471
  * @throws {RequiredError}
1389
1472
  */
1390
- setFavoredOption(investmentId, favoredOptionRequest, options) {
1391
- return (0, exports.InvestmentApiFp)(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1473
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
1474
+ return (0, exports.InvestmentApiFp)(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1392
1475
  }
1393
1476
  }
1394
1477
  exports.InvestmentApi = InvestmentApi;
@@ -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).
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * 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).
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * 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).
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * 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).
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * 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).
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * 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).
@@ -5,7 +5,7 @@
5
5
  * Asset Investment Planning
6
6
  * API for Asset Investment Planning
7
7
  *
8
- * The version of the OpenAPI document: 0.2.0-dev3
8
+ * The version of the OpenAPI document: 0.2.0-dev6
9
9
  *
10
10
  *
11
11
  * 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