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

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 (494) hide show
  1. package/README.md +21 -13
  2. package/api/budget-api.ts +52 -49
  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 +19 -18
  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 +35 -35
  25. package/dist/api/budget-api.js +35 -35
  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 +13 -13
  45. package/dist/api/option-api.js +14 -14
  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 +35 -35
  69. package/dist/esm/api/budget-api.js +35 -35
  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 +13 -13
  89. package/dist/esm/api/option-api.js +14 -14
  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 +16 -15
  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/OptionApi.md +4 -4
  415. package/docs/PortfolioApi.md +7 -7
  416. package/docs/PortfolioInvestmentApi.md +56 -0
  417. package/docs/PortfolioInvestmentOverviewResponse.md +35 -0
  418. package/docs/PortfolioKPIApi.md +183 -30
  419. package/docs/PortfolioKPIDistributionResponse.md +1 -1
  420. package/index.ts +1 -1
  421. package/models/budget-bulk-delete-request.ts +1 -1
  422. package/models/budget-create.ts +1 -1
  423. package/models/budget-investment-response.ts +1 -1
  424. package/models/budget-link-options-request.ts +1 -1
  425. package/models/budget-option-response.ts +2 -1
  426. package/models/budget-overview-response.ts +1 -1
  427. package/models/budget-response.ts +1 -1
  428. package/models/budget-update.ts +1 -1
  429. package/models/bulk-delete-request.ts +1 -1
  430. package/models/evolution-type.ts +1 -1
  431. package/models/httpvalidation-error.ts +1 -1
  432. package/models/impact-apiresponse.ts +1 -1
  433. package/models/impact-bulk-item.ts +1 -1
  434. package/models/impact-create.ts +1 -1
  435. package/models/impact-update.ts +1 -1
  436. package/models/index.ts +4 -0
  437. package/models/investment-create.ts +1 -1
  438. package/models/investment-overview-response.ts +1 -1
  439. package/models/investment-response.ts +1 -1
  440. package/models/investment-update.ts +1 -1
  441. package/models/location-inner.ts +1 -1
  442. package/models/measurement-type.ts +1 -1
  443. package/models/metric-costs-per-year-create.ts +1 -1
  444. package/models/metric-costs-per-year-response.ts +1 -1
  445. package/models/metric-costs-per-year-update.ts +1 -1
  446. package/models/metric-create.ts +1 -1
  447. package/models/metric-performance-response.ts +1 -1
  448. package/models/metric-performance-year.ts +1 -1
  449. package/models/metric-response.ts +1 -1
  450. package/models/metric-type.ts +1 -1
  451. package/models/metric-update.ts +1 -1
  452. package/models/monetized-impact-detailed-response.ts +26 -0
  453. package/models/monetized-impact-detailed-year.ts +28 -0
  454. package/models/monetized-impact-metric-value.ts +25 -0
  455. package/models/monetized-impact-response.ts +1 -1
  456. package/models/monetized-impact-year.ts +1 -1
  457. package/models/objective-create.ts +1 -1
  458. package/models/objective-response.ts +1 -1
  459. package/models/objective-update.ts +1 -1
  460. package/models/objective-weight-create.ts +1 -1
  461. package/models/objective-weight-response.ts +1 -1
  462. package/models/objective-weight-update.ts +1 -1
  463. package/models/option-chart-kpi.ts +1 -1
  464. package/models/option-chart-kpis-yearly.ts +1 -1
  465. package/models/option-create.ts +1 -1
  466. package/models/option-overview-response.ts +1 -1
  467. package/models/option-response.ts +1 -1
  468. package/models/option-update.ts +1 -1
  469. package/models/portfolio-budget-expenditure-response.ts +1 -1
  470. package/models/portfolio-budget-expenditure-year.ts +1 -1
  471. package/models/portfolio-budget-usage-item.ts +1 -1
  472. package/models/portfolio-bulk-delete-request.ts +1 -1
  473. package/models/portfolio-create.ts +1 -1
  474. package/models/portfolio-investment-bulk-add-request.ts +1 -1
  475. package/models/portfolio-investment-bulk-add-response.ts +1 -1
  476. package/models/portfolio-investment-bulk-delete-request.ts +1 -1
  477. package/models/portfolio-investment-overview-response.ts +36 -0
  478. package/models/portfolio-investment-response.ts +1 -1
  479. package/models/portfolio-kpidistribution-budget-item.ts +1 -1
  480. package/models/portfolio-kpidistribution-response.ts +2 -2
  481. package/models/portfolio-kpidistribution-year-overrun.ts +1 -1
  482. package/models/portfolio-kpidistribution-year-value.ts +1 -1
  483. package/models/portfolio-kpioverrun-distribution-response.ts +1 -1
  484. package/models/portfolio-kpiresponse.ts +1 -1
  485. package/models/portfolio-overview-item-response.ts +1 -1
  486. package/models/portfolio-response.ts +1 -1
  487. package/models/portfolio-update.ts +1 -1
  488. package/models/preferred-option-request.ts +1 -1
  489. package/models/preferred-option-response.ts +1 -1
  490. package/models/validation-error.ts +1 -1
  491. package/models/value-framework-create.ts +1 -1
  492. package/models/value-framework-response.ts +1 -1
  493. package/models/value-framework-update.ts +1 -1
  494. package/package.json +1 -1
