@cosmotech/aip-client 0.4.0-dev2 → 0.4.0-dev4

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 (493) hide show
  1. package/README.md +17 -9
  2. package/api/budget-api.ts +7 -7
  3. package/api/default-api.ts +1 -1
  4. package/api/impact-api.ts +1 -1
  5. package/api/investment-api.ts +13 -15
  6. package/api/metric-api.ts +1 -1
  7. package/api/metric-costs-api.ts +1 -1
  8. package/api/metric-costs-per-year-api.ts +1 -1
  9. package/api/objective-api.ts +1 -1
  10. package/api/objective-weight-api.ts +1 -1
  11. package/api/objective-weights-api.ts +1 -1
  12. package/api/option-api.ts +1 -1
  13. package/api/portfolio-api.ts +21 -20
  14. package/api/portfolio-investment-api.ts +83 -1
  15. package/api/portfolio-kpiapi.ts +308 -100
  16. package/api/preferred-option-api.ts +1 -1
  17. package/api/value-framework-api.ts +1 -1
  18. package/api/value-framework-costs-api.ts +1 -1
  19. package/api/value-framework-weights-api.ts +1 -1
  20. package/api.ts +1 -1
  21. package/base.ts +1 -1
  22. package/common.ts +1 -1
  23. package/configuration.ts +1 -1
  24. package/dist/api/budget-api.d.ts +7 -7
  25. package/dist/api/budget-api.js +5 -5
  26. package/dist/api/default-api.d.ts +1 -1
  27. package/dist/api/default-api.js +1 -1
  28. package/dist/api/impact-api.d.ts +1 -1
  29. package/dist/api/impact-api.js +1 -1
  30. package/dist/api/investment-api.d.ts +13 -13
  31. package/dist/api/investment-api.js +9 -11
  32. package/dist/api/metric-api.d.ts +1 -1
  33. package/dist/api/metric-api.js +1 -1
  34. package/dist/api/metric-costs-api.d.ts +1 -1
  35. package/dist/api/metric-costs-api.js +1 -1
  36. package/dist/api/metric-costs-per-year-api.d.ts +1 -1
  37. package/dist/api/metric-costs-per-year-api.js +1 -1
  38. package/dist/api/objective-api.d.ts +1 -1
  39. package/dist/api/objective-api.js +1 -1
  40. package/dist/api/objective-weight-api.d.ts +1 -1
  41. package/dist/api/objective-weight-api.js +1 -1
  42. package/dist/api/objective-weights-api.d.ts +1 -1
  43. package/dist/api/objective-weights-api.js +1 -1
  44. package/dist/api/option-api.d.ts +1 -1
  45. package/dist/api/option-api.js +1 -1
  46. package/dist/api/portfolio-api.d.ts +13 -13
  47. package/dist/api/portfolio-api.js +20 -20
  48. package/dist/api/portfolio-investment-api.d.ts +38 -1
  49. package/dist/api/portfolio-investment-api.js +77 -1
  50. package/dist/api/portfolio-kpiapi.d.ts +150 -61
  51. package/dist/api/portfolio-kpiapi.js +281 -88
  52. package/dist/api/preferred-option-api.d.ts +1 -1
  53. package/dist/api/preferred-option-api.js +1 -1
  54. package/dist/api/value-framework-api.d.ts +1 -1
  55. package/dist/api/value-framework-api.js +1 -1
  56. package/dist/api/value-framework-costs-api.d.ts +1 -1
  57. package/dist/api/value-framework-costs-api.js +1 -1
  58. package/dist/api/value-framework-weights-api.d.ts +1 -1
  59. package/dist/api/value-framework-weights-api.js +1 -1
  60. package/dist/api.d.ts +1 -1
  61. package/dist/api.js +1 -1
  62. package/dist/base.d.ts +1 -1
  63. package/dist/base.js +1 -1
  64. package/dist/common.d.ts +1 -1
  65. package/dist/common.js +1 -1
  66. package/dist/configuration.d.ts +1 -1
  67. package/dist/configuration.js +1 -1
  68. package/dist/esm/api/budget-api.d.ts +7 -7
  69. package/dist/esm/api/budget-api.js +5 -5
  70. package/dist/esm/api/default-api.d.ts +1 -1
  71. package/dist/esm/api/default-api.js +1 -1
  72. package/dist/esm/api/impact-api.d.ts +1 -1
  73. package/dist/esm/api/impact-api.js +1 -1
  74. package/dist/esm/api/investment-api.d.ts +13 -13
  75. package/dist/esm/api/investment-api.js +9 -11
  76. package/dist/esm/api/metric-api.d.ts +1 -1
  77. package/dist/esm/api/metric-api.js +1 -1
  78. package/dist/esm/api/metric-costs-api.d.ts +1 -1
  79. package/dist/esm/api/metric-costs-api.js +1 -1
  80. package/dist/esm/api/metric-costs-per-year-api.d.ts +1 -1
  81. package/dist/esm/api/metric-costs-per-year-api.js +1 -1
  82. package/dist/esm/api/objective-api.d.ts +1 -1
  83. package/dist/esm/api/objective-api.js +1 -1
  84. package/dist/esm/api/objective-weight-api.d.ts +1 -1
  85. package/dist/esm/api/objective-weight-api.js +1 -1
  86. package/dist/esm/api/objective-weights-api.d.ts +1 -1
  87. package/dist/esm/api/objective-weights-api.js +1 -1
  88. package/dist/esm/api/option-api.d.ts +1 -1
  89. package/dist/esm/api/option-api.js +1 -1
  90. package/dist/esm/api/portfolio-api.d.ts +13 -13
  91. package/dist/esm/api/portfolio-api.js +20 -20
  92. package/dist/esm/api/portfolio-investment-api.d.ts +38 -1
  93. package/dist/esm/api/portfolio-investment-api.js +77 -1
  94. package/dist/esm/api/portfolio-kpiapi.d.ts +150 -61
  95. package/dist/esm/api/portfolio-kpiapi.js +281 -88
  96. package/dist/esm/api/preferred-option-api.d.ts +1 -1
  97. package/dist/esm/api/preferred-option-api.js +1 -1
  98. package/dist/esm/api/value-framework-api.d.ts +1 -1
  99. package/dist/esm/api/value-framework-api.js +1 -1
  100. package/dist/esm/api/value-framework-costs-api.d.ts +1 -1
  101. package/dist/esm/api/value-framework-costs-api.js +1 -1
  102. package/dist/esm/api/value-framework-weights-api.d.ts +1 -1
  103. package/dist/esm/api/value-framework-weights-api.js +1 -1
  104. package/dist/esm/api.d.ts +1 -1
  105. package/dist/esm/api.js +1 -1
  106. package/dist/esm/base.d.ts +1 -1
  107. package/dist/esm/base.js +1 -1
  108. package/dist/esm/common.d.ts +1 -1
  109. package/dist/esm/common.js +1 -1
  110. package/dist/esm/configuration.d.ts +1 -1
  111. package/dist/esm/configuration.js +1 -1
  112. package/dist/esm/index.d.ts +1 -1
  113. package/dist/esm/index.js +1 -1
  114. package/dist/esm/models/budget-bulk-delete-request.d.ts +1 -1
  115. package/dist/esm/models/budget-bulk-delete-request.js +1 -1
  116. package/dist/esm/models/budget-create.d.ts +1 -1
  117. package/dist/esm/models/budget-create.js +1 -1
  118. package/dist/esm/models/budget-investment-response.d.ts +1 -1
  119. package/dist/esm/models/budget-investment-response.js +1 -1
  120. package/dist/esm/models/budget-link-options-request.d.ts +1 -1
  121. package/dist/esm/models/budget-link-options-request.js +1 -1
  122. package/dist/esm/models/budget-option-response.d.ts +2 -1
  123. package/dist/esm/models/budget-option-response.js +1 -1
  124. package/dist/esm/models/budget-overview-response.d.ts +1 -1
  125. package/dist/esm/models/budget-overview-response.js +1 -1
  126. package/dist/esm/models/budget-response.d.ts +1 -1
  127. package/dist/esm/models/budget-response.js +1 -1
  128. package/dist/esm/models/budget-update.d.ts +1 -1
  129. package/dist/esm/models/budget-update.js +1 -1
  130. package/dist/esm/models/bulk-delete-request.d.ts +1 -1
  131. package/dist/esm/models/bulk-delete-request.js +1 -1
  132. package/dist/esm/models/evolution-type.d.ts +1 -1
  133. package/dist/esm/models/evolution-type.js +1 -1
  134. package/dist/esm/models/httpvalidation-error.d.ts +1 -1
  135. package/dist/esm/models/httpvalidation-error.js +1 -1
  136. package/dist/esm/models/impact-apiresponse.d.ts +1 -1
  137. package/dist/esm/models/impact-apiresponse.js +1 -1
  138. package/dist/esm/models/impact-bulk-item.d.ts +1 -1
  139. package/dist/esm/models/impact-bulk-item.js +1 -1
  140. package/dist/esm/models/impact-create.d.ts +1 -1
  141. package/dist/esm/models/impact-create.js +1 -1
  142. package/dist/esm/models/impact-update.d.ts +1 -1
  143. package/dist/esm/models/impact-update.js +1 -1
  144. package/dist/esm/models/index.d.ts +4 -0
  145. package/dist/esm/models/index.js +4 -0
  146. package/dist/esm/models/investment-create.d.ts +1 -1
  147. package/dist/esm/models/investment-create.js +1 -1
  148. package/dist/esm/models/investment-overview-response.d.ts +1 -1
  149. package/dist/esm/models/investment-overview-response.js +1 -1
  150. package/dist/esm/models/investment-response.d.ts +1 -1
  151. package/dist/esm/models/investment-response.js +1 -1
  152. package/dist/esm/models/investment-update.d.ts +1 -1
  153. package/dist/esm/models/investment-update.js +1 -1
  154. package/dist/esm/models/location-inner.d.ts +1 -1
  155. package/dist/esm/models/location-inner.js +1 -1
  156. package/dist/esm/models/measurement-type.d.ts +1 -1
  157. package/dist/esm/models/measurement-type.js +1 -1
  158. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
  159. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  160. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
  161. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  162. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
  163. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  164. package/dist/esm/models/metric-create.d.ts +1 -1
  165. package/dist/esm/models/metric-create.js +1 -1
  166. package/dist/esm/models/metric-performance-response.d.ts +1 -1
  167. package/dist/esm/models/metric-performance-response.js +1 -1
  168. package/dist/esm/models/metric-performance-year.d.ts +1 -1
  169. package/dist/esm/models/metric-performance-year.js +1 -1
  170. package/dist/esm/models/metric-response.d.ts +1 -1
  171. package/dist/esm/models/metric-response.js +1 -1
  172. package/dist/esm/models/metric-type.d.ts +1 -1
  173. package/dist/esm/models/metric-type.js +1 -1
  174. package/dist/esm/models/metric-update.d.ts +1 -1
  175. package/dist/esm/models/metric-update.js +1 -1
  176. package/dist/esm/models/monetized-impact-detailed-response.d.ts +18 -0
  177. package/dist/esm/models/monetized-impact-detailed-response.js +14 -0
  178. package/dist/esm/models/monetized-impact-detailed-year.d.ts +20 -0
  179. package/dist/esm/models/monetized-impact-detailed-year.js +14 -0
  180. package/dist/esm/models/monetized-impact-metric-value.d.ts +19 -0
  181. package/dist/esm/models/monetized-impact-metric-value.js +14 -0
  182. package/dist/esm/models/monetized-impact-response.d.ts +1 -1
  183. package/dist/esm/models/monetized-impact-response.js +1 -1
  184. package/dist/esm/models/monetized-impact-year.d.ts +1 -1
  185. package/dist/esm/models/monetized-impact-year.js +1 -1
  186. package/dist/esm/models/objective-create.d.ts +1 -1
  187. package/dist/esm/models/objective-create.js +1 -1
  188. package/dist/esm/models/objective-response.d.ts +1 -1
  189. package/dist/esm/models/objective-response.js +1 -1
  190. package/dist/esm/models/objective-update.d.ts +1 -1
  191. package/dist/esm/models/objective-update.js +1 -1
  192. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  193. package/dist/esm/models/objective-weight-create.js +1 -1
  194. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  195. package/dist/esm/models/objective-weight-response.js +1 -1
  196. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  197. package/dist/esm/models/objective-weight-update.js +1 -1
  198. package/dist/esm/models/option-chart-kpi.d.ts +1 -1
  199. package/dist/esm/models/option-chart-kpi.js +1 -1
  200. package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
  201. package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
  202. package/dist/esm/models/option-create.d.ts +1 -1
  203. package/dist/esm/models/option-create.js +1 -1
  204. package/dist/esm/models/option-overview-response.d.ts +1 -1
  205. package/dist/esm/models/option-overview-response.js +1 -1
  206. package/dist/esm/models/option-response.d.ts +1 -1
  207. package/dist/esm/models/option-response.js +1 -1
  208. package/dist/esm/models/option-update.d.ts +1 -1
  209. package/dist/esm/models/option-update.js +1 -1
  210. package/dist/esm/models/portfolio-budget-expenditure-response.d.ts +1 -1
  211. package/dist/esm/models/portfolio-budget-expenditure-response.js +1 -1
  212. package/dist/esm/models/portfolio-budget-expenditure-year.d.ts +1 -1
  213. package/dist/esm/models/portfolio-budget-expenditure-year.js +1 -1
  214. package/dist/esm/models/portfolio-budget-usage-item.d.ts +1 -1
  215. package/dist/esm/models/portfolio-budget-usage-item.js +1 -1
  216. package/dist/esm/models/portfolio-bulk-delete-request.d.ts +1 -1
  217. package/dist/esm/models/portfolio-bulk-delete-request.js +1 -1
  218. package/dist/esm/models/portfolio-create.d.ts +1 -1
  219. package/dist/esm/models/portfolio-create.js +1 -1
  220. package/dist/esm/models/portfolio-investment-bulk-add-request.d.ts +1 -1
  221. package/dist/esm/models/portfolio-investment-bulk-add-request.js +1 -1
  222. package/dist/esm/models/portfolio-investment-bulk-add-response.d.ts +1 -1
  223. package/dist/esm/models/portfolio-investment-bulk-add-response.js +1 -1
  224. package/dist/esm/models/portfolio-investment-bulk-delete-request.d.ts +1 -1
  225. package/dist/esm/models/portfolio-investment-bulk-delete-request.js +1 -1
  226. package/dist/esm/models/portfolio-investment-overview-response.d.ts +30 -0
  227. package/dist/esm/models/portfolio-investment-overview-response.js +14 -0
  228. package/dist/esm/models/portfolio-investment-response.d.ts +1 -1
  229. package/dist/esm/models/portfolio-investment-response.js +1 -1
  230. package/dist/esm/models/portfolio-kpidistribution-budget-item.d.ts +1 -1
  231. package/dist/esm/models/portfolio-kpidistribution-budget-item.js +1 -1
  232. package/dist/esm/models/portfolio-kpidistribution-response.d.ts +2 -2
  233. package/dist/esm/models/portfolio-kpidistribution-response.js +1 -1
  234. package/dist/esm/models/portfolio-kpidistribution-year-overrun.d.ts +1 -1
  235. package/dist/esm/models/portfolio-kpidistribution-year-overrun.js +1 -1
  236. package/dist/esm/models/portfolio-kpidistribution-year-value.d.ts +1 -1
  237. package/dist/esm/models/portfolio-kpidistribution-year-value.js +1 -1
  238. package/dist/esm/models/portfolio-kpioverrun-distribution-response.d.ts +1 -1
  239. package/dist/esm/models/portfolio-kpioverrun-distribution-response.js +1 -1
  240. package/dist/esm/models/portfolio-kpiresponse.d.ts +1 -1
  241. package/dist/esm/models/portfolio-kpiresponse.js +1 -1
  242. package/dist/esm/models/portfolio-overview-item-response.d.ts +1 -1
  243. package/dist/esm/models/portfolio-overview-item-response.js +1 -1
  244. package/dist/esm/models/portfolio-response.d.ts +1 -1
  245. package/dist/esm/models/portfolio-response.js +1 -1
  246. package/dist/esm/models/portfolio-update.d.ts +1 -1
  247. package/dist/esm/models/portfolio-update.js +1 -1
  248. package/dist/esm/models/preferred-option-request.d.ts +1 -1
  249. package/dist/esm/models/preferred-option-request.js +1 -1
  250. package/dist/esm/models/preferred-option-response.d.ts +1 -1
  251. package/dist/esm/models/preferred-option-response.js +1 -1
  252. package/dist/esm/models/validation-error.d.ts +1 -1
  253. package/dist/esm/models/validation-error.js +1 -1
  254. package/dist/esm/models/value-framework-create.d.ts +1 -1
  255. package/dist/esm/models/value-framework-create.js +1 -1
  256. package/dist/esm/models/value-framework-response.d.ts +1 -1
  257. package/dist/esm/models/value-framework-response.js +1 -1
  258. package/dist/esm/models/value-framework-update.d.ts +1 -1
  259. package/dist/esm/models/value-framework-update.js +1 -1
  260. package/dist/index.d.ts +1 -1
  261. package/dist/index.js +1 -1
  262. package/dist/models/budget-bulk-delete-request.d.ts +1 -1
  263. package/dist/models/budget-bulk-delete-request.js +1 -1
  264. package/dist/models/budget-create.d.ts +1 -1
  265. package/dist/models/budget-create.js +1 -1
  266. package/dist/models/budget-investment-response.d.ts +1 -1
  267. package/dist/models/budget-investment-response.js +1 -1
  268. package/dist/models/budget-link-options-request.d.ts +1 -1
  269. package/dist/models/budget-link-options-request.js +1 -1
  270. package/dist/models/budget-option-response.d.ts +2 -1
  271. package/dist/models/budget-option-response.js +1 -1
  272. package/dist/models/budget-overview-response.d.ts +1 -1
  273. package/dist/models/budget-overview-response.js +1 -1
  274. package/dist/models/budget-response.d.ts +1 -1
  275. package/dist/models/budget-response.js +1 -1
  276. package/dist/models/budget-update.d.ts +1 -1
  277. package/dist/models/budget-update.js +1 -1
  278. package/dist/models/bulk-delete-request.d.ts +1 -1
  279. package/dist/models/bulk-delete-request.js +1 -1
  280. package/dist/models/evolution-type.d.ts +1 -1
  281. package/dist/models/evolution-type.js +1 -1
  282. package/dist/models/httpvalidation-error.d.ts +1 -1
  283. package/dist/models/httpvalidation-error.js +1 -1
  284. package/dist/models/impact-apiresponse.d.ts +1 -1
  285. package/dist/models/impact-apiresponse.js +1 -1
  286. package/dist/models/impact-bulk-item.d.ts +1 -1
  287. package/dist/models/impact-bulk-item.js +1 -1
  288. package/dist/models/impact-create.d.ts +1 -1
  289. package/dist/models/impact-create.js +1 -1
  290. package/dist/models/impact-update.d.ts +1 -1
  291. package/dist/models/impact-update.js +1 -1
  292. package/dist/models/index.d.ts +4 -0
  293. package/dist/models/index.js +4 -0
  294. package/dist/models/investment-create.d.ts +1 -1
  295. package/dist/models/investment-create.js +1 -1
  296. package/dist/models/investment-overview-response.d.ts +1 -1
  297. package/dist/models/investment-overview-response.js +1 -1
  298. package/dist/models/investment-response.d.ts +1 -1
  299. package/dist/models/investment-response.js +1 -1
  300. package/dist/models/investment-update.d.ts +1 -1
  301. package/dist/models/investment-update.js +1 -1
  302. package/dist/models/location-inner.d.ts +1 -1
  303. package/dist/models/location-inner.js +1 -1
  304. package/dist/models/measurement-type.d.ts +1 -1
  305. package/dist/models/measurement-type.js +1 -1
  306. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  307. package/dist/models/metric-costs-per-year-create.js +1 -1
  308. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  309. package/dist/models/metric-costs-per-year-response.js +1 -1
  310. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  311. package/dist/models/metric-costs-per-year-update.js +1 -1
  312. package/dist/models/metric-create.d.ts +1 -1
  313. package/dist/models/metric-create.js +1 -1
  314. package/dist/models/metric-performance-response.d.ts +1 -1
  315. package/dist/models/metric-performance-response.js +1 -1
  316. package/dist/models/metric-performance-year.d.ts +1 -1
  317. package/dist/models/metric-performance-year.js +1 -1
  318. package/dist/models/metric-response.d.ts +1 -1
  319. package/dist/models/metric-response.js +1 -1
  320. package/dist/models/metric-type.d.ts +1 -1
  321. package/dist/models/metric-type.js +1 -1
  322. package/dist/models/metric-update.d.ts +1 -1
  323. package/dist/models/metric-update.js +1 -1
  324. package/dist/models/monetized-impact-detailed-response.d.ts +18 -0
  325. package/dist/models/monetized-impact-detailed-response.js +15 -0
  326. package/dist/models/monetized-impact-detailed-year.d.ts +20 -0
  327. package/dist/models/monetized-impact-detailed-year.js +15 -0
  328. package/dist/models/monetized-impact-metric-value.d.ts +19 -0
  329. package/dist/models/monetized-impact-metric-value.js +15 -0
  330. package/dist/models/monetized-impact-response.d.ts +1 -1
  331. package/dist/models/monetized-impact-response.js +1 -1
  332. package/dist/models/monetized-impact-year.d.ts +1 -1
  333. package/dist/models/monetized-impact-year.js +1 -1
  334. package/dist/models/objective-create.d.ts +1 -1
  335. package/dist/models/objective-create.js +1 -1
  336. package/dist/models/objective-response.d.ts +1 -1
  337. package/dist/models/objective-response.js +1 -1
  338. package/dist/models/objective-update.d.ts +1 -1
  339. package/dist/models/objective-update.js +1 -1
  340. package/dist/models/objective-weight-create.d.ts +1 -1
  341. package/dist/models/objective-weight-create.js +1 -1
  342. package/dist/models/objective-weight-response.d.ts +1 -1
  343. package/dist/models/objective-weight-response.js +1 -1
  344. package/dist/models/objective-weight-update.d.ts +1 -1
  345. package/dist/models/objective-weight-update.js +1 -1
  346. package/dist/models/option-chart-kpi.d.ts +1 -1
  347. package/dist/models/option-chart-kpi.js +1 -1
  348. package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
  349. package/dist/models/option-chart-kpis-yearly.js +1 -1
  350. package/dist/models/option-create.d.ts +1 -1
  351. package/dist/models/option-create.js +1 -1
  352. package/dist/models/option-overview-response.d.ts +1 -1
  353. package/dist/models/option-overview-response.js +1 -1
  354. package/dist/models/option-response.d.ts +1 -1
  355. package/dist/models/option-response.js +1 -1
  356. package/dist/models/option-update.d.ts +1 -1
  357. package/dist/models/option-update.js +1 -1
  358. package/dist/models/portfolio-budget-expenditure-response.d.ts +1 -1
  359. package/dist/models/portfolio-budget-expenditure-response.js +1 -1
  360. package/dist/models/portfolio-budget-expenditure-year.d.ts +1 -1
  361. package/dist/models/portfolio-budget-expenditure-year.js +1 -1
  362. package/dist/models/portfolio-budget-usage-item.d.ts +1 -1
  363. package/dist/models/portfolio-budget-usage-item.js +1 -1
  364. package/dist/models/portfolio-bulk-delete-request.d.ts +1 -1
  365. package/dist/models/portfolio-bulk-delete-request.js +1 -1
  366. package/dist/models/portfolio-create.d.ts +1 -1
  367. package/dist/models/portfolio-create.js +1 -1
  368. package/dist/models/portfolio-investment-bulk-add-request.d.ts +1 -1
  369. package/dist/models/portfolio-investment-bulk-add-request.js +1 -1
  370. package/dist/models/portfolio-investment-bulk-add-response.d.ts +1 -1
  371. package/dist/models/portfolio-investment-bulk-add-response.js +1 -1
  372. package/dist/models/portfolio-investment-bulk-delete-request.d.ts +1 -1
  373. package/dist/models/portfolio-investment-bulk-delete-request.js +1 -1
  374. package/dist/models/portfolio-investment-overview-response.d.ts +30 -0
  375. package/dist/models/portfolio-investment-overview-response.js +15 -0
  376. package/dist/models/portfolio-investment-response.d.ts +1 -1
  377. package/dist/models/portfolio-investment-response.js +1 -1
  378. package/dist/models/portfolio-kpidistribution-budget-item.d.ts +1 -1
  379. package/dist/models/portfolio-kpidistribution-budget-item.js +1 -1
  380. package/dist/models/portfolio-kpidistribution-response.d.ts +2 -2
  381. package/dist/models/portfolio-kpidistribution-response.js +1 -1
  382. package/dist/models/portfolio-kpidistribution-year-overrun.d.ts +1 -1
  383. package/dist/models/portfolio-kpidistribution-year-overrun.js +1 -1
  384. package/dist/models/portfolio-kpidistribution-year-value.d.ts +1 -1
  385. package/dist/models/portfolio-kpidistribution-year-value.js +1 -1
  386. package/dist/models/portfolio-kpioverrun-distribution-response.d.ts +1 -1
  387. package/dist/models/portfolio-kpioverrun-distribution-response.js +1 -1
  388. package/dist/models/portfolio-kpiresponse.d.ts +1 -1
  389. package/dist/models/portfolio-kpiresponse.js +1 -1
  390. package/dist/models/portfolio-overview-item-response.d.ts +1 -1
  391. package/dist/models/portfolio-overview-item-response.js +1 -1
  392. package/dist/models/portfolio-response.d.ts +1 -1
  393. package/dist/models/portfolio-response.js +1 -1
  394. package/dist/models/portfolio-update.d.ts +1 -1
  395. package/dist/models/portfolio-update.js +1 -1
  396. package/dist/models/preferred-option-request.d.ts +1 -1
  397. package/dist/models/preferred-option-request.js +1 -1
  398. package/dist/models/preferred-option-response.d.ts +1 -1
  399. package/dist/models/preferred-option-response.js +1 -1
  400. package/dist/models/validation-error.d.ts +1 -1
  401. package/dist/models/validation-error.js +1 -1
  402. package/dist/models/value-framework-create.d.ts +1 -1
  403. package/dist/models/value-framework-create.js +1 -1
  404. package/dist/models/value-framework-response.d.ts +1 -1
  405. package/dist/models/value-framework-response.js +1 -1
  406. package/dist/models/value-framework-update.d.ts +1 -1
  407. package/dist/models/value-framework-update.js +1 -1
  408. package/docs/BudgetApi.md +3 -3
  409. package/docs/BudgetOptionResponse.md +2 -0
  410. package/docs/InvestmentApi.md +3 -3
  411. package/docs/MonetizedImpactDetailedResponse.md +21 -0
  412. package/docs/MonetizedImpactDetailedYear.md +25 -0
  413. package/docs/MonetizedImpactMetricValue.md +25 -0
  414. package/docs/PortfolioApi.md +7 -7
  415. package/docs/PortfolioInvestmentApi.md +56 -0
  416. package/docs/PortfolioInvestmentOverviewResponse.md +35 -0
  417. package/docs/PortfolioKPIApi.md +183 -30
  418. package/docs/PortfolioKPIDistributionResponse.md +1 -1
  419. package/index.ts +1 -1
  420. package/models/budget-bulk-delete-request.ts +1 -1
  421. package/models/budget-create.ts +1 -1
  422. package/models/budget-investment-response.ts +1 -1
  423. package/models/budget-link-options-request.ts +1 -1
  424. package/models/budget-option-response.ts +2 -1
  425. package/models/budget-overview-response.ts +1 -1
  426. package/models/budget-response.ts +1 -1
  427. package/models/budget-update.ts +1 -1
  428. package/models/bulk-delete-request.ts +1 -1
  429. package/models/evolution-type.ts +1 -1
  430. package/models/httpvalidation-error.ts +1 -1
  431. package/models/impact-apiresponse.ts +1 -1
  432. package/models/impact-bulk-item.ts +1 -1
  433. package/models/impact-create.ts +1 -1
  434. package/models/impact-update.ts +1 -1
  435. package/models/index.ts +4 -0
  436. package/models/investment-create.ts +1 -1
  437. package/models/investment-overview-response.ts +1 -1
  438. package/models/investment-response.ts +1 -1
  439. package/models/investment-update.ts +1 -1
  440. package/models/location-inner.ts +1 -1
  441. package/models/measurement-type.ts +1 -1
  442. package/models/metric-costs-per-year-create.ts +1 -1
  443. package/models/metric-costs-per-year-response.ts +1 -1
  444. package/models/metric-costs-per-year-update.ts +1 -1
  445. package/models/metric-create.ts +1 -1
  446. package/models/metric-performance-response.ts +1 -1
  447. package/models/metric-performance-year.ts +1 -1
  448. package/models/metric-response.ts +1 -1
  449. package/models/metric-type.ts +1 -1
  450. package/models/metric-update.ts +1 -1
  451. package/models/monetized-impact-detailed-response.ts +26 -0
  452. package/models/monetized-impact-detailed-year.ts +28 -0
  453. package/models/monetized-impact-metric-value.ts +25 -0
  454. package/models/monetized-impact-response.ts +1 -1
  455. package/models/monetized-impact-year.ts +1 -1
  456. package/models/objective-create.ts +1 -1
  457. package/models/objective-response.ts +1 -1
  458. package/models/objective-update.ts +1 -1
  459. package/models/objective-weight-create.ts +1 -1
  460. package/models/objective-weight-response.ts +1 -1
  461. package/models/objective-weight-update.ts +1 -1
  462. package/models/option-chart-kpi.ts +1 -1
  463. package/models/option-chart-kpis-yearly.ts +1 -1
  464. package/models/option-create.ts +1 -1
  465. package/models/option-overview-response.ts +1 -1
  466. package/models/option-response.ts +1 -1
  467. package/models/option-update.ts +1 -1
  468. package/models/portfolio-budget-expenditure-response.ts +1 -1
  469. package/models/portfolio-budget-expenditure-year.ts +1 -1
  470. package/models/portfolio-budget-usage-item.ts +1 -1
  471. package/models/portfolio-bulk-delete-request.ts +1 -1
  472. package/models/portfolio-create.ts +1 -1
  473. package/models/portfolio-investment-bulk-add-request.ts +1 -1
  474. package/models/portfolio-investment-bulk-add-response.ts +1 -1
  475. package/models/portfolio-investment-bulk-delete-request.ts +1 -1
  476. package/models/portfolio-investment-overview-response.ts +36 -0
  477. package/models/portfolio-investment-response.ts +1 -1
  478. package/models/portfolio-kpidistribution-budget-item.ts +1 -1
  479. package/models/portfolio-kpidistribution-response.ts +2 -2
  480. package/models/portfolio-kpidistribution-year-overrun.ts +1 -1
  481. package/models/portfolio-kpidistribution-year-value.ts +1 -1
  482. package/models/portfolio-kpioverrun-distribution-response.ts +1 -1
  483. package/models/portfolio-kpiresponse.ts +1 -1
  484. package/models/portfolio-overview-item-response.ts +1 -1
  485. package/models/portfolio-response.ts +1 -1
  486. package/models/portfolio-update.ts +1 -1
  487. package/models/preferred-option-request.ts +1 -1
  488. package/models/preferred-option-response.ts +1 -1
  489. package/models/validation-error.ts +1 -1
  490. package/models/value-framework-create.ts +1 -1
  491. package/models/value-framework-response.ts +1 -1
  492. package/models/value-framework-update.ts +1 -1
  493. package/package.json +1 -1
