@cosmotech/aip-client 0.2.0-dev5 → 0.2.0-dev7

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 (289) hide show
  1. package/README.md +13 -8
  2. package/api/default-api.ts +1 -1
  3. package/api/impact-api.ts +1 -1
  4. package/api/investment-api.ts +259 -98
  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 -5
  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 +117 -47
  25. package/dist/api/investment-api.js +240 -91
  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 -5
  39. package/dist/api/option-api.js +83 -5
  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 +117 -47
  61. package/dist/esm/api/investment-api.js +240 -91
  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 -5
  75. package/dist/esm/api/option-api.js +83 -5
  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-overview-response.d.ts +29 -0
  109. package/dist/esm/models/{favored-option-request.js → investment-overview-response.js} +1 -1
  110. package/dist/esm/models/investment-response.d.ts +1 -1
  111. package/dist/esm/models/investment-response.js +1 -1
  112. package/dist/esm/models/investment-update.d.ts +1 -1
  113. package/dist/esm/models/investment-update.js +1 -1
  114. package/dist/esm/models/location-inner.d.ts +1 -1
  115. package/dist/esm/models/location-inner.js +1 -1
  116. package/dist/esm/models/measurement-type.d.ts +1 -1
  117. package/dist/esm/models/measurement-type.js +1 -1
  118. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
  119. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  120. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
  121. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  122. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
  123. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  124. package/dist/esm/models/metric-create.d.ts +1 -1
  125. package/dist/esm/models/metric-create.js +1 -1
  126. package/dist/esm/models/metric-response.d.ts +1 -1
  127. package/dist/esm/models/metric-response.js +1 -1
  128. package/dist/esm/models/metric-type.d.ts +1 -1
  129. package/dist/esm/models/metric-type.js +1 -1
  130. package/dist/esm/models/metric-update.d.ts +1 -1
  131. package/dist/esm/models/metric-update.js +1 -1
  132. package/dist/esm/models/objective-create.d.ts +1 -1
  133. package/dist/esm/models/objective-create.js +1 -1
  134. package/dist/esm/models/objective-response.d.ts +1 -1
  135. package/dist/esm/models/objective-response.js +1 -1
  136. package/dist/esm/models/objective-update.d.ts +1 -1
  137. package/dist/esm/models/objective-update.js +1 -1
  138. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  139. package/dist/esm/models/objective-weight-create.js +1 -1
  140. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  141. package/dist/esm/models/objective-weight-response.js +1 -1
  142. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  143. package/dist/esm/models/objective-weight-update.js +1 -1
  144. package/dist/esm/models/option-chart-kpi.d.ts +1 -1
  145. package/dist/esm/models/option-chart-kpi.js +1 -1
  146. package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
  147. package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
  148. package/dist/esm/models/option-create.d.ts +1 -1
  149. package/dist/esm/models/option-create.js +1 -1
  150. package/dist/esm/models/option-overview-response.d.ts +37 -0
  151. package/dist/esm/models/{favored-option-response.js → option-overview-response.js} +1 -1
  152. package/dist/esm/models/option-response.d.ts +1 -1
  153. package/dist/esm/models/option-response.js +1 -1
  154. package/dist/esm/models/option-update.d.ts +1 -1
  155. package/dist/esm/models/option-update.js +1 -1
  156. package/dist/esm/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  157. package/dist/esm/models/preferred-option-request.js +14 -0
  158. package/dist/esm/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  159. package/dist/esm/models/preferred-option-response.js +14 -0
  160. package/dist/esm/models/validation-error.d.ts +1 -1
  161. package/dist/esm/models/validation-error.js +1 -1
  162. package/dist/esm/models/value-framework-create.d.ts +1 -1
  163. package/dist/esm/models/value-framework-create.js +1 -1
  164. package/dist/esm/models/value-framework-response.d.ts +1 -1
  165. package/dist/esm/models/value-framework-response.js +1 -1
  166. package/dist/esm/models/value-framework-update.d.ts +1 -1
  167. package/dist/esm/models/value-framework-update.js +1 -1
  168. package/dist/index.d.ts +1 -1
  169. package/dist/index.js +1 -1
  170. package/dist/models/evolution-type.d.ts +1 -1
  171. package/dist/models/evolution-type.js +1 -1
  172. package/dist/models/httpvalidation-error.d.ts +1 -1
  173. package/dist/models/httpvalidation-error.js +1 -1
  174. package/dist/models/impact-apiresponse.d.ts +1 -1
  175. package/dist/models/impact-apiresponse.js +1 -1
  176. package/dist/models/impact-create.d.ts +1 -1
  177. package/dist/models/impact-create.js +1 -1
  178. package/dist/models/impact-update.d.ts +1 -1
  179. package/dist/models/impact-update.js +1 -1
  180. package/dist/models/index.d.ts +4 -2
  181. package/dist/models/index.js +4 -2
  182. package/dist/models/investment-create.d.ts +1 -1
  183. package/dist/models/investment-create.js +1 -1
  184. package/dist/models/investment-overview-response.d.ts +29 -0
  185. package/dist/models/{favored-option-request.js → investment-overview-response.js} +1 -1
  186. package/dist/models/investment-response.d.ts +1 -1
  187. package/dist/models/investment-response.js +1 -1
  188. package/dist/models/investment-update.d.ts +1 -1
  189. package/dist/models/investment-update.js +1 -1
  190. package/dist/models/location-inner.d.ts +1 -1
  191. package/dist/models/location-inner.js +1 -1
  192. package/dist/models/measurement-type.d.ts +1 -1
  193. package/dist/models/measurement-type.js +1 -1
  194. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  195. package/dist/models/metric-costs-per-year-create.js +1 -1
  196. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  197. package/dist/models/metric-costs-per-year-response.js +1 -1
  198. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  199. package/dist/models/metric-costs-per-year-update.js +1 -1
  200. package/dist/models/metric-create.d.ts +1 -1
  201. package/dist/models/metric-create.js +1 -1
  202. package/dist/models/metric-response.d.ts +1 -1
  203. package/dist/models/metric-response.js +1 -1
  204. package/dist/models/metric-type.d.ts +1 -1
  205. package/dist/models/metric-type.js +1 -1
  206. package/dist/models/metric-update.d.ts +1 -1
  207. package/dist/models/metric-update.js +1 -1
  208. package/dist/models/objective-create.d.ts +1 -1
  209. package/dist/models/objective-create.js +1 -1
  210. package/dist/models/objective-response.d.ts +1 -1
  211. package/dist/models/objective-response.js +1 -1
  212. package/dist/models/objective-update.d.ts +1 -1
  213. package/dist/models/objective-update.js +1 -1
  214. package/dist/models/objective-weight-create.d.ts +1 -1
  215. package/dist/models/objective-weight-create.js +1 -1
  216. package/dist/models/objective-weight-response.d.ts +1 -1
  217. package/dist/models/objective-weight-response.js +1 -1
  218. package/dist/models/objective-weight-update.d.ts +1 -1
  219. package/dist/models/objective-weight-update.js +1 -1
  220. package/dist/models/option-chart-kpi.d.ts +1 -1
  221. package/dist/models/option-chart-kpi.js +1 -1
  222. package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
  223. package/dist/models/option-chart-kpis-yearly.js +1 -1
  224. package/dist/models/option-create.d.ts +1 -1
  225. package/dist/models/option-create.js +1 -1
  226. package/dist/models/option-overview-response.d.ts +37 -0
  227. package/dist/models/{favored-option-response.js → option-overview-response.js} +1 -1
  228. package/dist/models/option-response.d.ts +1 -1
  229. package/dist/models/option-response.js +1 -1
  230. package/dist/models/option-update.d.ts +1 -1
  231. package/dist/models/option-update.js +1 -1
  232. package/dist/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  233. package/dist/models/preferred-option-request.js +15 -0
  234. package/dist/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  235. package/dist/models/preferred-option-response.js +15 -0
  236. package/dist/models/validation-error.d.ts +1 -1
  237. package/dist/models/validation-error.js +1 -1
  238. package/dist/models/value-framework-create.d.ts +1 -1
  239. package/dist/models/value-framework-create.js +1 -1
  240. package/dist/models/value-framework-response.d.ts +1 -1
  241. package/dist/models/value-framework-response.js +1 -1
  242. package/dist/models/value-framework-update.d.ts +1 -1
  243. package/dist/models/value-framework-update.js +1 -1
  244. package/docs/InvestmentApi.md +174 -65
  245. package/docs/InvestmentOverviewResponse.md +33 -0
  246. package/docs/OptionApi.md +58 -2
  247. package/docs/OptionOverviewResponse.md +31 -0
  248. package/docs/{FavoredOptionApi.md → PreferredOptionApi.md} +19 -19
  249. package/docs/{FavoredOptionRequest.md → PreferredOptionRequest.md} +3 -3
  250. package/docs/{FavoredOptionResponse.md → PreferredOptionResponse.md} +4 -4
  251. package/index.ts +1 -1
  252. package/models/evolution-type.ts +1 -1
  253. package/models/httpvalidation-error.ts +1 -1
  254. package/models/impact-apiresponse.ts +1 -1
  255. package/models/impact-create.ts +1 -1
  256. package/models/impact-update.ts +1 -1
  257. package/models/index.ts +4 -2
  258. package/models/investment-create.ts +1 -1
  259. package/models/investment-overview-response.ts +35 -0
  260. package/models/investment-response.ts +1 -1
  261. package/models/investment-update.ts +1 -1
  262. package/models/location-inner.ts +1 -1
  263. package/models/measurement-type.ts +1 -1
  264. package/models/metric-costs-per-year-create.ts +1 -1
  265. package/models/metric-costs-per-year-response.ts +1 -1
  266. package/models/metric-costs-per-year-update.ts +1 -1
  267. package/models/metric-create.ts +1 -1
  268. package/models/metric-response.ts +1 -1
  269. package/models/metric-type.ts +1 -1
  270. package/models/metric-update.ts +1 -1
  271. package/models/objective-create.ts +1 -1
  272. package/models/objective-response.ts +1 -1
  273. package/models/objective-update.ts +1 -1
  274. package/models/objective-weight-create.ts +1 -1
  275. package/models/objective-weight-response.ts +1 -1
  276. package/models/objective-weight-update.ts +1 -1
  277. package/models/option-chart-kpi.ts +1 -1
  278. package/models/option-chart-kpis-yearly.ts +1 -1
  279. package/models/option-create.ts +1 -1
  280. package/models/option-overview-response.ts +43 -0
  281. package/models/option-response.ts +1 -1
  282. package/models/option-update.ts +1 -1
  283. package/models/{favored-option-request.ts → preferred-option-request.ts} +2 -2
  284. package/models/{favored-option-response.ts → preferred-option-response.ts} +3 -3
  285. package/models/validation-error.ts +1 -1
  286. package/models/value-framework-create.ts +1 -1
  287. package/models/value-framework-response.ts +1 -1
  288. package/models/value-framework-update.ts +1 -1
  289. package/package.json +1 -1