@@ -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-dev5
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -35,18 +35,14 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
35
35
  * Total cost of preferred options starting each year.
36
36
  * @summary CAPEX year-by-year distribution
37
37
  * @param {string} portfolioId UUID of the portfolio
38
- * @param {string} valueFrameworkId UUID of the value framework
39
38
  * @param {*} [options] Override http request option.
40
39
  * @throws {RequiredError}
41
40
  */
42
- getCapexDistribution: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
41
+ getCapexDistribution: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
43
42
  // verify required parameter 'portfolioId' is not null or undefined
44
43
  assertParamExists('getCapexDistribution', 'portfolioId', portfolioId);
45
- // verify required parameter 'valueFrameworkId' is not null or undefined
46
- assertParamExists('getCapexDistribution', 'valueFrameworkId', valueFrameworkId);
47
- const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution`
48
- .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
49
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
44
+ const localVarPath = `/portfolio/{portfolio_id}/kpis/capex-distribution`
45
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
50
46
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
47
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52
48
  let baseOptions;
@@ -72,18 +68,14 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
72
68
  * Count of investments with a preferred option starting each year.
73
69
  * @summary Investment count year-by-year distribution
74
70
  * @param {string} portfolioId UUID of the portfolio
75
- * @param {string} valueFrameworkId UUID of the value framework
76
71
  * @param {*} [options] Override http request option.
77
72
  * @throws {RequiredError}
78
73
  */
79
- getInvestmentsDistribution: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
74
+ getInvestmentsDistribution: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
80
75
  // verify required parameter 'portfolioId' is not null or undefined
81
76
  assertParamExists('getInvestmentsDistribution', 'portfolioId', portfolioId);
82
- // verify required parameter 'valueFrameworkId' is not null or undefined
83
- assertParamExists('getInvestmentsDistribution', 'valueFrameworkId', valueFrameworkId);
84
- const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution`
85
- .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
86
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
77
+ const localVarPath = `/portfolio/{portfolio_id}/kpis/investments-distribution`
78
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
87
79
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
88
80
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
89
81
  let baseOptions;
@@ -109,18 +101,14 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
109
101
  * 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.
110
102
  * @summary Budget overrun year-by-year distribution
111
103
  * @param {string} portfolioId UUID of the portfolio
112
- * @param {string} valueFrameworkId UUID of the value framework
113
104
  * @param {*} [options] Override http request option.
114
105
  * @throws {RequiredError}
115
106
  */
116
- getKpiOverrunDistribution: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
107
+ getKpiOverrunDistribution: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
117
108
  // verify required parameter 'portfolioId' is not null or undefined
118
109
  assertParamExists('getKpiOverrunDistribution', 'portfolioId', portfolioId);
