@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
@@ -9,19 +9,21 @@ All URIs are relative to *http://localhost*
9
9
  |[**deleteImpactForOption**](#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option|
10
10
  |[**deleteInvestment**](#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment|
11
11
  |[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
12
- |[**getFavoredOption**](#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment|
13
12
  |[**getImpactForOption**](#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option|
14
13
  |[**getImpactsForOption**](#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option|
15
14
  |[**getInvestmentById**](#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID|
16
15
  |[**getInvestments**](#getinvestments) | **GET** /investment/ | List investments|
16
+ |[**getInvestmentsOverview**](#getinvestmentsoverview) | **GET** /investment/overview | Investment overview table|
17
17
  |[**getOptionForInvestment**](#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment|
18
18
  |[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework|
19
19
  |[**getOptionsForInvestment**](#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment|
20
+ |[**getOptionsOverview**](#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment|
21
+ |[**getPreferredOption**](#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment|
20
22
  |[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
21
23
  |[**patchInvestment**](#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment|
22
24
  |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
23
25
  |[**postInvestment**](#postinvestment) | **POST** /investment/ | Create an investment|
24
- |[**setFavoredOption**](#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment|
26
+ |[**setPreferredOption**](#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment|
25
27
 
26
28
  # **createImpactForOption**
27
29
  > ImpactAPIResponse createImpactForOption(impactCreate)
@@ -305,59 +307,6 @@ void (empty response body)
305
307
 
306
308
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
307
309
 
308
- # **getFavoredOption**
309
- > FavoredOptionResponse getFavoredOption()
310
-
311
- Get the preferred option for an investment.
312
-
313
- ### Example
314
-
315
- ```typescript
316
- import {
317
- InvestmentApi,
318
- Configuration
319
- } from '@cosmotech/aip-client';
320
-
321
- const configuration = new Configuration();
322
- const apiInstance = new InvestmentApi(configuration);
323
-
324
- let investmentId: string; //UUID of the investment (default to undefined)
325
-
326
- const { status, data } = await apiInstance.getFavoredOption(
327
- investmentId
328
- );
329
- ```
330
-
331
- ### Parameters
332
-
333
- |Name | Type | Description | Notes|
334
- |------------- | ------------- | ------------- | -------------|
335
- | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
336
-
337
-
338
- ### Return type
339
-
340
- **FavoredOptionResponse**
341
-
342
- ### Authorization
343
-
344
- [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
345
-
346
- ### HTTP request headers
347
-
348
- - **Content-Type**: Not defined
349
- - **Accept**: application/json
350
-
351
-
352
- ### HTTP response details
353
- | Status code | Description | Response headers |
354
- |-------------|-------------|------------------|
355
- |**200** | Preferred option exists | - |
356
- |**204** | Investment exists but no options are associated | - |
357
- |**404** | Investment not found | - |
358
-
359
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
360
-
361
310
  # **getImpactForOption**
362
311
  > ImpactAPIResponse getImpactForOption()
363
312
 
@@ -583,6 +532,58 @@ const { status, data } = await apiInstance.getInvestments(
583
532
 
584
533
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
585
534
 
535
+ # **getInvestmentsOverview**
536
+ > Array<InvestmentOverviewResponse> getInvestmentsOverview()
537
+
538
+ Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
539
+
540
+ ### Example
541
+
542
+ ```typescript
543
+ import {
544
+ InvestmentApi,
545
+ Configuration
546
+ } from '@cosmotech/aip-client';
547
+
548
+ const configuration = new Configuration();
549
+ const apiInstance = new InvestmentApi(configuration);
550
+
551
+ let valueFrameworkId: string; //UUID of the value framework (default to undefined)
552
+
553
+ const { status, data } = await apiInstance.getInvestmentsOverview(
554
+ valueFrameworkId
555
+ );
556
+ ```
557
+
558
+ ### Parameters
559
+
560
+ |Name | Type | Description | Notes|
561
+ |------------- | ------------- | ------------- | -------------|
562
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
563
+
564
+
565
+ ### Return type
566
+
567
+ **Array<InvestmentOverviewResponse>**
568
+
569
+ ### Authorization
570
+
571
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
572
+
573
+ ### HTTP request headers
574
+
575
+ - **Content-Type**: Not defined
576
+ - **Accept**: application/json
577
+
578
+
579
+ ### HTTP response details
580
+ | Status code | Description | Response headers |
581
+ |-------------|-------------|------------------|
582
+ |**200** | Overview list of all investments | - |
583
+ |**404** | Value framework not found | - |
584
+
585
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
586
+
586
587
  # **getOptionForInvestment**
587
588
  > OptionResponse getOptionForInvestment()
588
589
 
@@ -641,7 +642,7 @@ const { status, data } = await apiInstance.getOptionForInvestment(
641
642
  # **getOptionKpis**
642
643
  > Array<OptionChartKPIsYearly> getOptionKpis()
643
644
 
644
- Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
645
+ 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.
645
646
 
646
647
  ### Example
647
648
 
@@ -692,7 +693,7 @@ const { status, data } = await apiInstance.getOptionKpis(
692
693
  | Status code | Description | Response headers |
693
694
  |-------------|-------------|------------------|
694
695
  |**200** | The requested KPIs | - |
695
- |**404** | Investment, option or value framework not found | - |
696
+ |**404** | Investment, option, value framework, or phase not found | - |
696
697
 
697
698
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
698
699
 
@@ -754,6 +755,114 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
754
755
 
755
756
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
756
757
 
758
+ # **getOptionsOverview**
759
+ > Array<OptionOverviewResponse> getOptionsOverview()
760
+
761
+ 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.
762
+
763
+ ### Example
764
+
765
+ ```typescript
766
+ import {
767
+ InvestmentApi,
768
+ Configuration
769
+ } from '@cosmotech/aip-client';
770
+
771
+ const configuration = new Configuration();
772
+ const apiInstance = new InvestmentApi(configuration);
773
+
774
+ let investmentId: string; //UUID of the investment (default to undefined)
775
+ let valueFrameworkId: string; //UUID of the value framework (default to undefined)
776
+
777
+ const { status, data } = await apiInstance.getOptionsOverview(
778
+ investmentId,
779
+ valueFrameworkId
780
+ );
781
+ ```
782
+
783
+ ### Parameters
784
+
785
+ |Name | Type | Description | Notes|
786
+ |------------- | ------------- | ------------- | -------------|
787
+ | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
788
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
789
+
790
+
791
+ ### Return type
792
+
793
+ **Array<OptionOverviewResponse>**
794
+
795
+ ### Authorization
796
+
797
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
798
+
799
+ ### HTTP request headers
800
+
801
+ - **Content-Type**: Not defined
802
+ - **Accept**: application/json
803
+
804
+
805
+ ### HTTP response details
806
+ | Status code | Description | Response headers |
807
+ |-------------|-------------|------------------|
808
+ |**200** | Overview list of all options for the investment | - |
809
+ |**404** | Investment or value framework not found | - |
810
+
811
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
812
+
813
+ # **getPreferredOption**
814
+ > PreferredOptionResponse getPreferredOption()
815
+
816
+ Get the preferred option for an investment.
817
+
818
+ ### Example
819
+
820
+ ```typescript
821
+ import {
822
+ InvestmentApi,
823
+ Configuration
824
+ } from '@cosmotech/aip-client';
825
+
826
+ const configuration = new Configuration();
827
+ const apiInstance = new InvestmentApi(configuration);
828
+
829
+ let investmentId: string; //UUID of the investment (default to undefined)
830
+
831
+ const { status, data } = await apiInstance.getPreferredOption(
832
+ investmentId
833
+ );
834
+ ```
835
+
836
+ ### Parameters
837
+
838
+ |Name | Type | Description | Notes|
839
+ |------------- | ------------- | ------------- | -------------|
840
+ | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
841
+
842
+
843
+ ### Return type
844
+
845
+ **PreferredOptionResponse**
846
+
847
+ ### Authorization
848
+
849
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
850
+
851
+ ### HTTP request headers
852
+
853
+ - **Content-Type**: Not defined
854
+ - **Accept**: application/json
855
+
856
+
857
+ ### HTTP response details
858
+ | Status code | Description | Response headers |
859
+ |-------------|-------------|------------------|
860
+ |**200** | Preferred option exists | - |
861
+ |**204** | Investment exists but no options are associated | - |
862
+ |**404** | Investment not found | - |
863
+
864
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
865
+
757
866
  # **patchImpactForOption**
758
867
  > ImpactAPIResponse patchImpactForOption(impactUpdate)
759
868
 
@@ -987,8 +1096,8 @@ const { status, data } = await apiInstance.postInvestment(
987
1096
 
988
1097
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
989
1098
 
990
- # **setFavoredOption**
991
- > FavoredOptionResponse setFavoredOption(favoredOptionRequest)
1099
+ # **setPreferredOption**
1100
+ > PreferredOptionResponse setPreferredOption(preferredOptionRequest)
992
1101
 
993
1102
  Set the preferred option for an investment.
994
1103
 
@@ -998,18 +1107,18 @@ Set the preferred option for an investment.
998
1107
  import {
999
1108
  InvestmentApi,
1000
1109
  Configuration,
1001
- FavoredOptionRequest
1110
+ PreferredOptionRequest
1002
1111
  } from '@cosmotech/aip-client';
1003
1112
 
1004
1113
  const configuration = new Configuration();
1005
1114
  const apiInstance = new InvestmentApi(configuration);
1006
1115
 
1007
1116
  let investmentId: string; //UUID of the investment (default to undefined)
1008
- let favoredOptionRequest: FavoredOptionRequest; //
1117
+ let preferredOptionRequest: PreferredOptionRequest; //
1009
1118
 
1010
- const { status, data } = await apiInstance.setFavoredOption(
1119
+ const { status, data } = await apiInstance.setPreferredOption(
1011
1120
  investmentId,
1012
- favoredOptionRequest
1121
+ preferredOptionRequest
1013
1122
  );
1014
1123
  ```
1015
1124
 
@@ -1017,13 +1126,13 @@ const { status, data } = await apiInstance.setFavoredOption(
1017
1126
 
1018
1127
  |Name | Type | Description | Notes|
1019
1128
  |------------- | ------------- | ------------- | -------------|
1020
- | **favoredOptionRequest** | **FavoredOptionRequest**| | |
1129
+ | **preferredOptionRequest** | **PreferredOptionRequest**| | |
1021
1130
  | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
1022
1131
 
1023
1132
 
1024
1133
  ### Return type
1025
1134
 
1026
- **FavoredOptionResponse**
1135
+ **PreferredOptionResponse**
1027
1136
 
1028
1137
  ### Authorization
1029
1138
 
@@ -0,0 +1,33 @@
1
+ # InvestmentOverviewResponse
2
+
3
+ Schema for the investment overview table — one row per investment.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **investmentId** | **string** | ID of the investment | [default to undefined]
10
+ **investmentName** | **string** | Name of the investment | [default to undefined]
11
+ **preferredOptionCost** | **number** | | [optional] [default to undefined]
12
+ **preferredOptionDuration** | **number** | | [optional] [default to undefined]
13
+ **preferredOptionName** | **string** | | [optional] [default to undefined]
14
+ **preferredOptionNpv** | **number** | | [optional] [default to undefined]
15
+ **preferredOptionStartDate** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { InvestmentOverviewResponse } from '@cosmotech/aip-client';
21
+
22
+ const instance: InvestmentOverviewResponse = {
23
+ investmentId,
24
+ investmentName,
25
+ preferredOptionCost,
26
+ preferredOptionDuration,
27
+ preferredOptionName,
28
+ preferredOptionNpv,
29
+ preferredOptionStartDate,
30
+ };
31
+ ```
32
+
33
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/OptionApi.md CHANGED
@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost*
13
13
  |[**getOptionForInvestment**](#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment|
14
14
  |[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework|
15
15
  |[**getOptionsForInvestment**](#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment|
16
+ |[**getOptionsOverview**](#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment|
16
17
  |[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
17
18
  |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
18
19
 
@@ -423,7 +424,7 @@ const { status, data } = await apiInstance.getOptionForInvestment(
423
424
  # **getOptionKpis**
424
425
  > Array<OptionChartKPIsYearly> getOptionKpis()
425
426
 
426
- Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
427
+ 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.
427
428
 
428
429
  ### Example
429
430
 
@@ -474,7 +475,7 @@ const { status, data } = await apiInstance.getOptionKpis(
474
475
  | Status code | Description | Response headers |
475
476
  |-------------|-------------|------------------|
476
477
  |**200** | The requested KPIs | - |
477
- |**404** | Investment, option or value framework not found | - |
478
+ |**404** | Investment, option, value framework, or phase not found | - |
478
479
 
479
480
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
480
481
 
@@ -536,6 +537,61 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
536
537
 
537
538
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
538
539
 
540
+ # **getOptionsOverview**
541
+ > Array<OptionOverviewResponse> getOptionsOverview()
542
+
543
+ 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.
544
+
545
+ ### Example
546
+
547
+ ```typescript
548
+ import {
549
+ OptionApi,
550
+ Configuration
551
+ } from '@cosmotech/aip-client';
552
+
553
+ const configuration = new Configuration();
554
+ const apiInstance = new OptionApi(configuration);
555
+
556
+ let investmentId: string; //UUID of the investment (default to undefined)
557
+ let valueFrameworkId: string; //UUID of the value framework (default to undefined)
558
+
559
+ const { status, data } = await apiInstance.getOptionsOverview(
560
+ investmentId,
561
+ valueFrameworkId
562
+ );
563
+ ```
564
+
565
+ ### Parameters
566
+
567
+ |Name | Type | Description | Notes|
568
+ |------------- | ------------- | ------------- | -------------|
569
+ | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
570
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
571
+
572
+
573
+ ### Return type
574
+
575
+ **Array<OptionOverviewResponse>**
576
+
577
+ ### Authorization
578
+
579
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
580
+
581
+ ### HTTP request headers
582
+
583
+ - **Content-Type**: Not defined
584
+ - **Accept**: application/json
585
+
586
+
587
+ ### HTTP response details
588
+ | Status code | Description | Response headers |
589
+ |-------------|-------------|------------------|
590
+ |**200** | Overview list of all options for the investment | - |
591
+ |**404** | Investment or value framework not found | - |
592
+
593
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
594
+
539
595
  # **patchImpactForOption**
540
596
  > ImpactAPIResponse patchImpactForOption(impactUpdate)
541
597
 
@@ -0,0 +1,31 @@
1
+ # OptionOverviewResponse
2
+
3
+ Schema for the option overview table — one row per option within an investment.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **cost** | **number** | Cost of the option | [default to undefined]
10
+ **duration** | **number** | Duration of the option in weeks | [default to undefined]
11
+ **npv** | **number** | | [optional] [default to undefined]
12
+ **optionId** | **string** | ID of the option | [default to undefined]
13
+ **optionName** | **string** | Name of the option | [default to undefined]
14
+ **startDate** | **string** | Expected start date of the option (ISO 8601) | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { OptionOverviewResponse } from '@cosmotech/aip-client';
20
+
21
+ const instance: OptionOverviewResponse = {
22
+ cost,
23
+ duration,
24
+ npv,
25
+ optionId,
26
+ optionName,
27
+ startDate,
28
+ };
29
+ ```
30
+
31
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,14 +1,14 @@
1
- # FavoredOptionApi
1
+ # PreferredOptionApi
2
2
 
3
3
  All URIs are relative to *http://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getFavoredOption**](#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment|
8
- |[**setFavoredOption**](#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment|
7
+ |[**getPreferredOption**](#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment|
8
+ |[**setPreferredOption**](#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment|
9
9
 
10
- # **getFavoredOption**
11
- > FavoredOptionResponse getFavoredOption()
10
+ # **getPreferredOption**
11
+ > PreferredOptionResponse getPreferredOption()
12
12
 
13
13
  Get the preferred option for an investment.
14
14
 
@@ -16,16 +16,16 @@ Get the preferred option for an investment.
16
16
 
17
17
  ```typescript
18
18
  import {
19
- FavoredOptionApi,
19
+ PreferredOptionApi,
20
20
  Configuration
21
21
  } from '@cosmotech/aip-client';
22
22
 
23
23
  const configuration = new Configuration();
24
- const apiInstance = new FavoredOptionApi(configuration);
24
+ const apiInstance = new PreferredOptionApi(configuration);
25
25
 
26
26
  let investmentId: string; //UUID of the investment (default to undefined)
27
27
 
28
- const { status, data } = await apiInstance.getFavoredOption(
28
+ const { status, data } = await apiInstance.getPreferredOption(
29
29
  investmentId
30
30
  );
31
31
  ```
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.getFavoredOption(
39
39
 
40
40
  ### Return type
41
41
 
42
- **FavoredOptionResponse**
42
+ **PreferredOptionResponse**
43
43
 
44
44
  ### Authorization
45
45
 
@@ -60,8 +60,8 @@ const { status, data } = await apiInstance.getFavoredOption(
60
60
 
61
61
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
62
62
 
63
- # **setFavoredOption**
64
- > FavoredOptionResponse setFavoredOption(favoredOptionRequest)
63
+ # **setPreferredOption**
64
+ > PreferredOptionResponse setPreferredOption(preferredOptionRequest)
65
65
 
66
66
  Set the preferred option for an investment.
67
67
 
@@ -69,20 +69,20 @@ Set the preferred option for an investment.
69
69
 
70
70
  ```typescript
71
71
  import {
72
- FavoredOptionApi,
72
+ PreferredOptionApi,
73
73
  Configuration,
74
- FavoredOptionRequest
74
+ PreferredOptionRequest
75
75
  } from '@cosmotech/aip-client';
76
76
 
77
77
  const configuration = new Configuration();
78
- const apiInstance = new FavoredOptionApi(configuration);
78
+ const apiInstance = new PreferredOptionApi(configuration);
79
79
 
80
80
  let investmentId: string; //UUID of the investment (default to undefined)
81
- let favoredOptionRequest: FavoredOptionRequest; //
81
+ let preferredOptionRequest: PreferredOptionRequest; //
82
82
 
83
- const { status, data } = await apiInstance.setFavoredOption(
83
+ const { status, data } = await apiInstance.setPreferredOption(
84
84
  investmentId,
85
- favoredOptionRequest
85
+ preferredOptionRequest
86
86
  );
87
87
  ```
88
88
 
@@ -90,13 +90,13 @@ const { status, data } = await apiInstance.setFavoredOption(
90
90
 
91
91
  |Name | Type | Description | Notes|
92
92
  |------------- | ------------- | ------------- | -------------|
93
- | **favoredOptionRequest** | **FavoredOptionRequest**| | |
93
+ | **preferredOptionRequest** | **PreferredOptionRequest**| | |
94
94
  | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
95
95
 
96
96
 
97
97
  ### Return type
98
98
 
99
- **FavoredOptionResponse**
99
+ **PreferredOptionResponse**
100
100
 
101
101
  ### Authorization
102
102
 
@@ -1,4 +1,4 @@
1
- # FavoredOptionRequest
1
+ # PreferredOptionRequest
2
2
 
3
3
  Request body for setting the preferred option.
4
4
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import { FavoredOptionRequest } from '@cosmotech/aip-client';
14
+ import { PreferredOptionRequest } from '@cosmotech/aip-client';
15
15
 
16
- const instance: FavoredOptionRequest = {
16
+ const instance: PreferredOptionRequest = {
17
17
  optionId,
18
18
  };
19
19
  ```
@@ -1,6 +1,6 @@
1
- # FavoredOptionResponse
1
+ # PreferredOptionResponse
2
2
 
3
- Response for favored option endpoints.
3
+ Response for preferred option endpoints.
4
4
 
5
5
  ## Properties
6
6
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import { FavoredOptionResponse } from '@cosmotech/aip-client';
14
+ import { PreferredOptionResponse } from '@cosmotech/aip-client';
15
15
 
16
- const instance: FavoredOptionResponse = {
16
+ const instance: PreferredOptionResponse = {
17
17
  optionId,
18
18
  };
19
19
  ```
package/index.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).
@@ -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).
@@ -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).