package/api/option-api.ts CHANGED
@@ -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).
@@ -32,6 +32,8 @@ import type { OptionChartKPIsYearly } from '../models';
32
32
  // @ts-ignore
33
33
  import type { OptionCreate } from '../models';
34
34
  // @ts-ignore
35
+ import type { OptionOverviewResponse } from '../models';
36
+ // @ts-ignore
35
37
  import type { OptionResponse } from '../models';
36
38
  // @ts-ignore
37
39
  import type { OptionUpdate } from '../models';
@@ -357,7 +359,7 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
357
359
  };
358
360
  },
359
361
  /**
360
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
362
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
361
363
  * @summary Get the kpis for a given option inside a value framework
362
364
  * @param {string} investmentId UUID of the investment
363
365
  * @param {string} optionId UUID of the option
@@ -450,6 +452,51 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
450
452
  options: localVarRequestOptions,
451
453
  };
452
454
  },
455
+ /**
456
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
457
+ * @summary Option overview table for this investment
458
+ * @param {string} investmentId UUID of the investment
459
+ * @param {string} valueFrameworkId UUID of the value framework
460
+ * @param {*} [options] Override http request option.
461
+ * @throws {RequiredError}
462
+ */
463
+ getOptionsOverview: async (investmentId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
464
+ // verify required parameter 'investmentId' is not null or undefined
465
+ assertParamExists('getOptionsOverview', 'investmentId', investmentId)
466
+ // verify required parameter 'valueFrameworkId' is not null or undefined
467
+ assertParamExists('getOptionsOverview', 'valueFrameworkId', valueFrameworkId)
468
+ const localVarPath = `/investment/{investment_id}/option/overview`
469
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
470
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
471
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
472
+ let baseOptions;
473
+ if (configuration) {
474
+ baseOptions = configuration.baseOptions;
475
+ }
476
+
477
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
478
+ const localVarHeaderParameter = {} as any;
479
+ const localVarQueryParameter = {} as any;
480
+
481
+ // authentication OAuth2AuthorizationCodeBearer required
482
+ // oauth required
483
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
484
+
485
+ if (valueFrameworkId !== undefined) {
486
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
487
+ }
488
+
489
+ localVarHeaderParameter['Accept'] = 'application/json';
490
+
491
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
492
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
493
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
494
+
495
+ return {
496
+ url: toPathString(localVarUrlObj),
497
+ options: localVarRequestOptions,
498
+ };
499
+ },
453
500
  /**
454
501
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
455
502
  * @summary Partially update an impact for this option
@@ -661,7 +708,7 @@ export const OptionApiFp = function(configuration?: Configuration) {
661
708
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
662
709
  },
663
710
  /**
664
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
711
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
665
712
  * @summary Get the kpis for a given option inside a value framework
666
713
  * @param {string} investmentId UUID of the investment
667
714
  * @param {string} optionId UUID of the option
@@ -690,6 +737,20 @@ export const OptionApiFp = function(configuration?: Configuration) {
690
737
  const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionsForInvestment']?.[localVarOperationServerIndex]?.url;
691
738
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
692
739
  },
740
+ /**
741
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
742
+ * @summary Option overview table for this investment
743
+ * @param {string} investmentId UUID of the investment
744
+ * @param {string} valueFrameworkId UUID of the value framework
745
+ * @param {*} [options] Override http request option.
746
+ * @throws {RequiredError}
747
+ */
748
+ async getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>> {
749
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
750
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
751
+ const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionsOverview']?.[localVarOperationServerIndex]?.url;
752
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
753
+ },
693
754
  /**
694
755
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
695
756
  * @summary Partially update an impact for this option
@@ -813,7 +874,7 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
813
874
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
814
875
  },
815
876
  /**
816
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
877
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
817
878
  * @summary Get the kpis for a given option inside a value framework
818
879
  * @param {string} investmentId UUID of the investment
819
880
  * @param {string} optionId UUID of the option
@@ -836,6 +897,17 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
836
897
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>> {
837
898
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
838
899
  },
900
+ /**
901
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
902
+ * @summary Option overview table for this investment
903
+ * @param {string} investmentId UUID of the investment
904
+ * @param {string} valueFrameworkId UUID of the value framework
905
+ * @param {*} [options] Override http request option.
906
+ * @throws {RequiredError}
907
+ */
908
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>> {
909
+ return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
910
+ },
839
911
  /**
840
912
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
841
913
  * @summary Partially update an impact for this option
@@ -958,7 +1030,7 @@ export class OptionApi extends BaseAPI {
958
1030
  }
959
1031
 
960
1032
  /**
961
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1033
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
962
1034
  * @summary Get the kpis for a given option inside a value framework
963
1035
  * @param {string} investmentId UUID of the investment
964
1036
  * @param {string} optionId UUID of the option
@@ -983,6 +1055,18 @@ export class OptionApi extends BaseAPI {
983
1055
  return OptionApiFp(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
984
1056
  }
985
1057
 
1058
+ /**
1059
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
1060
+ * @summary Option overview table for this investment
1061
+ * @param {string} investmentId UUID of the investment
1062
+ * @param {string} valueFrameworkId UUID of the value framework
1063
+ * @param {*} [options] Override http request option.
1064
+ * @throws {RequiredError}
1065
+ */
1066
+ public getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1067
+ return OptionApiFp(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1068
+ }
1069
+
986
1070
  /**
987
1071
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
988
1072
  * @summary Partially update an impact for this option
@@ -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).
@@ -22,13 +22,13 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
- import type { FavoredOptionRequest } from '../models';
25
+ import type { PreferredOptionRequest } from '../models';
26
26
  // @ts-ignore
27
- import type { FavoredOptionResponse } from '../models';
27
+ import type { PreferredOptionResponse } from '../models';
28
28
  /**
29
- * FavoredOptionApi - axios parameter creator
29
+ * PreferredOptionApi - axios parameter creator
30
30
  */