@@ -4,15 +4,18 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getCapexDistribution**](#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution | CAPEX year-by-year distribution|
8
- |[**getInvestmentsDistribution**](#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution | Investment count year-by-year distribution|
9
- |[**getKpiOverrunDistribution**](#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution | Budget overrun year-by-year distribution|
10
- |[**getNpvDistribution**](#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution | NPV year-by-year distribution|
7
+ |[**getCapexDistribution**](#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/capex-distribution | CAPEX year-by-year distribution|
8
+ |[**getInvestmentsDistribution**](#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/investments-distribution | Investment count year-by-year distribution|
9
+ |[**getKpiOverrunDistribution**](#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/overrun-distribution | Budget overrun year-by-year distribution|
10
+ |[**getNpvDistribution**](#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/npv-distribution | NPV year-by-year distribution|
11
11
  |[**getPortfolioBudgetExpenditure**](#getportfoliobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure|
12
+ |[**getPortfolioBudgetExpenditureAll**](#getportfoliobudgetexpenditureall) | **GET** /portfolio/{portfolio_id}/budget-expenditure-all | Budget year-by-year expenditure for all budgets|
13
+ |[**getPortfolioBudgetExpenditureNoBudget**](#getportfoliobudgetexpenditurenobudget) | **GET** /portfolio/{portfolio_id}/budget-expenditure-no-budget | Year-by-year expenditure for options with no budget|
12
14
  |[**getPortfolioBudgetUsage**](#getportfoliobudgetusage) | **GET** /portfolio/{portfolio_id}/budget-usage | Budget usage summary|
13
- |[**getPortfolioKpis**](#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id} | Get portfolio KPIs|
15
+ |[**getPortfolioKpis**](#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis | Get portfolio KPIs|
14
16
  |[**getPortfolioMetricPerformance**](#getportfoliometricperformance) | **GET** /portfolio/{portfolio_id}/metric-performance/{metric_id} | Metric performance over time|
15
- |[**getPortfolioMonetizedImpact**](#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact/{value_framework_id} | Portfolio monetized impact over time|
17
+ |[**getPortfolioMonetizedImpact**](#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact | Portfolio monetized impact over time|
18
+ |[**getPortfolioMonetizedImpactDetailed**](#getportfoliomonetizedimpactdetailed) | **GET** /portfolio/{portfolio_id}/monetized-impact/detailed | Portfolio monetized impact over time (split by metric)|
16
19
 
17
20
  # **getCapexDistribution**
18
21
  > PortfolioKPIDistributionResponse getCapexDistribution()
@@ -31,11 +34,9 @@ const configuration = new Configuration();
31
34
  const apiInstance = new PortfolioKPIApi(configuration);
32
35
 
33
36
  let portfolioId: string; //UUID of the portfolio (default to undefined)
34
- let valueFrameworkId: string; //UUID of the value framework (default to undefined)
35
37
 
36
38
  const { status, data } = await apiInstance.getCapexDistribution(
37
- portfolioId,
38
- valueFrameworkId
39
+ portfolioId
39
40
  );
40
41
  ```
41
42
 
@@ -44,7 +45,6 @@ const { status, data } = await apiInstance.getCapexDistribution(
44
45
  |Name | Type | Description | Notes|
45
46
  |------------- | ------------- | ------------- | -------------|
46
47
  | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
47
- | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
48
48
 
49
49
 
50
50
  ### Return type
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.getCapexDistribution(
65
65
  | Status code | Description | Response headers |
66
66
  |-------------|-------------|------------------|
67
67
  |**200** | Year-by-year CAPEX breakdown | - |
68
- |**404** | Portfolio or value framework not found | - |
68
+ |**404** | Portfolio not found | - |
69
69
 
70
70
  [[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)
71
71
 
@@ -86,11 +86,9 @@ const configuration = new Configuration();
86
86
  const apiInstance = new PortfolioKPIApi(configuration);
87
87
 
88
88
  let portfolioId: string; //UUID of the portfolio (default to undefined)
89
- let valueFrameworkId: string; //UUID of the value framework (default to undefined)
90
89
 
91
90
  const { status, data } = await apiInstance.getInvestmentsDistribution(
92
- portfolioId,
93
- valueFrameworkId
91
+ portfolioId
94
92
  );
95
93
  ```
96
94
 
@@ -99,7 +97,6 @@ const { status, data } = await apiInstance.getInvestmentsDistribution(
99
97
  |Name | Type | Description | Notes|
100
98
  |------------- | ------------- | ------------- | -------------|
101
99
  | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
102
- | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
103
100
 
104
101
 
105
102
  ### Return type
@@ -120,7 +117,7 @@ const { status, data } = await apiInstance.getInvestmentsDistribution(
120
117
  | Status code | Description | Response headers |
121
118
  |-------------|-------------|------------------|
122
119
  |**200** | Year-by-year investment count | - |
123
- |**404** | Portfolio or value framework not found | - |
120
+ |**404** | Portfolio not found | - |
124
121
 
125
122
  [[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)
126
123
 
@@ -141,11 +138,9 @@ const configuration = new Configuration();
141
138
  const apiInstance = new PortfolioKPIApi(configuration);
142
139
 
143
140
  let portfolioId: string; //UUID of the portfolio (default to undefined)
144
- let valueFrameworkId: string; //UUID of the value framework (default to undefined)
145
141
 
146
142
  const { status, data } = await apiInstance.getKpiOverrunDistribution(
147
- portfolioId,
148
- valueFrameworkId
143
+ portfolioId
149
144
  );
150
145
  ```
151
146
 
@@ -154,7 +149,6 @@ const { status, data } = await apiInstance.getKpiOverrunDistribution(
154
149
  |Name | Type | Description | Notes|
155
150
  |------------- | ------------- | ------------- | -------------|
156
151
  | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
157
- | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
158
152
 
159
153
 
160
154
  ### Return type
@@ -175,14 +169,14 @@ const { status, data } = await apiInstance.getKpiOverrunDistribution(
175
169
  | Status code | Description | Response headers |
176
170
  |-------------|-------------|------------------|
177
171
  |**200** | Year-by-year budget overrun breakdown | - |
178
- |**404** | Portfolio or value framework not found | - |
172
+ |**404** | Portfolio not found | - |
179
173
 
180
174
  [[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)
181
175
 
182
176
  # **getNpvDistribution**
183
177
  > PortfolioKPIDistributionResponse getNpvDistribution()
184
178
 
185
- Sum of final NPV of preferred options starting each year.
179
+ Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
186
180
 
187
181
  ### Example
188
182
 
@@ -196,7 +190,7 @@ const configuration = new Configuration();
196
190
  const apiInstance = new PortfolioKPIApi(configuration);
197
191
 
198
192
  let portfolioId: string; //UUID of the portfolio (default to undefined)
199
- let valueFrameworkId: string; //UUID of the value framework (default to undefined)
193
+ let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
200
194
 
201
195
  const { status, data } = await apiInstance.getNpvDistribution(
202
196
  portfolioId,
@@ -209,7 +203,7 @@ const { status, data } = await apiInstance.getNpvDistribution(
209
203
  |Name | Type | Description | Notes|
210
204
  |------------- | ------------- | ------------- | -------------|
211
205
  | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
212
- | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
206
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
213
207
 
214
208
 
215
209
  ### Return type
@@ -289,6 +283,110 @@ const { status, data } = await apiInstance.getPortfolioBudgetExpenditure(
289
283
 
290
284
  [[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)
291
285
 
286
+ # **getPortfolioBudgetExpenditureAll**
287
+ > Array<PortfolioBudgetExpenditureResponse> getPortfolioBudgetExpenditureAll()
288
+
289
+ Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
290
+
291
+ ### Example
292
+
293
+ ```typescript
294
+ import {
295
+ PortfolioKPIApi,
296
+ Configuration
297
+ } from '@cosmotech/aip-client';
298
+
299
+ const configuration = new Configuration();
300
+ const apiInstance = new PortfolioKPIApi(configuration);
301
+
302
+ let portfolioId: string; //UUID of the portfolio (default to undefined)
303
+
304
+ const { status, data } = await apiInstance.getPortfolioBudgetExpenditureAll(
305
+ portfolioId
306
+ );
307
+ ```
308
+
309
+ ### Parameters
310
+
311
+ |Name | Type | Description | Notes|
312
+ |------------- | ------------- | ------------- | -------------|
313
+ | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
314
+
315
+
316
+ ### Return type
317
+
318
+ **Array<PortfolioBudgetExpenditureResponse>**
319
+
320
+ ### Authorization
321
+
322
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
323
+
324
+ ### HTTP request headers
325
+
326
+ - **Content-Type**: Not defined
327
+ - **Accept**: application/json
328
+
329
+
330
+ ### HTTP response details
331
+ | Status code | Description | Response headers |
332
+ |-------------|-------------|------------------|
333
+ |**200** | Budget expenditure over time for all budgets | - |
334
+ |**404** | Portfolio not found | - |
335
+
336
+ [[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)
337
+
338
+ # **getPortfolioBudgetExpenditureNoBudget**
339
+ > PortfolioBudgetExpenditureResponse getPortfolioBudgetExpenditureNoBudget()
340
+
341
+ Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
342
+
343
+ ### Example
344
+
345
+ ```typescript
346
+ import {
347
+ PortfolioKPIApi,
348
+ Configuration
349
+ } from '@cosmotech/aip-client';
350
+
351
+ const configuration = new Configuration();
352
+ const apiInstance = new PortfolioKPIApi(configuration);
353
+
354
+ let portfolioId: string; //UUID of the portfolio (default to undefined)
355
+
356
+ const { status, data } = await apiInstance.getPortfolioBudgetExpenditureNoBudget(
357
+ portfolioId
358
+ );
359
+ ```
360
+
361
+ ### Parameters
362
+
363
+ |Name | Type | Description | Notes|
364
+ |------------- | ------------- | ------------- | -------------|
365
+ | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
366
+
367
+
368
+ ### Return type
369
+
370
+ **PortfolioBudgetExpenditureResponse**
371
+
372
+ ### Authorization
373
+
374
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: Not defined
379
+ - **Accept**: application/json
380
+
381
+
382
+ ### HTTP response details
383
+ | Status code | Description | Response headers |
384
+ |-------------|-------------|------------------|
385
+ |**200** | Expenditure over time for unbudgeted options | - |
386
+ |**404** | Portfolio not found | - |
387
+
388
+ [[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)
389
+
292
390
  # **getPortfolioBudgetUsage**
293
391
  > Array<PortfolioBudgetUsageItem> getPortfolioBudgetUsage()
294
392
 
@@ -344,7 +442,7 @@ const { status, data } = await apiInstance.getPortfolioBudgetUsage(
344
442
  # **getPortfolioKpis**
345
443
  > PortfolioKPIResponse getPortfolioKpis()
346
444
 
347
- Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
445
+ Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio. NPV is only computed when value_framework_id is provided; otherwise it is null.
348
446
 
349
447
  ### Example
350
448
 
@@ -358,7 +456,7 @@ const configuration = new Configuration();
358
456
  const apiInstance = new PortfolioKPIApi(configuration);
359
457
 
360
458
  let portfolioId: string; //UUID of the portfolio (default to undefined)
361
- let valueFrameworkId: string; //UUID of the value framework (default to undefined)
459
+ let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
362
460
 
363
461
  const { status, data } = await apiInstance.getPortfolioKpis(
364
462
  portfolioId,
@@ -371,7 +469,7 @@ const { status, data } = await apiInstance.getPortfolioKpis(
371
469
  |Name | Type | Description | Notes|
372
470
  |------------- | ------------- | ------------- | -------------|
373
471
  | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
374
- | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
472
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
375
473
 
376
474
 
377
475
  ### Return type
@@ -454,7 +552,7 @@ const { status, data } = await apiInstance.getPortfolioMetricPerformance(
454
552
  # **getPortfolioMonetizedImpact**
455
553
  > MonetizedImpactResponse getPortfolioMonetizedImpact()
456
554
 
457
- Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
555
+ Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
458
556
 
459
557
  ### Example
460
558
 
@@ -468,7 +566,7 @@ const configuration = new Configuration();
468
566
  const apiInstance = new PortfolioKPIApi(configuration);
469
567
 
470
568
  let portfolioId: string; //UUID of the portfolio (default to undefined)
471
- let valueFrameworkId: string; //UUID of the value framework (default to undefined)
569
+ let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
472
570
 
473
571
  const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
474
572
  portfolioId,
@@ -481,7 +579,7 @@ const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
481
579
  |Name | Type | Description | Notes|
482
580
  |------------- | ------------- | ------------- | -------------|
483
581
  | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
484
- | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
582
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
485
583
 
486
584
 
487
585
  ### Return type
@@ -506,3 +604,58 @@ const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
506
604
 
507
605
  [[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)
508
606
 
607
+ # **getPortfolioMonetizedImpactDetailed**
608
+ > MonetizedImpactDetailedResponse getPortfolioMonetizedImpactDetailed()
609
+
610
+ Return year-by-year monetized impact split by individual metric and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
611
+
612
+ ### Example
613
+
614
+ ```typescript
615
+ import {
616
+ PortfolioKPIApi,
617
+ Configuration
618
+ } from '@cosmotech/aip-client';
619
+
620
+ const configuration = new Configuration();
621
+ const apiInstance = new PortfolioKPIApi(configuration);
622
+
623
+ let portfolioId: string; //UUID of the portfolio (default to undefined)
624
+ let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
625
+
626
+ const { status, data } = await apiInstance.getPortfolioMonetizedImpactDetailed(
627
+ portfolioId,
628
+ valueFrameworkId
629
+ );
630
+ ```
631
+
632
+ ### Parameters
633
+
634
+ |Name | Type | Description | Notes|
635
+ |------------- | ------------- | ------------- | -------------|
636
+ | **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
637
+ | **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
638
+
639
+
640
+ ### Return type
641
+
642
+ **MonetizedImpactDetailedResponse**
643
+
644
+ ### Authorization
645
+
646
+ [OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
647
+
648
+ ### HTTP request headers
649
+
650
+ - **Content-Type**: Not defined
651
+ - **Accept**: application/json
652
+
653
+
654
+ ### HTTP response details
655
+ | Status code | Description | Response headers |
656
+ |-------------|-------------|------------------|
657
+ |**200** | Detailed monetized impact data | - |
658
+ |**404** | Portfolio or value framework not found | - |
659
+
660
+ [[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)
661
+
@@ -7,7 +7,7 @@ Response for the KPI distribution endpoint (investments / capex / npv).
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **data** | [**Array&lt;PortfolioKPIDistributionYearValue&gt;**](PortfolioKPIDistributionYearValue.md) | | [default to undefined]
10
- **kpi** | **string** | | [default to undefined]
10
+ **kpi** | **string** | | [optional] [default to undefined]
11
11
  **unit** | **string** | | [optional] [default to undefined]
12
12
 
13
13
  ## Example
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,6 +18,7 @@
18
18
  * Schema for one row in the \'Options using budget\' tab on the budget detail page.
19
19
  */
20
20
  export interface BudgetOptionResponse {
21
+ 'budget_id'?: string | null;
21
22
  /**
22
23
  * Total investment cost of the option
23
24
  */
@@ -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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/models/index.ts CHANGED
@@ -28,6 +28,9 @@ export * from './metric-performance-year';
28
28
  export * from './metric-response';
29
29
  export * from './metric-type';
30
30
  export * from './metric-update';
31
+ export * from './monetized-impact-detailed-response';
32
+ export * from './monetized-impact-detailed-year';
33
+ export * from './monetized-impact-metric-value';
31
34
  export * from './monetized-impact-response';
32
35
  export * from './monetized-impact-year';
33
36
  export * from './objective-create';
@@ -50,6 +53,7 @@ export * from './portfolio-create';
50
53
  export * from './portfolio-investment-bulk-add-request';
51
54
  export * from './portfolio-investment-bulk-add-response';
52
55
  export * from './portfolio-investment-bulk-delete-request';
56
+ export * from './portfolio-investment-overview-response';
53
57
  export * from './portfolio-investment-response';
54
58
  export * from './portfolio-kpidistribution-budget-item';
55
59
  export * from './portfolio-kpidistribution-response';
@@ -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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
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.4.0-dev2
7
+ * The version of the OpenAPI document: 0.4.0-dev4
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).