@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
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.4.0-dev2
5
+ * The version of the OpenAPI document: 0.4.0-dev4
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,7 @@ import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { MetricPerformanceResponse } from '../models';
16
+ import type { MonetizedImpactDetailedResponse } from '../models';
16
17
  import type { MonetizedImpactResponse } from '../models';
17
18
  import type { PortfolioBudgetExpenditureResponse } from '../models';
18
19
  import type { PortfolioBudgetUsageItem } from '../models';
@@ -27,38 +28,35 @@ export declare const PortfolioKPIApiAxiosParamCreator: (configuration?: Configur
27
28
  * Total cost of preferred options starting each year.
28
29
  * @summary CAPEX year-by-year distribution
29
30
  * @param {string} portfolioId UUID of the portfolio
30
- * @param {string} valueFrameworkId UUID of the value framework
31
31
  * @param {*} [options] Override http request option.
32
32
  * @throws {RequiredError}
33
33
  */
34
- getCapexDistribution: (portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
34
+ getCapexDistribution: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
36
  * Count of investments with a preferred option starting each year.
37
37
  * @summary Investment count year-by-year distribution
38
38
  * @param {string} portfolioId UUID of the portfolio
39
- * @param {string} valueFrameworkId UUID of the value framework
40
39
  * @param {*} [options] Override http request option.
41
40
  * @throws {RequiredError}
42
41
  */
43
- getInvestmentsDistribution: (portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
42
+ getInvestmentsDistribution: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
43
  /**
45
44
  * Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
46
45
  * @summary Budget overrun year-by-year distribution
47
46
  * @param {string} portfolioId UUID of the portfolio
48
- * @param {string} valueFrameworkId UUID of the value framework
49
47
  * @param {*} [options] Override http request option.
50
48
  * @throws {RequiredError}
51
49
  */
52
- getKpiOverrunDistribution: (portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50
+ getKpiOverrunDistribution: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53
51
  /**
54
- * Sum of final NPV of preferred options starting each year.
52
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
55
53
  * @summary NPV year-by-year distribution
56
54
  * @param {string} portfolioId UUID of the portfolio
57
- * @param {string} valueFrameworkId UUID of the value framework
55
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
58
56
  * @param {*} [options] Override http request option.
59
57
  * @throws {RequiredError}
60
58
  */
61
- getNpvDistribution: (portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
59
+ getNpvDistribution: (portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
62
60
  /**
63
61
  * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
64
62
  * @summary Budget year-by-year expenditure
@@ -68,6 +66,22 @@ export declare const PortfolioKPIApiAxiosParamCreator: (configuration?: Configur
68
66
  * @throws {RequiredError}
69
67
  */
70
68
  getPortfolioBudgetExpenditure: (portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
69
+ /**
70
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
71
+ * @summary Budget year-by-year expenditure for all budgets
72
+ * @param {string} portfolioId UUID of the portfolio
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ getPortfolioBudgetExpenditureAll: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
77
+ /**
78
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
79
+ * @summary Year-by-year expenditure for options with no budget
80
+ * @param {string} portfolioId UUID of the portfolio
81
+ * @param {*} [options] Override http request option.
82
+ * @throws {RequiredError}
83
+ */
84
+ getPortfolioBudgetExpenditureNoBudget: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
71
85
  /**
72
86
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
73
87
  * @summary Budget usage summary
@@ -77,14 +91,14 @@ export declare const PortfolioKPIApiAxiosParamCreator: (configuration?: Configur
77
91
  */
78
92
  getPortfolioBudgetUsage: (portfolioId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
79
93
  /**
80
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
94
+ * 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.
81
95
  * @summary Get portfolio KPIs
82
96
  * @param {string} portfolioId UUID of the portfolio
83
- * @param {string} valueFrameworkId UUID of the value framework
97
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
84
98
  * @param {*} [options] Override http request option.
85
99
  * @throws {RequiredError}
86
100
  */
87
- getPortfolioKpis: (portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
101
+ getPortfolioKpis: (portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
88
102
  /**
89
103
  * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
90
104
  * @summary Metric performance over time
@@ -95,14 +109,23 @@ export declare const PortfolioKPIApiAxiosParamCreator: (configuration?: Configur
95
109
  */
96
110
  getPortfolioMetricPerformance: (portfolioId: string, metricId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
97
111
  /**
98
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
112
+ * 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.
99
113
  * @summary Portfolio monetized impact over time
100
114
  * @param {string} portfolioId UUID of the portfolio
101
- * @param {string} valueFrameworkId UUID of the value framework
115
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ getPortfolioMonetizedImpact: (portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
120
+ /**
121
+ * 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.
122
+ * @summary Portfolio monetized impact over time (split by metric)
123
+ * @param {string} portfolioId UUID of the portfolio
124
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
102
125
  * @param {*} [options] Override http request option.
103
126
  * @throws {RequiredError}
104
127
  */
105
- getPortfolioMonetizedImpact: (portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
128
+ getPortfolioMonetizedImpactDetailed: (portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
106
129
  };
107
130
  /**
108
131
  * PortfolioKPIApi - functional programming interface
@@ -112,38 +135,35 @@ export declare const PortfolioKPIApiFp: (configuration?: Configuration) => {
112
135
  * Total cost of preferred options starting each year.
113
136
  * @summary CAPEX year-by-year distribution
114
137
  * @param {string} portfolioId UUID of the portfolio
115
- * @param {string} valueFrameworkId UUID of the value framework
116
138
  * @param {*} [options] Override http request option.
117
139
  * @throws {RequiredError}
118
140
  */
119
- getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
141
+ getCapexDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
120
142
  /**
121
143
  * Count of investments with a preferred option starting each year.
122
144
  * @summary Investment count year-by-year distribution
123
145
  * @param {string} portfolioId UUID of the portfolio
124
- * @param {string} valueFrameworkId UUID of the value framework
125
146
  * @param {*} [options] Override http request option.
126
147
  * @throws {RequiredError}
127
148
  */
128
- getInvestmentsDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
149
+ getInvestmentsDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
129
150
  /**
130
151
  * Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
131
152
  * @summary Budget overrun year-by-year distribution
132
153
  * @param {string} portfolioId UUID of the portfolio
133
- * @param {string} valueFrameworkId UUID of the value framework
134
154
  * @param {*} [options] Override http request option.
135
155
  * @throws {RequiredError}
136
156
  */
137
- getKpiOverrunDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIOverrunDistributionResponse>>;
157
+ getKpiOverrunDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIOverrunDistributionResponse>>;
138
158
  /**
139
- * Sum of final NPV of preferred options starting each year.
159
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
140
160
  * @summary NPV year-by-year distribution
141
161
  * @param {string} portfolioId UUID of the portfolio
142
- * @param {string} valueFrameworkId UUID of the value framework
162
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
143
163
  * @param {*} [options] Override http request option.
144
164
  * @throws {RequiredError}
145
165
  */
146
- getNpvDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
166
+ getNpvDistribution(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
147
167
  /**
148
168
  * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
149
169
  * @summary Budget year-by-year expenditure
@@ -153,6 +173,22 @@ export declare const PortfolioKPIApiFp: (configuration?: Configuration) => {
153
173
  * @throws {RequiredError}
154
174
  */
155
175
  getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>>;
176
+ /**
177
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
178
+ * @summary Budget year-by-year expenditure for all budgets
179
+ * @param {string} portfolioId UUID of the portfolio
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ getPortfolioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetExpenditureResponse>>>;
184
+ /**
185
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
186
+ * @summary Year-by-year expenditure for options with no budget
187
+ * @param {string} portfolioId UUID of the portfolio
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ getPortfolioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>>;
156
192
  /**
157
193
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
158
194
  * @summary Budget usage summary
@@ -162,14 +198,14 @@ export declare const PortfolioKPIApiFp: (configuration?: Configuration) => {
162
198
  */
163
199
  getPortfolioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetUsageItem>>>;
164
200
  /**
165
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
201
+ * 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.
166
202
  * @summary Get portfolio KPIs
167
203
  * @param {string} portfolioId UUID of the portfolio
168
- * @param {string} valueFrameworkId UUID of the value framework
204
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
169
205
  * @param {*} [options] Override http request option.
170
206
  * @throws {RequiredError}
171
207
  */
172
- getPortfolioKpis(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIResponse>>;
208
+ getPortfolioKpis(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIResponse>>;
173
209
  /**
174
210
  * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
175
211
  * @summary Metric performance over time
@@ -180,14 +216,23 @@ export declare const PortfolioKPIApiFp: (configuration?: Configuration) => {
180
216
  */
181
217
  getPortfolioMetricPerformance(portfolioId: string, metricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricPerformanceResponse>>;
182
218
  /**
183
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
219
+ * 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.
184
220
  * @summary Portfolio monetized impact over time
185
221
  * @param {string} portfolioId UUID of the portfolio
186
- * @param {string} valueFrameworkId UUID of the value framework
222
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
223
+ * @param {*} [options] Override http request option.
224
+ * @throws {RequiredError}
225
+ */
226
+ getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactResponse>>;
227
+ /**
228
+ * 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.
229
+ * @summary Portfolio monetized impact over time (split by metric)
230
+ * @param {string} portfolioId UUID of the portfolio
231
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
187
232
  * @param {*} [options] Override http request option.
188
233
  * @throws {RequiredError}
189
234
  */
190
- getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactResponse>>;
235
+ getPortfolioMonetizedImpactDetailed(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactDetailedResponse>>;
191
236
  };
192
237
  /**
193
238
  * PortfolioKPIApi - factory interface
@@ -197,38 +242,35 @@ export declare const PortfolioKPIApiFactory: (configuration?: Configuration, bas
197
242
  * Total cost of preferred options starting each year.
198
243
  * @summary CAPEX year-by-year distribution
199
244
  * @param {string} portfolioId UUID of the portfolio
200
- * @param {string} valueFrameworkId UUID of the value framework
201
245
  * @param {*} [options] Override http request option.
202
246
  * @throws {RequiredError}
203
247
  */
204
- getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse>;
248
+ getCapexDistribution(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse>;
205
249
  /**
206
250
  * Count of investments with a preferred option starting each year.
207
251
  * @summary Investment count year-by-year distribution
208
252
  * @param {string} portfolioId UUID of the portfolio
209
- * @param {string} valueFrameworkId UUID of the value framework
210
253
  * @param {*} [options] Override http request option.
211
254
  * @throws {RequiredError}
212
255
  */
213
- getInvestmentsDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse>;
256
+ getInvestmentsDistribution(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse>;
214
257
  /**
215
258
  * Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
216
259
  * @summary Budget overrun year-by-year distribution
217
260
  * @param {string} portfolioId UUID of the portfolio
218
- * @param {string} valueFrameworkId UUID of the value framework
219
261
  * @param {*} [options] Override http request option.
220
262
  * @throws {RequiredError}
221
263
  */
222
- getKpiOverrunDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIOverrunDistributionResponse>;
264
+ getKpiOverrunDistribution(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIOverrunDistributionResponse>;
223
265
  /**
224
- * Sum of final NPV of preferred options starting each year.
266
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
225
267
  * @summary NPV year-by-year distribution
226
268
  * @param {string} portfolioId UUID of the portfolio
227
- * @param {string} valueFrameworkId UUID of the value framework
269
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
228
270
  * @param {*} [options] Override http request option.
229
271
  * @throws {RequiredError}
230
272
  */
231
- getNpvDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse>;
273
+ getNpvDistribution(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse>;
232
274
  /**
233
275
  * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
234
276
  * @summary Budget year-by-year expenditure
@@ -238,6 +280,22 @@ export declare const PortfolioKPIApiFactory: (configuration?: Configuration, bas
238
280
  * @throws {RequiredError}
239
281
  */
240
282
  getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse>;
283
+ /**
284
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
285
+ * @summary Budget year-by-year expenditure for all budgets
286
+ * @param {string} portfolioId UUID of the portfolio
287
+ * @param {*} [options] Override http request option.
288
+ * @throws {RequiredError}
289
+ */
290
+ getPortfolioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioBudgetExpenditureResponse>>;
291
+ /**
292
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
293
+ * @summary Year-by-year expenditure for options with no budget
294
+ * @param {string} portfolioId UUID of the portfolio
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ */
298
+ getPortfolioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse>;
241
299
  /**
242
300
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
243
301
  * @summary Budget usage summary
@@ -247,14 +305,14 @@ export declare const PortfolioKPIApiFactory: (configuration?: Configuration, bas
247
305
  */
248
306
  getPortfolioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioBudgetUsageItem>>;
249
307
  /**
250
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
308
+ * 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.
251
309
  * @summary Get portfolio KPIs
252
310
  * @param {string} portfolioId UUID of the portfolio
253
- * @param {string} valueFrameworkId UUID of the value framework
311
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
254
312
  * @param {*} [options] Override http request option.
255
313
  * @throws {RequiredError}
256
314
  */
257
- getPortfolioKpis(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIResponse>;
315
+ getPortfolioKpis(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIResponse>;
258
316
  /**
259
317
  * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
260
318
  * @summary Metric performance over time
@@ -265,14 +323,23 @@ export declare const PortfolioKPIApiFactory: (configuration?: Configuration, bas
265
323
  */
266
324
  getPortfolioMetricPerformance(portfolioId: string, metricId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricPerformanceResponse>;
267
325
  /**
268
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
326
+ * 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.
269
327
  * @summary Portfolio monetized impact over time
270
328
  * @param {string} portfolioId UUID of the portfolio
271
- * @param {string} valueFrameworkId UUID of the value framework
329
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
330
+ * @param {*} [options] Override http request option.
331
+ * @throws {RequiredError}
332
+ */
333
+ getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactResponse>;
334
+ /**
335
+ * 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.
336
+ * @summary Portfolio monetized impact over time (split by metric)
337
+ * @param {string} portfolioId UUID of the portfolio
338
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
272
339
  * @param {*} [options] Override http request option.
273
340
  * @throws {RequiredError}
274
341
  */
275
- getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactResponse>;
342
+ getPortfolioMonetizedImpactDetailed(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactDetailedResponse>;
276
343
  };
277
344
  /**
278
345
  * PortfolioKPIApi - object-oriented interface
@@ -282,38 +349,35 @@ export declare class PortfolioKPIApi extends BaseAPI {
282
349
  * Total cost of preferred options starting each year.
283
350
  * @summary CAPEX year-by-year distribution
284
351
  * @param {string} portfolioId UUID of the portfolio
285
- * @param {string} valueFrameworkId UUID of the value framework
286
352
  * @param {*} [options] Override http request option.
287
353
  * @throws {RequiredError}
288
354
  */
289
- getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
355
+ getCapexDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
290
356
  /**
291
357
  * Count of investments with a preferred option starting each year.
292
358
  * @summary Investment count year-by-year distribution
293
359
  * @param {string} portfolioId UUID of the portfolio
294
- * @param {string} valueFrameworkId UUID of the value framework
295
360
  * @param {*} [options] Override http request option.
296
361
  * @throws {RequiredError}
297
362
  */
298
- getInvestmentsDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
363
+ getInvestmentsDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
299
364
  /**
300
365
  * Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
301
366
  * @summary Budget overrun year-by-year distribution
302
367
  * @param {string} portfolioId UUID of the portfolio
303
- * @param {string} valueFrameworkId UUID of the value framework
304
368
  * @param {*} [options] Override http request option.
305
369
  * @throws {RequiredError}
306
370
  */
307
- getKpiOverrunDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIOverrunDistributionResponse, any, {}>>;
371
+ getKpiOverrunDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIOverrunDistributionResponse, any, {}>>;
308
372
  /**
309
- * Sum of final NPV of preferred options starting each year.
373
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
310
374
  * @summary NPV year-by-year distribution
311
375
  * @param {string} portfolioId UUID of the portfolio
312
- * @param {string} valueFrameworkId UUID of the value framework
376
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
313
377
  * @param {*} [options] Override http request option.
314
378
  * @throws {RequiredError}
315
379
  */
316
- getNpvDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
380
+ getNpvDistribution(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
317
381
  /**
318
382
  * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
319
383
  * @summary Budget year-by-year expenditure
@@ -323,6 +387,22 @@ export declare class PortfolioKPIApi extends BaseAPI {
323
387
  * @throws {RequiredError}
324
388
  */
325
389
  getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioBudgetExpenditureResponse, any, {}>>;
390
+ /**
391
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
392
+ * @summary Budget year-by-year expenditure for all budgets
393
+ * @param {string} portfolioId UUID of the portfolio
394
+ * @param {*} [options] Override http request option.
395
+ * @throws {RequiredError}
396
+ */
397
+ getPortfolioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioBudgetExpenditureResponse[], any, {}>>;
398
+ /**
399
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
400
+ * @summary Year-by-year expenditure for options with no budget
401
+ * @param {string} portfolioId UUID of the portfolio
402
+ * @param {*} [options] Override http request option.
403
+ * @throws {RequiredError}
404
+ */
405
+ getPortfolioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioBudgetExpenditureResponse, any, {}>>;
326
406
  /**
327
407
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
328
408
  * @summary Budget usage summary
@@ -332,14 +412,14 @@ export declare class PortfolioKPIApi extends BaseAPI {
332
412
  */
333
413
  getPortfolioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioBudgetUsageItem[], any, {}>>;
334
414
  /**
335
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
415
+ * 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.
336
416
  * @summary Get portfolio KPIs
337
417
  * @param {string} portfolioId UUID of the portfolio
338
- * @param {string} valueFrameworkId UUID of the value framework
418
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
339
419
  * @param {*} [options] Override http request option.
340
420
  * @throws {RequiredError}
341
421
  */
342
- getPortfolioKpis(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIResponse, any, {}>>;
422
+ getPortfolioKpis(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIResponse, any, {}>>;
343
423
  /**
344
424
  * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
345
425
  * @summary Metric performance over time
@@ -350,12 +430,21 @@ export declare class PortfolioKPIApi extends BaseAPI {
350
430
  */
351
431
  getPortfolioMetricPerformance(portfolioId: string, metricId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricPerformanceResponse, any, {}>>;
352
432
  /**
353
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
433
+ * 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.
354
434
  * @summary Portfolio monetized impact over time
355
435
  * @param {string} portfolioId UUID of the portfolio
356
- * @param {string} valueFrameworkId UUID of the value framework
436
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
437
+ * @param {*} [options] Override http request option.
438
+ * @throws {RequiredError}
439
+ */
440
+ getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MonetizedImpactResponse, any, {}>>;
441
+ /**
442
+ * 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.
443
+ * @summary Portfolio monetized impact over time (split by metric)
444
+ * @param {string} portfolioId UUID of the portfolio
445
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
357
446
  * @param {*} [options] Override http request option.
358
447
  * @throws {RequiredError}
359
448
  */
360
- getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MonetizedImpactResponse, any, {}>>;
449
+ getPortfolioMonetizedImpactDetailed(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MonetizedImpactDetailedResponse, any, {}>>;
361
450
  }