31
- export const FavoredOptionApiAxiosParamCreator = function (configuration?: Configuration) {
31
+ export const PreferredOptionApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
34
  * Get the preferred option for an investment.
@@ -37,10 +37,10 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
37
37
  * @param {*} [options] Override http request option.
38
38
  * @throws {RequiredError}
39
39
  */
40
- getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
40
+ getPreferredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
41
41
  // verify required parameter 'investmentId' is not null or undefined
42
- assertParamExists('getFavoredOption', 'investmentId', investmentId)
43
- const localVarPath = `/investment/{investment_id}/favored_option`
42
+ assertParamExists('getPreferredOption', 'investmentId', investmentId)
43
+ const localVarPath = `/investment/{investment_id}/preferred_option`
44
44
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
45
45
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
46
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -72,16 +72,16 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
72
72
  * Set the preferred option for an investment.
73
73
  * @summary Set the preferred option for an investment
74
74
  * @param {string} investmentId UUID of the investment
75
- * @param {FavoredOptionRequest} favoredOptionRequest
75
+ * @param {PreferredOptionRequest} preferredOptionRequest
76
76
  * @param {*} [options] Override http request option.
77
77
  * @throws {RequiredError}
78
78
  */
79
- setFavoredOption: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
79
+ setPreferredOption: async (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
80
80
  // verify required parameter 'investmentId' is not null or undefined
81
- assertParamExists('setFavoredOption', 'investmentId', investmentId)
82
- // verify required parameter 'favoredOptionRequest' is not null or undefined
83
- assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest)
84
- const localVarPath = `/investment/{investment_id}/favored_option`
81
+ assertParamExists('setPreferredOption', 'investmentId', investmentId)
82
+ // verify required parameter 'preferredOptionRequest' is not null or undefined
83
+ assertParamExists('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest)
84
+ const localVarPath = `/investment/{investment_id}/preferred_option`
85
85
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
86
86
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
87
87
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -104,7 +104,7 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
104
104
  setSearchParams(localVarUrlObj, localVarQueryParameter);
105
105
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106
106
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
107
- localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
107
+ localVarRequestOptions.data = serializeDataIfNeeded(preferredOptionRequest, localVarRequestOptions, configuration)
108
108
 
109
109
  return {
110
110
  url: toPathString(localVarUrlObj),
@@ -115,10 +115,10 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
115
115
  };
116
116
 
117
117
  /**
118
- * FavoredOptionApi - functional programming interface
118
+ * PreferredOptionApi - functional programming interface
119
119
  */
120
- export const FavoredOptionApiFp = function(configuration?: Configuration) {
121
- const localVarAxiosParamCreator = FavoredOptionApiAxiosParamCreator(configuration)
120
+ export const PreferredOptionApiFp = function(configuration?: Configuration) {
121
+ const localVarAxiosParamCreator = PreferredOptionApiAxiosParamCreator(configuration)
122
122
  return {
123
123
  /**
124
124
  * Get the preferred option for an investment.
@@ -127,34 +127,34 @@ export const FavoredOptionApiFp = function(configuration?: Configuration) {
127
127
  * @param {*} [options] Override http request option.
128
128
  * @throws {RequiredError}
129
129
  */
130
- async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
131
- const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
130
+ async getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
131
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPreferredOption(investmentId, options);
132
132
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
133
- const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.getFavoredOption']?.[localVarOperationServerIndex]?.url;
133
+ const localVarOperationServerBasePath = operationServerMap['PreferredOptionApi.getPreferredOption']?.[localVarOperationServerIndex]?.url;
134
134
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
135
135
  },
136
136
  /**
137
137
  * Set the preferred option for an investment.
138
138
  * @summary Set the preferred option for an investment
139
139
  * @param {string} investmentId UUID of the investment
140
- * @param {FavoredOptionRequest} favoredOptionRequest
140
+ * @param {PreferredOptionRequest} preferredOptionRequest
141
141
  * @param {*} [options] Override http request option.
142
142
  * @throws {RequiredError}
143
143
  */
144
- async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
145
- const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
144
+ async setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
145
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
146
146
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
147
- const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
147
+ const localVarOperationServerBasePath = operationServerMap['PreferredOptionApi.setPreferredOption']?.[localVarOperationServerIndex]?.url;
148
148
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
149
149
  },
150
150
  }
151
151
  };
152
152
 
153
153
  /**
154
- * FavoredOptionApi - factory interface
154
+ * PreferredOptionApi - factory interface
155
155
  */
156
- export const FavoredOptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
157
- const localVarFp = FavoredOptionApiFp(configuration)
156
+ export const PreferredOptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
157
+ const localVarFp = PreferredOptionApiFp(configuration)
158
158
  return {
159
159
  /**
160
160
  * Get the preferred option for an investment.
@@ -163,27 +163,27 @@ export const FavoredOptionApiFactory = function (configuration?: Configuration,
163
163
  * @param {*} [options] Override http request option.
164
164
  * @throws {RequiredError}
165
165
  */
166
- getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
167
- return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
166
+ getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
167
+ return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
168
168
  },
169
169
  /**
170
170
  * Set the preferred option for an investment.
171
171
  * @summary Set the preferred option for an investment
172
172
  * @param {string} investmentId UUID of the investment
173
- * @param {FavoredOptionRequest} favoredOptionRequest
173
+ * @param {PreferredOptionRequest} preferredOptionRequest
174
174
  * @param {*} [options] Override http request option.
175
175
  * @throws {RequiredError}
176
176
  */
177
- setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
178
- return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
177
+ setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
178
+ return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
179
179
  },