119
- // verify required parameter 'valueFrameworkId' is not null or undefined
120
- assertParamExists('getKpiOverrunDistribution', 'valueFrameworkId', valueFrameworkId);
121
- const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution`
122
- .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
123
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
110
+ const localVarPath = `/portfolio/{portfolio_id}/kpis/overrun-distribution`
111
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
124
112
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
125
113
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
126
114
  let baseOptions;
@@ -143,21 +131,18 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
143
131
  };
144
132
  }),
145
133
  /**
146
- * Sum of final NPV of preferred options starting each year.
134
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
147
135
  * @summary NPV year-by-year distribution
148
136
  * @param {string} portfolioId UUID of the portfolio
149
- * @param {string} valueFrameworkId UUID of the value framework
137
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
150
138
  * @param {*} [options] Override http request option.
151
139
  * @throws {RequiredError}
152
140
  */
153
141
  getNpvDistribution: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
154
142
  // verify required parameter 'portfolioId' is not null or undefined
155
143
  assertParamExists('getNpvDistribution', 'portfolioId', portfolioId);
156
- // verify required parameter 'valueFrameworkId' is not null or undefined
157
- assertParamExists('getNpvDistribution', 'valueFrameworkId', valueFrameworkId);
158
- const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution`
159
- .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
160
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
144
+ const localVarPath = `/portfolio/{portfolio_id}/kpis/npv-distribution`
145
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
161
146
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
162
147
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
163
148
  let baseOptions;
@@ -170,6 +155,9 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
170
155
  // authentication OAuth2AuthorizationCodeBearer required
171
156
  // oauth required
172
157
  yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
158
+ if (valueFrameworkId !== undefined) {
159
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
160
+ }
173
161
  localVarHeaderParameter['Accept'] = 'application/json';
174
162
  setSearchParams(localVarUrlObj, localVarQueryParameter);
175
163
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -216,6 +204,72 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
216
204
  options: localVarRequestOptions,
217
205
  };
218
206
  }),
207
+ /**
208
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
209
+ * @summary Budget year-by-year expenditure for all budgets
210
+ * @param {string} portfolioId UUID of the portfolio
211
+ * @param {*} [options] Override http request option.
212
+ * @throws {RequiredError}
213
+ */
214
+ getPortfolioBudgetExpenditureAll: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
215
+ // verify required parameter 'portfolioId' is not null or undefined
216
+ assertParamExists('getPortfolioBudgetExpenditureAll', 'portfolioId', portfolioId);
217
+ const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure-all`
218
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
219
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
220
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
221
+ let baseOptions;
222
+ if (configuration) {
223
+ baseOptions = configuration.baseOptions;
224
+ }
225
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
226
+ const localVarHeaderParameter = {};
227
+ const localVarQueryParameter = {};
228
+ // authentication OAuth2AuthorizationCodeBearer required
229
+ // oauth required
230
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
231
+ localVarHeaderParameter['Accept'] = 'application/json';
232
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
233
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
234
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
235
+ return {
236
+ url: toPathString(localVarUrlObj),
237
+ options: localVarRequestOptions,
238
+ };
239
+ }),
240
+ /**
241
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
242
+ * @summary Year-by-year expenditure for options with no budget
243
+ * @param {string} portfolioId UUID of the portfolio
244
+ * @param {*} [options] Override http request option.
245
+ * @throws {RequiredError}
246
+ */
247
+ getPortfolioBudgetExpenditureNoBudget: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
248
+ // verify required parameter 'portfolioId' is not null or undefined
249
+ assertParamExists('getPortfolioBudgetExpenditureNoBudget', 'portfolioId', portfolioId);
250
+ const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure-no-budget`
251
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
252
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
253
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
254
+ let baseOptions;
255
+ if (configuration) {
256
+ baseOptions = configuration.baseOptions;
257
+ }
258
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
259
+ const localVarHeaderParameter = {};
260
+ const localVarQueryParameter = {};
261
+ // authentication OAuth2AuthorizationCodeBearer required
262
+ // oauth required
263
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
264
+ localVarHeaderParameter['Accept'] = 'application/json';
265
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
266
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
267
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
268
+ return {
269
+ url: toPathString(localVarUrlObj),
270
+ options: localVarRequestOptions,
271
+ };
272
+ }),
219
273
  /**
220
274
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
221
275
  * @summary Budget usage summary
@@ -250,21 +304,18 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
250
304
  };
251
305
  }),
252
306
  /**
253
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
307
+ * 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.
254
308
  * @summary Get portfolio KPIs
255
309
  * @param {string} portfolioId UUID of the portfolio
256
- * @param {string} valueFrameworkId UUID of the value framework
310
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
257
311
  * @param {*} [options] Override http request option.
258
312
  * @throws {RequiredError}
259
313
  */
260
314
  getPortfolioKpis: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
261
315
  // verify required parameter 'portfolioId' is not null or undefined
262
316
  assertParamExists('getPortfolioKpis', 'portfolioId', portfolioId);
263
- // verify required parameter 'valueFrameworkId' is not null or undefined
264
- assertParamExists('getPortfolioKpis', 'valueFrameworkId', valueFrameworkId);
265
- const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}`
266
- .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
267
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
317
+ const localVarPath = `/portfolio/{portfolio_id}/kpis`
318
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
268
319
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
269
320
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
270
321
  let baseOptions;
@@ -277,6 +328,9 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
277
328
  // authentication OAuth2AuthorizationCodeBearer required
278
329
  // oauth required
279
330
  yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
331
+ if (valueFrameworkId !== undefined) {
332
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
333
+ }
280
334
  localVarHeaderParameter['Accept'] = 'application/json';
281
335
  setSearchParams(localVarUrlObj, localVarQueryParameter);
282
336
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -324,21 +378,18 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
324
378
  };
325
379
  }),
326
380
  /**
327
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
381
+ * 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.
328
382
  * @summary Portfolio monetized impact over time
329
383
  * @param {string} portfolioId UUID of the portfolio
330
- * @param {string} valueFrameworkId UUID of the value framework
384
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
331
385
  * @param {*} [options] Override http request option.
332
386
  * @throws {RequiredError}
333
387
  */
334
388
  getPortfolioMonetizedImpact: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
335
389
  // verify required parameter 'portfolioId' is not null or undefined
336
390
  assertParamExists('getPortfolioMonetizedImpact', 'portfolioId', portfolioId);
337
- // verify required parameter 'valueFrameworkId' is not null or undefined
338
- assertParamExists('getPortfolioMonetizedImpact', 'valueFrameworkId', valueFrameworkId);
339
- const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/{value_framework_id}`
340
- .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
341
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
391
+ const localVarPath = `/portfolio/{portfolio_id}/monetized-impact`
392
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
342
393
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
343
394
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
344
395
  let baseOptions;