180
180
  };
181
181
  };
182
182
 
183
183
  /**
184
- * FavoredOptionApi - object-oriented interface
184
+ * PreferredOptionApi - object-oriented interface
185
185
  */
186
- export class FavoredOptionApi extends BaseAPI {
186
+ export class PreferredOptionApi extends BaseAPI {
187
187
  /**
188
188
  * Get the preferred option for an investment.
189
189
  * @summary Get the preferred option for an investment
@@ -191,20 +191,20 @@ export class FavoredOptionApi extends BaseAPI {
191
191
  * @param {*} [options] Override http request option.
192
192
  * @throws {RequiredError}
193
193
  */
194
- public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
195
- return FavoredOptionApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
194
+ public getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig) {
195
+ return PreferredOptionApiFp(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
196
196
  }
197
197
 
198
198
  /**
199
199
  * Set the preferred option for an investment.
200
200
  * @summary Set the preferred option for an investment
201
201
  * @param {string} investmentId UUID of the investment
202
- * @param {FavoredOptionRequest} favoredOptionRequest
202
+ * @param {PreferredOptionRequest} preferredOptionRequest
203
203
  * @param {*} [options] Override http request option.
204
204
  * @throws {RequiredError}
205
205
  */
206
- public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
207
- return FavoredOptionApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
206
+ public setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) {
207
+ return PreferredOptionApiFp(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
208
208
  }
209
209
  }
210
210
 
@@ -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).
@@ -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).
@@ -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).
package/api.ts CHANGED
@@ -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).
@@ -15,7 +15,6 @@
15
15
 
16
16
 
17
17
  export * from './api/default-api';
18
- export * from './api/favored-option-api';
19
18
  export * from './api/impact-api';
20
19
  export * from './api/investment-api';
21
20
  export * from './api/metric-api';
@@ -25,6 +24,7 @@ export * from './api/objective-api';
25
24
  export * from './api/objective-weight-api';
26
25
  export * from './api/objective-weights-api';
27
26
  export * from './api/option-api';
27
+ export * from './api/preferred-option-api';
28
28
  export * from './api/value-framework-api';
29
29
  export * from './api/value-framework-costs-api';
30
30
  export * from './api/value-framework-weights-api';
package/base.ts CHANGED
@@ -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).
package/common.ts CHANGED
@@ -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).
package/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Asset Investment Planning
4
4
  * API for Asset Investment Planning
5
5
  *
6
- * The version of the OpenAPI document: 0.2.0-dev3
6
+ * The version of the OpenAPI document: 0.2.0-dev6
7
7
  *
8
8
  *
9
9
  * 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).