@@ -351,6 +402,46 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration) {
351
402
  // authentication OAuth2AuthorizationCodeBearer required
352
403
  // oauth required
353
404
  yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
405
+ if (valueFrameworkId !== undefined) {
406
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
407
+ }
408
+ localVarHeaderParameter['Accept'] = 'application/json';
409
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
410
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
411
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
412
+ return {
413
+ url: toPathString(localVarUrlObj),
414
+ options: localVarRequestOptions,
415
+ };
416
+ }),
417
+ /**
418
+ * 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.
419
+ * @summary Portfolio monetized impact over time (split by metric)
420
+ * @param {string} portfolioId UUID of the portfolio
421
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
422
+ * @param {*} [options] Override http request option.
423
+ * @throws {RequiredError}
424
+ */
425
+ getPortfolioMonetizedImpactDetailed: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
426
+ // verify required parameter 'portfolioId' is not null or undefined
427
+ assertParamExists('getPortfolioMonetizedImpactDetailed', 'portfolioId', portfolioId);
428
+ const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/detailed`
429
+ .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
430
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
431
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
432
+ let baseOptions;
433
+ if (configuration) {
434
+ baseOptions = configuration.baseOptions;
435
+ }
436
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
437
+ const localVarHeaderParameter = {};
438
+ const localVarQueryParameter = {};
439
+ // authentication OAuth2AuthorizationCodeBearer required
440
+ // oauth required
441
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
442
+ if (valueFrameworkId !== undefined) {
443
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
444
+ }
354
445
  localVarHeaderParameter['Accept'] = 'application/json';
355
446
  setSearchParams(localVarUrlObj, localVarQueryParameter);
356
447
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -372,14 +463,13 @@ export const PortfolioKPIApiFp = function (configuration) {
372
463
  * Total cost of preferred options starting each year.
373
464
  * @summary CAPEX year-by-year distribution
374
465
  * @param {string} portfolioId UUID of the portfolio
375
- * @param {string} valueFrameworkId UUID of the value framework
376
466
  * @param {*} [options] Override http request option.
377
467
  * @throws {RequiredError}
378
468
  */
379
- getCapexDistribution(portfolioId, valueFrameworkId, options) {
469
+ getCapexDistribution(portfolioId, options) {
380
470
  return __awaiter(this, void 0, void 0, function* () {
381
471
  var _a, _b, _c;
382
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getCapexDistribution(portfolioId, valueFrameworkId, options);
472
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCapexDistribution(portfolioId, options);
383
473
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
384
474
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PortfolioKPIApi.getCapexDistribution']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
385
475
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -389,14 +479,13 @@ export const PortfolioKPIApiFp = function (configuration) {
389
479
  * Count of investments with a preferred option starting each year.
390
480
  * @summary Investment count year-by-year distribution
391
481
  * @param {string} portfolioId UUID of the portfolio
392
- * @param {string} valueFrameworkId UUID of the value framework
393
482
  * @param {*} [options] Override http request option.
394
483
  * @throws {RequiredError}
395
484
  */
396
- getInvestmentsDistribution(portfolioId, valueFrameworkId, options) {
485
+ getInvestmentsDistribution(portfolioId, options) {
397
486
  return __awaiter(this, void 0, void 0, function* () {
398
487
  var _a, _b, _c;
399
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId, valueFrameworkId, options);
488
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId, options);
400
489
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
401
490
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PortfolioKPIApi.getInvestmentsDistribution']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
402
491
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -406,24 +495,23 @@ export const PortfolioKPIApiFp = function (configuration) {
406
495
  * 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.
407
496
  * @summary Budget overrun year-by-year distribution
408
497
  * @param {string} portfolioId UUID of the portfolio
409
- * @param {string} valueFrameworkId UUID of the value framework
410
498
  * @param {*} [options] Override http request option.
411
499
  * @throws {RequiredError}
412
500
  */
413
- getKpiOverrunDistribution(portfolioId, valueFrameworkId, options) {
501
+ getKpiOverrunDistribution(portfolioId, options) {
414
502
  return __awaiter(this, void 0, void 0, function* () {
415
503
  var _a, _b, _c;
416
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId, valueFrameworkId, options);
504
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId, options);
417
505
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
418
506
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PortfolioKPIApi.getKpiOverrunDistribution']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
419
507
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
420
508
  });
421
509
  },
422
510
  /**
423
- * Sum of final NPV of preferred options starting each year.
511
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
424
512
  * @summary NPV year-by-year distribution
425
513
  * @param {string} portfolioId UUID of the portfolio
426
- * @param {string} valueFrameworkId UUID of the value framework
514
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
427
515
  * @param {*} [options] Override http request option.
428
516
  * @throws {RequiredError}
429
517
  */
@@ -453,6 +541,38 @@ export const PortfolioKPIApiFp = function (configuration) {
453
541
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
454
542
  });
455
543
  },
544
+ /**
545
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
546
+ * @summary Budget year-by-year expenditure for all budgets
547
+ * @param {string} portfolioId UUID of the portfolio
548
+ * @param {*} [options] Override http request option.
549
+ * @throws {RequiredError}
550
+ */
551
+ getPortfolioBudgetExpenditureAll(portfolioId, options) {
552
+ return __awaiter(this, void 0, void 0, function* () {
553
+ var _a, _b, _c;
554
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioBudgetExpenditureAll(portfolioId, options);
555
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
556
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditureAll']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
557
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
558
+ });
559
+ },
560
+ /**
561
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
562
+ * @summary Year-by-year expenditure for options with no budget
563
+ * @param {string} portfolioId UUID of the portfolio
564
+ * @param {*} [options] Override http request option.
565
+ * @throws {RequiredError}
566
+ */
567
+ getPortfolioBudgetExpenditureNoBudget(portfolioId, options) {
568
+ return __awaiter(this, void 0, void 0, function* () {
569
+ var _a, _b, _c;
570
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioBudgetExpenditureNoBudget(portfolioId, options);
571
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
572
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditureNoBudget']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
573
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
574
+ });
575
+ },
456
576
  /**
457
577
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
458
578
  * @summary Budget usage summary
@@ -470,10 +590,10 @@ export const PortfolioKPIApiFp = function (configuration) {
470
590
  });
471
591
  },
472
592
  /**
473
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
593
+ * 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.
474
594
  * @summary Get portfolio KPIs
475
595
  * @param {string} portfolioId UUID of the portfolio
476
- * @param {string} valueFrameworkId UUID of the value framework
596
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
477
597
  * @param {*} [options] Override http request option.
478
598
  * @throws {RequiredError}
479
599
  */
@@ -504,10 +624,10 @@ export const PortfolioKPIApiFp = function (configuration) {
504
624
  });
505
625
  },
506
626
  /**
507
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
627
+ * 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.
508
628
  * @summary Portfolio monetized impact over time
509
629
  * @param {string} portfolioId UUID of the portfolio
510
- * @param {string} valueFrameworkId UUID of the value framework
630
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
511
631
  * @param {*} [options] Override http request option.
512
632
  * @throws {RequiredError}
513
633
  */
@@ -520,6 +640,23 @@ export const PortfolioKPIApiFp = function (configuration) {
520
640
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
521
641
  });
522
642
  },
643
+ /**
644
+ * 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.
645
+ * @summary Portfolio monetized impact over time (split by metric)
646
+ * @param {string} portfolioId UUID of the portfolio
647
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
648
+ * @param {*} [options] Override http request option.
649
+ * @throws {RequiredError}
650
+ */
651
+ getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options) {
652
+ return __awaiter(this, void 0, void 0, function* () {
653
+ var _a, _b, _c;
654
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options);
655
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
656
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PortfolioKPIApi.getPortfolioMonetizedImpactDetailed']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
657
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
658
+ });
659
+ },
523
660
  };
524
661
  };
525
662
  /**
@@ -532,40 +669,37 @@ export const PortfolioKPIApiFactory = function (configuration, basePath, axios)
532
669
  * Total cost of preferred options starting each year.
533
670
  * @summary CAPEX year-by-year distribution
534
671
  * @param {string} portfolioId UUID of the portfolio
535
- * @param {string} valueFrameworkId UUID of the value framework
536
672
  * @param {*} [options] Override http request option.
537
673
  * @throws {RequiredError}
538
674
  */
539
- getCapexDistribution(portfolioId, valueFrameworkId, options) {
540
- return localVarFp.getCapexDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
675
+ getCapexDistribution(portfolioId, options) {
676
+ return localVarFp.getCapexDistribution(portfolioId, options).then((request) => request(axios, basePath));
541
677
  },
542
678
  /**
543
679
  * Count of investments with a preferred option starting each year.
544
680
  * @summary Investment count year-by-year distribution
545
681
  * @param {string} portfolioId UUID of the portfolio
546
- * @param {string} valueFrameworkId UUID of the value framework
547
682
  * @param {*} [options] Override http request option.
548
683
  * @throws {RequiredError}
549
684
  */
550
- getInvestmentsDistribution(portfolioId, valueFrameworkId, options) {
551
- return localVarFp.getInvestmentsDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
685
+ getInvestmentsDistribution(portfolioId, options) {
686
+ return localVarFp.getInvestmentsDistribution(portfolioId, options).then((request) => request(axios, basePath));
552
687
  },
553
688
  /**
554
689
  * 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.
555
690
  * @summary Budget overrun year-by-year distribution
556
691
  * @param {string} portfolioId UUID of the portfolio
557
- * @param {string} valueFrameworkId UUID of the value framework
558
692
  * @param {*} [options] Override http request option.
559
693
  * @throws {RequiredError}
560
694
  */
561
- getKpiOverrunDistribution(portfolioId, valueFrameworkId, options) {
562
- return localVarFp.getKpiOverrunDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
695
+ getKpiOverrunDistribution(portfolioId, options) {
696
+ return localVarFp.getKpiOverrunDistribution(portfolioId, options).then((request) => request(axios, basePath));
563
697
  },
564
698
  /**
565
- * Sum of final NPV of preferred options starting each year.
699
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
566
700
  * @summary NPV year-by-year distribution
567
701
  * @param {string} portfolioId UUID of the portfolio
568
- * @param {string} valueFrameworkId UUID of the value framework
702
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
569
703
  * @param {*} [options] Override http request option.
570
704
  * @throws {RequiredError}
571
705
  */
@@ -583,6 +717,26 @@ export const PortfolioKPIApiFactory = function (configuration, basePath, axios)
583
717
  getPortfolioBudgetExpenditure(portfolioId, budgetId, options) {
584
718
  return localVarFp.getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(axios, basePath));
585
719
  },
720
+ /**
721
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
722
+ * @summary Budget year-by-year expenditure for all budgets
723
+ * @param {string} portfolioId UUID of the portfolio
724
+ * @param {*} [options] Override http request option.
725
+ * @throws {RequiredError}
726
+ */
727
+ getPortfolioBudgetExpenditureAll(portfolioId, options) {
728
+ return localVarFp.getPortfolioBudgetExpenditureAll(portfolioId, options).then((request) => request(axios, basePath));
729
+ },
730
+ /**
731
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
732
+ * @summary Year-by-year expenditure for options with no budget
733
+ * @param {string} portfolioId UUID of the portfolio
734
+ * @param {*} [options] Override http request option.
735
+ * @throws {RequiredError}
736
+ */
737
+ getPortfolioBudgetExpenditureNoBudget(portfolioId, options) {
738
+ return localVarFp.getPortfolioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(axios, basePath));
739
+ },
586
740
  /**
587
741
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
588
742
  * @summary Budget usage summary
@@ -594,10 +748,10 @@ export const PortfolioKPIApiFactory = function (configuration, basePath, axios)
594
748
  return localVarFp.getPortfolioBudgetUsage(portfolioId, options).then((request) => request(axios, basePath));
595
749
  },
596
750
  /**
597
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
751
+ * 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.
598
752
  * @summary Get portfolio KPIs
599
753
  * @param {string} portfolioId UUID of the portfolio
600
- * @param {string} valueFrameworkId UUID of the value framework
754
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
601
755
  * @param {*} [options] Override http request option.
602
756
  * @throws {RequiredError}
603
757
  */
@@ -616,16 +770,27 @@ export const PortfolioKPIApiFactory = function (configuration, basePath, axios)
616
770
  return localVarFp.getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(axios, basePath));
617
771
  },
618
772
  /**
619
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
773
+ * 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.
620
774
  * @summary Portfolio monetized impact over time
621
775
  * @param {string} portfolioId UUID of the portfolio
622
- * @param {string} valueFrameworkId UUID of the value framework
776
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
623
777
  * @param {*} [options] Override http request option.
624
778
  * @throws {RequiredError}
625
779
  */
626
780
  getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options) {
627
781
  return localVarFp.getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
628
782
  },
783
+ /**
784
+ * 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.
785
+ * @summary Portfolio monetized impact over time (split by metric)
786
+ * @param {string} portfolioId UUID of the portfolio
787
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
788
+ * @param {*} [options] Override http request option.
789
+ * @throws {RequiredError}
790
+ */
791
+ getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options) {
792
+ return localVarFp.getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
793
+ },
629
794
  };
630
795
  };
631
796
  /**
@@ -636,40 +801,37 @@ export class PortfolioKPIApi extends BaseAPI {
636
801
  * Total cost of preferred options starting each year.
637
802
  * @summary CAPEX year-by-year distribution
638
803
  * @param {string} portfolioId UUID of the portfolio
639
- * @param {string} valueFrameworkId UUID of the value framework
640
804
  * @param {*} [options] Override http request option.
641
805
  * @throws {RequiredError}
642
806
  */
643
- getCapexDistribution(portfolioId, valueFrameworkId, options) {
644
- return PortfolioKPIApiFp(this.configuration).getCapexDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
807
+ getCapexDistribution(portfolioId, options) {
808
+ return PortfolioKPIApiFp(this.configuration).getCapexDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
645
809
  }
646
810
  /**
647
811
  * Count of investments with a preferred option starting each year.
648
812
  * @summary Investment count year-by-year distribution
649
813
  * @param {string} portfolioId UUID of the portfolio
650
- * @param {string} valueFrameworkId UUID of the value framework
651
814
  * @param {*} [options] Override http request option.
652
815
  * @throws {RequiredError}
653
816
  */
654
- getInvestmentsDistribution(portfolioId, valueFrameworkId, options) {
655
- return PortfolioKPIApiFp(this.configuration).getInvestmentsDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
817
+ getInvestmentsDistribution(portfolioId, options) {
818
+ return PortfolioKPIApiFp(this.configuration).getInvestmentsDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
656
819
  }
657
820
  /**
658
821
  * 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.
659
822
  * @summary Budget overrun year-by-year distribution
660
823
  * @param {string} portfolioId UUID of the portfolio
661
- * @param {string} valueFrameworkId UUID of the value framework
662
824
  * @param {*} [options] Override http request option.
663
825
  * @throws {RequiredError}
664
826
  */
665
- getKpiOverrunDistribution(portfolioId, valueFrameworkId, options) {
666
- return PortfolioKPIApiFp(this.configuration).getKpiOverrunDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
827
+ getKpiOverrunDistribution(portfolioId, options) {
828
+ return PortfolioKPIApiFp(this.configuration).getKpiOverrunDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
667
829
  }
668
830
  /**
669
- * Sum of final NPV of preferred options starting each year.
831
+ * Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
670
832
  * @summary NPV year-by-year distribution
671
833
  * @param {string} portfolioId UUID of the portfolio
672
- * @param {string} valueFrameworkId UUID of the value framework
834
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
673
835
  * @param {*} [options] Override http request option.
674
836
  * @throws {RequiredError}
675
837
  */
@@ -687,6 +849,26 @@ export class PortfolioKPIApi extends BaseAPI {
687
849
  getPortfolioBudgetExpenditure(portfolioId, budgetId, options) {
688
850
  return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(this.axios, this.basePath));
689
851
  }
852
+ /**
853
+ * Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
854
+ * @summary Budget year-by-year expenditure for all budgets
855
+ * @param {string} portfolioId UUID of the portfolio
856
+ * @param {*} [options] Override http request option.
857
+ * @throws {RequiredError}
858
+ */
859
+ getPortfolioBudgetExpenditureAll(portfolioId, options) {
860
+ return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditureAll(portfolioId, options).then((request) => request(this.axios, this.basePath));
861
+ }
862
+ /**
863
+ * Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
864
+ * @summary Year-by-year expenditure for options with no budget
865
+ * @param {string} portfolioId UUID of the portfolio
866
+ * @param {*} [options] Override http request option.
867
+ * @throws {RequiredError}
868
+ */
869
+ getPortfolioBudgetExpenditureNoBudget(portfolioId, options) {
870
+ return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(this.axios, this.basePath));
871
+ }
690
872
  /**
691
873
  * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
692
874
  * @summary Budget usage summary
@@ -698,10 +880,10 @@ export class PortfolioKPIApi extends BaseAPI {
698
880
  return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetUsage(portfolioId, options).then((request) => request(this.axios, this.basePath));
699
881
  }
700
882
  /**
701
- * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
883
+ * 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.
702
884
  * @summary Get portfolio KPIs
703
885
  * @param {string} portfolioId UUID of the portfolio
704
- * @param {string} valueFrameworkId UUID of the value framework
886
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
705
887
  * @param {*} [options] Override http request option.
706
888
  * @throws {RequiredError}
707
889
  */
@@ -720,14 +902,25 @@ export class PortfolioKPIApi extends BaseAPI {
720
902
  return PortfolioKPIApiFp(this.configuration).getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(this.axios, this.basePath));
721
903
  }
722
904
  /**
723
- * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
905
+ * 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.
724
906
  * @summary Portfolio monetized impact over time
725
907
  * @param {string} portfolioId UUID of the portfolio
726
- * @param {string} valueFrameworkId UUID of the value framework
908
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
727
909
  * @param {*} [options] Override http request option.
728
910
  * @throws {RequiredError}
729
911
  */
730
912
  getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options) {
731
913
  return PortfolioKPIApiFp(this.configuration).getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
732
914
  }
915
+ /**
916
+ * 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.
917
+ * @summary Portfolio monetized impact over time (split by metric)
918
+ * @param {string} portfolioId UUID of the portfolio
919
+ * @param {string | null} [valueFrameworkId] UUID of the value framework
920
+ * @param {*} [options] Override http request option.
921
+ * @throws {RequiredError}
922
+ */
923
+ getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options) {
924
+ return PortfolioKPIApiFp(this.configuration).getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
925
+ }
733
926
  }