@cosmotech/aip-client 0.3.0-dev2 → 0.4.0-dev1

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 (498) hide show
  1. package/README.md +49 -41
  2. package/api/budget-api.ts +7 -7
  3. package/api/default-api.ts +1 -1
  4. package/api/impact-api.ts +90 -1
  5. package/api/investment-api.ts +55 -1254
  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 -509
  10. package/api/objective-weight-api.ts +1 -1
  11. package/api/objective-weights-api.ts +1 -1
  12. package/api/option-api.ts +28 -481
  13. package/api/portfolio-api.ts +601 -0
  14. package/api/portfolio-investment-api.ts +545 -0
  15. package/api/portfolio-kpiapi.ts +772 -0
  16. package/api/preferred-option-api.ts +1 -1
  17. package/api/value-framework-api.ts +61 -1189
  18. package/api/value-framework-costs-api.ts +1 -1
  19. package/api/value-framework-weights-api.ts +1 -1
  20. package/api.ts +4 -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 +5 -5
  25. package/dist/api/budget-api.js +7 -7
  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 +42 -1
  29. package/dist/api/impact-api.js +85 -1
  30. package/dist/api/investment-api.d.ts +1 -551
  31. package/dist/api/investment-api.js +57 -1189
  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 -233
  39. package/dist/api/objective-api.js +1 -479
  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 -224
  45. package/dist/api/option-api.js +28 -458
  46. package/dist/api/portfolio-api.d.ts +279 -0
  47. package/dist/api/portfolio-api.js +575 -0
  48. package/dist/api/portfolio-investment-api.d.ts +258 -0
  49. package/dist/api/portfolio-investment-api.js +526 -0
  50. package/dist/api/portfolio-kpiapi.d.ts +361 -0
  51. package/dist/api/portfolio-kpiapi.js +740 -0
  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 -519
  55. package/dist/api/value-framework-api.js +61 -1128
  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 +4 -1
  61. package/dist/api.js +4 -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 +5 -5
  69. package/dist/esm/api/budget-api.js +7 -7
  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 +42 -1
  73. package/dist/esm/api/impact-api.js +85 -1
  74. package/dist/esm/api/investment-api.d.ts +1 -551
  75. package/dist/esm/api/investment-api.js +56 -1188
  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 -233
  83. package/dist/esm/api/objective-api.js +1 -479
  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 -224
  89. package/dist/esm/api/option-api.js +28 -458
  90. package/dist/esm/api/portfolio-api.d.ts +279 -0
  91. package/dist/esm/api/portfolio-api.js +568 -0
  92. package/dist/esm/api/portfolio-investment-api.d.ts +258 -0
  93. package/dist/esm/api/portfolio-investment-api.js +519 -0
  94. package/dist/esm/api/portfolio-kpiapi.d.ts +361 -0
  95. package/dist/esm/api/portfolio-kpiapi.js +733 -0
  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 -519
  99. package/dist/esm/api/value-framework-api.js +61 -1128
  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 +4 -1
  105. package/dist/esm/api.js +4 -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 +3 -3
  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 +1 -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 -2
  137. package/dist/esm/models/impact-apiresponse.js +1 -1
  138. package/dist/esm/models/impact-bulk-item.d.ts +33 -0
  139. package/dist/esm/models/impact-bulk-item.js +14 -0
  140. package/dist/esm/models/impact-create.d.ts +1 -5
  141. package/dist/esm/models/impact-create.js +1 -1
  142. package/dist/esm/models/impact-update.d.ts +1 -2
  143. package/dist/esm/models/impact-update.js +1 -1
  144. package/dist/esm/models/index.d.ts +23 -0
  145. package/dist/esm/models/index.js +23 -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 +21 -0
  167. package/dist/esm/models/metric-performance-response.js +14 -0
  168. package/dist/esm/models/metric-performance-year.d.ts +18 -0
  169. package/dist/esm/models/metric-performance-year.js +14 -0
  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-response.d.ts +18 -0
  177. package/dist/esm/models/monetized-impact-response.js +14 -0
  178. package/dist/esm/models/monetized-impact-year.d.ts +19 -0
  179. package/dist/esm/models/monetized-impact-year.js +14 -0
  180. package/dist/esm/models/objective-create.d.ts +1 -1
  181. package/dist/esm/models/objective-create.js +1 -1
  182. package/dist/esm/models/objective-response.d.ts +1 -1
  183. package/dist/esm/models/objective-response.js +1 -1
  184. package/dist/esm/models/objective-update.d.ts +1 -1
  185. package/dist/esm/models/objective-update.js +1 -1
  186. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  187. package/dist/esm/models/objective-weight-create.js +1 -1
  188. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  189. package/dist/esm/models/objective-weight-response.js +1 -1
  190. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  191. package/dist/esm/models/objective-weight-update.js +1 -1
  192. package/dist/esm/models/option-chart-kpi.d.ts +1 -1
  193. package/dist/esm/models/option-chart-kpi.js +1 -1
  194. package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
  195. package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
  196. package/dist/esm/models/option-create.d.ts +1 -1
  197. package/dist/esm/models/option-create.js +1 -1
  198. package/dist/esm/models/option-overview-response.d.ts +1 -1
  199. package/dist/esm/models/option-overview-response.js +1 -1
  200. package/dist/esm/models/option-response.d.ts +1 -1
  201. package/dist/esm/models/option-response.js +1 -1
  202. package/dist/esm/models/option-update.d.ts +1 -1
  203. package/dist/esm/models/option-update.js +1 -1
  204. package/dist/esm/models/portfolio-budget-expenditure-response.d.ts +21 -0
  205. package/dist/esm/models/portfolio-budget-expenditure-response.js +14 -0
  206. package/dist/esm/models/portfolio-budget-expenditure-year.d.ts +18 -0
  207. package/dist/esm/models/portfolio-budget-expenditure-year.js +14 -0
  208. package/dist/esm/models/portfolio-budget-usage-item.d.ts +28 -0
  209. package/dist/esm/models/portfolio-budget-usage-item.js +14 -0
  210. package/dist/esm/models/portfolio-bulk-delete-request.d.ts +20 -0
  211. package/dist/esm/models/portfolio-bulk-delete-request.js +14 -0
  212. package/dist/esm/models/portfolio-create.d.ts +21 -0
  213. package/dist/esm/models/portfolio-create.js +14 -0
  214. package/dist/esm/models/portfolio-investment-bulk-add-request.d.ts +20 -0
  215. package/dist/esm/models/portfolio-investment-bulk-add-request.js +14 -0
  216. package/dist/esm/models/portfolio-investment-bulk-add-response.d.ts +24 -0
  217. package/dist/esm/models/portfolio-investment-bulk-add-response.js +14 -0
  218. package/dist/esm/models/portfolio-investment-bulk-delete-request.d.ts +20 -0
  219. package/dist/esm/models/portfolio-investment-bulk-delete-request.js +14 -0
  220. package/dist/esm/models/portfolio-investment-response.d.ts +25 -0
  221. package/dist/esm/models/portfolio-investment-response.js +14 -0
  222. package/dist/esm/models/portfolio-kpidistribution-budget-item.d.ts +19 -0
  223. package/dist/esm/models/portfolio-kpidistribution-budget-item.js +14 -0
  224. package/dist/esm/models/portfolio-kpidistribution-response.d.ts +20 -0
  225. package/dist/esm/models/portfolio-kpidistribution-response.js +14 -0
  226. package/dist/esm/models/portfolio-kpidistribution-year-overrun.d.ts +19 -0
  227. package/dist/esm/models/portfolio-kpidistribution-year-overrun.js +14 -0
  228. package/dist/esm/models/portfolio-kpidistribution-year-value.d.ts +18 -0
  229. package/dist/esm/models/portfolio-kpidistribution-year-value.js +14 -0
  230. package/dist/esm/models/portfolio-kpioverrun-distribution-response.d.ts +19 -0
  231. package/dist/esm/models/portfolio-kpioverrun-distribution-response.js +14 -0
  232. package/dist/esm/models/portfolio-kpiresponse.d.ts +31 -0
  233. package/dist/esm/models/portfolio-kpiresponse.js +14 -0
  234. package/dist/esm/models/portfolio-overview-item-response.d.ts +40 -0
  235. package/dist/esm/models/portfolio-overview-item-response.js +14 -0
  236. package/dist/esm/models/portfolio-response.d.ts +25 -0
  237. package/dist/esm/models/portfolio-response.js +14 -0
  238. package/dist/esm/models/portfolio-update.d.ts +18 -0
  239. package/dist/esm/models/portfolio-update.js +14 -0
  240. package/dist/esm/models/preferred-option-request.d.ts +1 -1
  241. package/dist/esm/models/preferred-option-request.js +1 -1
  242. package/dist/esm/models/preferred-option-response.d.ts +1 -1
  243. package/dist/esm/models/preferred-option-response.js +1 -1
  244. package/dist/esm/models/validation-error.d.ts +1 -1
  245. package/dist/esm/models/validation-error.js +1 -1
  246. package/dist/esm/models/value-framework-create.d.ts +1 -1
  247. package/dist/esm/models/value-framework-create.js +1 -1
  248. package/dist/esm/models/value-framework-response.d.ts +1 -1
  249. package/dist/esm/models/value-framework-response.js +1 -1
  250. package/dist/esm/models/value-framework-update.d.ts +1 -1
  251. package/dist/esm/models/value-framework-update.js +1 -1
  252. package/dist/index.d.ts +1 -1
  253. package/dist/index.js +1 -1
  254. package/dist/models/budget-bulk-delete-request.d.ts +3 -3
  255. package/dist/models/budget-bulk-delete-request.js +1 -1
  256. package/dist/models/budget-create.d.ts +1 -1
  257. package/dist/models/budget-create.js +1 -1
  258. package/dist/models/budget-investment-response.d.ts +1 -1
  259. package/dist/models/budget-investment-response.js +1 -1
  260. package/dist/models/budget-link-options-request.d.ts +1 -1
  261. package/dist/models/budget-link-options-request.js +1 -1
  262. package/dist/models/budget-option-response.d.ts +1 -1
  263. package/dist/models/budget-option-response.js +1 -1
  264. package/dist/models/budget-overview-response.d.ts +1 -1
  265. package/dist/models/budget-overview-response.js +1 -1
  266. package/dist/models/budget-response.d.ts +1 -1
  267. package/dist/models/budget-response.js +1 -1
  268. package/dist/models/budget-update.d.ts +1 -1
  269. package/dist/models/budget-update.js +1 -1
  270. package/dist/models/bulk-delete-request.d.ts +1 -1
  271. package/dist/models/bulk-delete-request.js +1 -1
  272. package/dist/models/evolution-type.d.ts +1 -1
  273. package/dist/models/evolution-type.js +1 -1
  274. package/dist/models/httpvalidation-error.d.ts +1 -1
  275. package/dist/models/httpvalidation-error.js +1 -1
  276. package/dist/models/impact-apiresponse.d.ts +1 -2
  277. package/dist/models/impact-apiresponse.js +1 -1
  278. package/dist/models/impact-bulk-item.d.ts +33 -0
  279. package/dist/models/impact-bulk-item.js +15 -0
  280. package/dist/models/impact-create.d.ts +1 -5
  281. package/dist/models/impact-create.js +1 -1
  282. package/dist/models/impact-update.d.ts +1 -2
  283. package/dist/models/impact-update.js +1 -1
  284. package/dist/models/index.d.ts +23 -0
  285. package/dist/models/index.js +23 -0
  286. package/dist/models/investment-create.d.ts +1 -1
  287. package/dist/models/investment-create.js +1 -1
  288. package/dist/models/investment-overview-response.d.ts +1 -1
  289. package/dist/models/investment-overview-response.js +1 -1
  290. package/dist/models/investment-response.d.ts +1 -1
  291. package/dist/models/investment-response.js +1 -1
  292. package/dist/models/investment-update.d.ts +1 -1
  293. package/dist/models/investment-update.js +1 -1
  294. package/dist/models/location-inner.d.ts +1 -1
  295. package/dist/models/location-inner.js +1 -1
  296. package/dist/models/measurement-type.d.ts +1 -1
  297. package/dist/models/measurement-type.js +1 -1
  298. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  299. package/dist/models/metric-costs-per-year-create.js +1 -1
  300. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  301. package/dist/models/metric-costs-per-year-response.js +1 -1
  302. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  303. package/dist/models/metric-costs-per-year-update.js +1 -1
  304. package/dist/models/metric-create.d.ts +1 -1
  305. package/dist/models/metric-create.js +1 -1
  306. package/dist/models/metric-performance-response.d.ts +21 -0
  307. package/dist/models/metric-performance-response.js +15 -0
  308. package/dist/models/metric-performance-year.d.ts +18 -0
  309. package/dist/models/metric-performance-year.js +15 -0
  310. package/dist/models/metric-response.d.ts +1 -1
  311. package/dist/models/metric-response.js +1 -1
  312. package/dist/models/metric-type.d.ts +1 -1
  313. package/dist/models/metric-type.js +1 -1
  314. package/dist/models/metric-update.d.ts +1 -1
  315. package/dist/models/metric-update.js +1 -1
  316. package/dist/models/monetized-impact-response.d.ts +18 -0
  317. package/dist/models/monetized-impact-response.js +15 -0
  318. package/dist/models/monetized-impact-year.d.ts +19 -0
  319. package/dist/models/monetized-impact-year.js +15 -0
  320. package/dist/models/objective-create.d.ts +1 -1
  321. package/dist/models/objective-create.js +1 -1
  322. package/dist/models/objective-response.d.ts +1 -1
  323. package/dist/models/objective-response.js +1 -1
  324. package/dist/models/objective-update.d.ts +1 -1
  325. package/dist/models/objective-update.js +1 -1
  326. package/dist/models/objective-weight-create.d.ts +1 -1
  327. package/dist/models/objective-weight-create.js +1 -1
  328. package/dist/models/objective-weight-response.d.ts +1 -1
  329. package/dist/models/objective-weight-response.js +1 -1
  330. package/dist/models/objective-weight-update.d.ts +1 -1
  331. package/dist/models/objective-weight-update.js +1 -1
  332. package/dist/models/option-chart-kpi.d.ts +1 -1
  333. package/dist/models/option-chart-kpi.js +1 -1
  334. package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
  335. package/dist/models/option-chart-kpis-yearly.js +1 -1
  336. package/dist/models/option-create.d.ts +1 -1
  337. package/dist/models/option-create.js +1 -1
  338. package/dist/models/option-overview-response.d.ts +1 -1
  339. package/dist/models/option-overview-response.js +1 -1
  340. package/dist/models/option-response.d.ts +1 -1
  341. package/dist/models/option-response.js +1 -1
  342. package/dist/models/option-update.d.ts +1 -1
  343. package/dist/models/option-update.js +1 -1
  344. package/dist/models/portfolio-budget-expenditure-response.d.ts +21 -0
  345. package/dist/models/portfolio-budget-expenditure-response.js +15 -0
  346. package/dist/models/portfolio-budget-expenditure-year.d.ts +18 -0
  347. package/dist/models/portfolio-budget-expenditure-year.js +15 -0
  348. package/dist/models/portfolio-budget-usage-item.d.ts +28 -0
  349. package/dist/models/portfolio-budget-usage-item.js +15 -0
  350. package/dist/models/portfolio-bulk-delete-request.d.ts +20 -0
  351. package/dist/models/portfolio-bulk-delete-request.js +15 -0
  352. package/dist/models/portfolio-create.d.ts +21 -0
  353. package/dist/models/portfolio-create.js +15 -0
  354. package/dist/models/portfolio-investment-bulk-add-request.d.ts +20 -0
  355. package/dist/models/portfolio-investment-bulk-add-request.js +15 -0
  356. package/dist/models/portfolio-investment-bulk-add-response.d.ts +24 -0
  357. package/dist/models/portfolio-investment-bulk-add-response.js +15 -0
  358. package/dist/models/portfolio-investment-bulk-delete-request.d.ts +20 -0
  359. package/dist/models/portfolio-investment-bulk-delete-request.js +15 -0
  360. package/dist/models/portfolio-investment-response.d.ts +25 -0
  361. package/dist/models/portfolio-investment-response.js +15 -0
  362. package/dist/models/portfolio-kpidistribution-budget-item.d.ts +19 -0
  363. package/dist/models/portfolio-kpidistribution-budget-item.js +15 -0
  364. package/dist/models/portfolio-kpidistribution-response.d.ts +20 -0
  365. package/dist/models/portfolio-kpidistribution-response.js +15 -0
  366. package/dist/models/portfolio-kpidistribution-year-overrun.d.ts +19 -0
  367. package/dist/models/portfolio-kpidistribution-year-overrun.js +15 -0
  368. package/dist/models/portfolio-kpidistribution-year-value.d.ts +18 -0
  369. package/dist/models/portfolio-kpidistribution-year-value.js +15 -0
  370. package/dist/models/portfolio-kpioverrun-distribution-response.d.ts +19 -0
  371. package/dist/models/portfolio-kpioverrun-distribution-response.js +15 -0
  372. package/dist/models/portfolio-kpiresponse.d.ts +31 -0
  373. package/dist/models/portfolio-kpiresponse.js +15 -0
  374. package/dist/models/portfolio-overview-item-response.d.ts +40 -0
  375. package/dist/models/portfolio-overview-item-response.js +15 -0
  376. package/dist/models/portfolio-response.d.ts +25 -0
  377. package/dist/models/portfolio-response.js +15 -0
  378. package/dist/models/portfolio-update.d.ts +18 -0
  379. package/dist/models/portfolio-update.js +15 -0
  380. package/dist/models/preferred-option-request.d.ts +1 -1
  381. package/dist/models/preferred-option-request.js +1 -1
  382. package/dist/models/preferred-option-response.d.ts +1 -1
  383. package/dist/models/preferred-option-response.js +1 -1
  384. package/dist/models/validation-error.d.ts +1 -1
  385. package/dist/models/validation-error.js +1 -1
  386. package/dist/models/value-framework-create.d.ts +1 -1
  387. package/dist/models/value-framework-create.js +1 -1
  388. package/dist/models/value-framework-response.d.ts +1 -1
  389. package/dist/models/value-framework-response.js +1 -1
  390. package/dist/models/value-framework-update.d.ts +1 -1
  391. package/dist/models/value-framework-update.js +1 -1
  392. package/docs/BudgetApi.md +4 -4
  393. package/docs/BudgetBulkDeleteRequest.md +2 -2
  394. package/docs/ImpactAPIResponse.md +0 -2
  395. package/docs/ImpactApi.md +60 -0
  396. package/docs/ImpactBulkItem.md +27 -0
  397. package/docs/ImpactCreate.md +0 -2
  398. package/docs/ImpactUpdate.md +0 -2
  399. package/docs/InvestmentApi.md +29 -851
  400. package/docs/MetricPerformanceResponse.md +27 -0
  401. package/docs/MetricPerformanceYear.md +23 -0
  402. package/docs/MonetizedImpactResponse.md +21 -0
  403. package/docs/MonetizedImpactYear.md +25 -0
  404. package/docs/ObjectiveApi.md +0 -351
  405. package/docs/OptionApi.md +7 -312
  406. package/docs/PortfolioApi.md +395 -0
  407. package/docs/PortfolioBudgetExpenditureResponse.md +27 -0
  408. package/docs/PortfolioBudgetExpenditureYear.md +23 -0
  409. package/docs/PortfolioBudgetUsageItem.md +31 -0
  410. package/docs/PortfolioBulkDeleteRequest.md +21 -0
  411. package/docs/PortfolioCreate.md +23 -0
  412. package/docs/PortfolioInvestmentApi.md +350 -0
  413. package/docs/PortfolioInvestmentBulkAddRequest.md +21 -0
  414. package/docs/PortfolioInvestmentBulkAddResponse.md +23 -0
  415. package/docs/PortfolioInvestmentBulkDeleteRequest.md +21 -0
  416. package/docs/PortfolioInvestmentResponse.md +25 -0
  417. package/docs/PortfolioKPIApi.md +508 -0
  418. package/docs/PortfolioKPIDistributionBudgetItem.md +25 -0
  419. package/docs/PortfolioKPIDistributionResponse.md +25 -0
  420. package/docs/PortfolioKPIDistributionYearOverrun.md +23 -0
  421. package/docs/PortfolioKPIDistributionYearValue.md +23 -0
  422. package/docs/PortfolioKPIOverrunDistributionResponse.md +23 -0
  423. package/docs/PortfolioKPIResponse.md +31 -0
  424. package/docs/PortfolioOverviewItemResponse.md +43 -0
  425. package/docs/PortfolioResponse.md +31 -0
  426. package/docs/PortfolioUpdate.md +23 -0
  427. package/docs/ValueFrameworkApi.md +7 -778
  428. package/index.ts +1 -1
  429. package/models/budget-bulk-delete-request.ts +3 -3
  430. package/models/budget-create.ts +1 -1
  431. package/models/budget-investment-response.ts +1 -1
  432. package/models/budget-link-options-request.ts +1 -1
  433. package/models/budget-option-response.ts +1 -1
  434. package/models/budget-overview-response.ts +1 -1
  435. package/models/budget-response.ts +1 -1
  436. package/models/budget-update.ts +1 -1
  437. package/models/bulk-delete-request.ts +1 -1
  438. package/models/evolution-type.ts +1 -1
  439. package/models/httpvalidation-error.ts +1 -1
  440. package/models/impact-apiresponse.ts +1 -2
  441. package/models/impact-bulk-item.ts +43 -0
  442. package/models/impact-create.ts +1 -5
  443. package/models/impact-update.ts +1 -2
  444. package/models/index.ts +23 -0
  445. package/models/investment-create.ts +1 -1
  446. package/models/investment-overview-response.ts +1 -1
  447. package/models/investment-response.ts +1 -1
  448. package/models/investment-update.ts +1 -1
  449. package/models/location-inner.ts +1 -1
  450. package/models/measurement-type.ts +1 -1
  451. package/models/metric-costs-per-year-create.ts +1 -1
  452. package/models/metric-costs-per-year-response.ts +1 -1
  453. package/models/metric-costs-per-year-update.ts +1 -1
  454. package/models/metric-create.ts +1 -1
  455. package/models/metric-performance-response.ts +29 -0
  456. package/models/metric-performance-year.ts +24 -0
  457. package/models/metric-response.ts +1 -1
  458. package/models/metric-type.ts +1 -1
  459. package/models/metric-update.ts +1 -1
  460. package/models/monetized-impact-response.ts +26 -0
  461. package/models/monetized-impact-year.ts +25 -0
  462. package/models/objective-create.ts +1 -1
  463. package/models/objective-response.ts +1 -1
  464. package/models/objective-update.ts +1 -1
  465. package/models/objective-weight-create.ts +1 -1
  466. package/models/objective-weight-response.ts +1 -1
  467. package/models/objective-weight-update.ts +1 -1
  468. package/models/option-chart-kpi.ts +1 -1
  469. package/models/option-chart-kpis-yearly.ts +1 -1
  470. package/models/option-create.ts +1 -1
  471. package/models/option-overview-response.ts +1 -1
  472. package/models/option-response.ts +1 -1
  473. package/models/option-update.ts +1 -1
  474. package/models/portfolio-budget-expenditure-response.ts +29 -0
  475. package/models/portfolio-budget-expenditure-year.ts +24 -0
  476. package/models/portfolio-budget-usage-item.ts +34 -0
  477. package/models/portfolio-bulk-delete-request.ts +26 -0
  478. package/models/portfolio-create.ts +27 -0
  479. package/models/portfolio-investment-bulk-add-request.ts +26 -0
  480. package/models/portfolio-investment-bulk-add-response.ts +30 -0
  481. package/models/portfolio-investment-bulk-delete-request.ts +26 -0
  482. package/models/portfolio-investment-response.ts +31 -0
  483. package/models/portfolio-kpidistribution-budget-item.ts +25 -0
  484. package/models/portfolio-kpidistribution-response.ts +28 -0
  485. package/models/portfolio-kpidistribution-year-overrun.ts +27 -0
  486. package/models/portfolio-kpidistribution-year-value.ts +24 -0
  487. package/models/portfolio-kpioverrun-distribution-response.ts +27 -0
  488. package/models/portfolio-kpiresponse.ts +37 -0
  489. package/models/portfolio-overview-item-response.ts +46 -0
  490. package/models/portfolio-response.ts +31 -0
  491. package/models/portfolio-update.ts +24 -0
  492. package/models/preferred-option-request.ts +1 -1
  493. package/models/preferred-option-response.ts +1 -1
  494. package/models/validation-error.ts +1 -1
  495. package/models/value-framework-create.ts +1 -1
  496. package/models/value-framework-response.ts +1 -1
  497. package/models/value-framework-update.ts +1 -1
  498. 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.3.0-dev1
7
+ * The version of the OpenAPI document: 0.4.0-dev1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,18 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
- import type { MetricCostsPerYearCreate } from '../models';
26
- // @ts-ignore
27
- import type { MetricCostsPerYearResponse } from '../models';
28
- // @ts-ignore
29
- import type { MetricCostsPerYearUpdate } from '../models';
30
- // @ts-ignore
31
- import type { ObjectiveWeightCreate } from '../models';
32
- // @ts-ignore
33
- import type { ObjectiveWeightResponse } from '../models';
34
- // @ts-ignore
35
- import type { ObjectiveWeightUpdate } from '../models';
36
- // @ts-ignore
37
25
  import type { ValueFrameworkCreate } from '../models';
38
26
  // @ts-ignore
39
27
  import type { ValueFrameworkResponse } from '../models';
@@ -44,178 +32,6 @@ import type { ValueFrameworkUpdate } from '../models';
44
32
  */
45
33
  export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Configuration) {
46
34
  return {
47
- /**
48
- * Create a yearly cost override for a metric within this framework.
49
- * @summary Create a yearly metric cost for this framework
50
- * @param {string} valueFrameworkId UUID of the value framework
51
- * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
52
- * @param {*} [options] Override http request option.
53
- * @throws {RequiredError}
54
- */
55
- createMetricCostForFramework: async (valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
56
- // verify required parameter 'valueFrameworkId' is not null or undefined
57
- assertParamExists('createMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
58
- // verify required parameter 'metricCostsPerYearCreate' is not null or undefined
59
- assertParamExists('createMetricCostForFramework', 'metricCostsPerYearCreate', metricCostsPerYearCreate)
60
- const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
61
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
62
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
63
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
64
- let baseOptions;
65
- if (configuration) {
66
- baseOptions = configuration.baseOptions;
67
- }
68
-
69
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
70
- const localVarHeaderParameter = {} as any;
71
- const localVarQueryParameter = {} as any;
72
-
73
- // authentication OAuth2AuthorizationCodeBearer required
74
- // oauth required
75
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
76
-
77
- localVarHeaderParameter['Content-Type'] = 'application/json';
78
- localVarHeaderParameter['Accept'] = 'application/json';
79
-
80
- setSearchParams(localVarUrlObj, localVarQueryParameter);
81
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
82
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
83
- localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearCreate, localVarRequestOptions, configuration)
84
-
85
- return {
86
- url: toPathString(localVarUrlObj),
87
- options: localVarRequestOptions,
88
- };
89
- },
90
- /**
91
- * Assign a weight to an objective within this framework.
92
- * @summary Create an objective weight for this framework
93
- * @param {string} valueFrameworkId UUID of the value framework
94
- * @param {ObjectiveWeightCreate} objectiveWeightCreate
95
- * @param {*} [options] Override http request option.
96
- * @throws {RequiredError}
97
- */
98
- createObjectiveWeightForFramework: async (valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
99
- // verify required parameter 'valueFrameworkId' is not null or undefined
100
- assertParamExists('createObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
101
- // verify required parameter 'objectiveWeightCreate' is not null or undefined
102
- assertParamExists('createObjectiveWeightForFramework', 'objectiveWeightCreate', objectiveWeightCreate)
103
- const localVarPath = `/value_framework/{value_framework_id}/objective_weight/`
104
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
105
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
106
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
107
- let baseOptions;
108
- if (configuration) {
109
- baseOptions = configuration.baseOptions;
110
- }
111
-
112
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
113
- const localVarHeaderParameter = {} as any;
114
- const localVarQueryParameter = {} as any;
115
-
116
- // authentication OAuth2AuthorizationCodeBearer required
117
- // oauth required
118
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
119
-
120
- localVarHeaderParameter['Content-Type'] = 'application/json';
121
- localVarHeaderParameter['Accept'] = 'application/json';
122
-
123
- setSearchParams(localVarUrlObj, localVarQueryParameter);
124
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
125
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
126
- localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightCreate, localVarRequestOptions, configuration)
127
-
128
- return {
129
- url: toPathString(localVarUrlObj),
130
- options: localVarRequestOptions,
131
- };
132
- },
133
- /**
134
- * Delete a metric cost entry for a specific year within this framework.
135
- * @summary Delete metric costs for this framework
136
- * @param {string} metricId UUID of the metric
137
- * @param {number} year Year (1600-3000)
138
- * @param {string} valueFrameworkId UUID of the value framework
139
- * @param {*} [options] Override http request option.
140
- * @throws {RequiredError}
141
- */
142
- deleteMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
143
- // verify required parameter 'metricId' is not null or undefined
144
- assertParamExists('deleteMetricCostForFramework', 'metricId', metricId)
145
- // verify required parameter 'year' is not null or undefined
146
- assertParamExists('deleteMetricCostForFramework', 'year', year)
147
- // verify required parameter 'valueFrameworkId' is not null or undefined
148
- assertParamExists('deleteMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
149
- const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
150
- .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
151
- .replace(`{${"year"}}`, encodeURIComponent(String(year)))
152
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
153
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
154
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
155
- let baseOptions;
156
- if (configuration) {
157
- baseOptions = configuration.baseOptions;
158
- }
159
-
160
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
161
- const localVarHeaderParameter = {} as any;
162
- const localVarQueryParameter = {} as any;
163
-
164
- // authentication OAuth2AuthorizationCodeBearer required
165
- // oauth required
166
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
167
-
168
-
169
- setSearchParams(localVarUrlObj, localVarQueryParameter);
170
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
171
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
172
-
173
- return {
174
- url: toPathString(localVarUrlObj),
175
- options: localVarRequestOptions,
176
- };
177
- },
178
- /**
179
- * Remove an objective weight from this framework.
180
- * @summary Delete an objective weight for this framework
181
- * @param {string} objectiveId UUID of the objective
182
- * @param {string} valueFrameworkId UUID of the value framework
183
- * @param {*} [options] Override http request option.
184
- * @throws {RequiredError}
185
- */
186
- deleteObjectiveWeightForFramework: async (objectiveId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
187
- // verify required parameter 'objectiveId' is not null or undefined
188
- assertParamExists('deleteObjectiveWeightForFramework', 'objectiveId', objectiveId)
189
- // verify required parameter 'valueFrameworkId' is not null or undefined
190
- assertParamExists('deleteObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
191
- const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
192
- .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
193
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
194
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
195
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
196
- let baseOptions;
197
- if (configuration) {
198
- baseOptions = configuration.baseOptions;
199
- }
200
-
201
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
202
- const localVarHeaderParameter = {} as any;
203
- const localVarQueryParameter = {} as any;
204
-
205
- // authentication OAuth2AuthorizationCodeBearer required
206
- // oauth required
207
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
208
-
209
-
210
- setSearchParams(localVarUrlObj, localVarQueryParameter);
211
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
212
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
213
-
214
- return {
215
- url: toPathString(localVarUrlObj),
216
- options: localVarRequestOptions,
217
- };
218
- },
219
35
  /**
220
36
  * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
221
37
  * @summary Delete a value framework
@@ -254,18 +70,16 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
254
70
  };
255
71
  },
256
72
  /**
257
- * Retrieve a paginated list of all metric costs for a specific value framework.
258
- * @summary List all metric costs for a value framework
73
+ * Retrieve a single value framework by its ID.
74
+ * @summary Get a value framework by ID
259
75
  * @param {string} valueFrameworkId UUID of the value framework
260
- * @param {number} [offset] Number of records to skip
261
- * @param {number} [limit] Max number of records to return
262
76
  * @param {*} [options] Override http request option.
263
77
  * @throws {RequiredError}
264
78
  */
265
- getCostsForValueFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
79
+ getValueFrameworkById: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
266
80
  // verify required parameter 'valueFrameworkId' is not null or undefined
267
- assertParamExists('getCostsForValueFramework', 'valueFrameworkId', valueFrameworkId)
268
- const localVarPath = `/value_framework/{value_framework_id}/costs/`
81
+ assertParamExists('getValueFrameworkById', 'valueFrameworkId', valueFrameworkId)
82
+ const localVarPath = `/value_framework/{value_framework_id}`
269
83
  .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
270
84
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
271
85
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -282,14 +96,6 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
282
96
  // oauth required
283
97
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
284
98
 
285
- if (offset !== undefined) {
286
- localVarQueryParameter['offset'] = offset;
287
- }
288
-
289
- if (limit !== undefined) {
290
- localVarQueryParameter['limit'] = limit;
291
- }
292
-
293
99
  localVarHeaderParameter['Accept'] = 'application/json';
294
100
 
295
101
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -302,23 +108,15 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
302
108
  };
303
109
  },
304
110
  /**
305
- * Retrieve a paginated list of metric costs for a specific metric within a value framework.
306
- * @summary List metric costs for a value framework filtered by metric
307
- * @param {string} metricId UUID of the metric
308
- * @param {string} valueFrameworkId UUID of the value framework
111
+ * Retrieve a paginated list of all value frameworks.
112
+ * @summary List value frameworks
309
113
  * @param {number} [offset] Number of records to skip
310
114
  * @param {number} [limit] Max number of records to return
311
115
  * @param {*} [options] Override http request option.
312
116
  * @throws {RequiredError}
313
117
  */
314
- getCostsForValueFrameworkByMetric: async (metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
315
- // verify required parameter 'metricId' is not null or undefined
316
- assertParamExists('getCostsForValueFrameworkByMetric', 'metricId', metricId)
317
- // verify required parameter 'valueFrameworkId' is not null or undefined
318
- assertParamExists('getCostsForValueFrameworkByMetric', 'valueFrameworkId', valueFrameworkId)
319
- const localVarPath = `/value_framework/{value_framework_id}/costs/{metric_id}`
320
- .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
321
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
118
+ getValueFrameworks: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
119
+ const localVarPath = `/value_framework/`;
322
120
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
323
121
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
324
122
  let baseOptions;
@@ -354,24 +152,19 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
354
152
  };
355
153
  },
356
154
  /**
357
- * Retrieve cost data for a specific metric within this framework for a given year.
358
- * @summary Get a yearly metric cost for this framework
359
- * @param {string} metricId UUID of the metric
360
- * @param {number} year Year (1600-3000)
155
+ * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
156
+ * @summary Partially update a value framework
361
157
  * @param {string} valueFrameworkId UUID of the value framework
158
+ * @param {ValueFrameworkUpdate} valueFrameworkUpdate
362
159
  * @param {*} [options] Override http request option.
363
160
  * @throws {RequiredError}
364
161
  */
365
- getMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
366
- // verify required parameter 'metricId' is not null or undefined
367
- assertParamExists('getMetricCostForFramework', 'metricId', metricId)
368
- // verify required parameter 'year' is not null or undefined
369
- assertParamExists('getMetricCostForFramework', 'year', year)
162
+ patchValueFramework: async (valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
370
163
  // verify required parameter 'valueFrameworkId' is not null or undefined
371
- assertParamExists('getMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
372
- const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
373
- .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
374
- .replace(`{${"year"}}`, encodeURIComponent(String(year)))
164
+ assertParamExists('patchValueFramework', 'valueFrameworkId', valueFrameworkId)
165
+ // verify required parameter 'valueFrameworkUpdate' is not null or undefined
166
+ assertParamExists('patchValueFramework', 'valueFrameworkUpdate', valueFrameworkUpdate)
167
+ const localVarPath = `/value_framework/{value_framework_id}`
375
168
  .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
376
169
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
377
170
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -380,7 +173,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
380
173
  baseOptions = configuration.baseOptions;
381
174
  }
382
175
 
383
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
176
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
384
177
  const localVarHeaderParameter = {} as any;
385
178
  const localVarQueryParameter = {} as any;
386
179
 
@@ -388,11 +181,13 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
388
181
  // oauth required
389
182
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
390
183
 
184
+ localVarHeaderParameter['Content-Type'] = 'application/json';
391
185
  localVarHeaderParameter['Accept'] = 'application/json';
392
186
 
393
187
  setSearchParams(localVarUrlObj, localVarQueryParameter);
394
188
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
395
189
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
190
+ localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkUpdate, localVarRequestOptions, configuration)
396
191
 
397
192
  return {
398
193
  url: toPathString(localVarUrlObj),
@@ -400,19 +195,16 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
400
195
  };
401
196
  },
402
197
  /**
403
- * Retrieve a paginated list of all yearly metric costs for a specific framework.
404
- * @summary List yearly metric costs for this framework
405
- * @param {string} valueFrameworkId UUID of the value framework
406
- * @param {number} [offset] Number of records to skip
407
- * @param {number} [limit] Max number of records to return
198
+ * Create a new value framework. Name must be unique and non-empty.
199
+ * @summary Create a value framework
200
+ * @param {ValueFrameworkCreate} valueFrameworkCreate
408
201
  * @param {*} [options] Override http request option.
409
202
  * @throws {RequiredError}
410
203
  */
411
- getMetricCostsForFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
412
- // verify required parameter 'valueFrameworkId' is not null or undefined
413
- assertParamExists('getMetricCostsForFramework', 'valueFrameworkId', valueFrameworkId)
414
- const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
415
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
204
+ postValueFramework: async (valueFrameworkCreate: ValueFrameworkCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
205
+ // verify required parameter 'valueFrameworkCreate' is not null or undefined
206
+ assertParamExists('postValueFramework', 'valueFrameworkCreate', valueFrameworkCreate)
207
+ const localVarPath = `/value_framework/`;
416
208
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
417
209
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
418
210
  let baseOptions;
@@ -420,7 +212,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
420
212
  baseOptions = configuration.baseOptions;
421
213
  }
422
214
 
423
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
215
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
424
216
  const localVarHeaderParameter = {} as any;
425
217
  const localVarQueryParameter = {} as any;
426
218
 
@@ -428,610 +220,57 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration?: Conf
428
220
  // oauth required
429
221
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
430
222
 
431
- if (offset !== undefined) {
432
- localVarQueryParameter['offset'] = offset;
433
- }
434
-
435
- if (limit !== undefined) {
436
- localVarQueryParameter['limit'] = limit;
437
- }
438
-
223
+ localVarHeaderParameter['Content-Type'] = 'application/json';
439
224
  localVarHeaderParameter['Accept'] = 'application/json';
440
225
 
441
226
  setSearchParams(localVarUrlObj, localVarQueryParameter);
442
227
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
443
228
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
229
+ localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkCreate, localVarRequestOptions, configuration)
444
230
 
445
231
  return {
446
232
  url: toPathString(localVarUrlObj),
447
233
  options: localVarRequestOptions,
448
234
  };
449
235
  },
236
+ }
237
+ };
238
+
239
+ /**
240
+ * ValueFrameworkApi - functional programming interface
241
+ */
242
+ export const ValueFrameworkApiFp = function(configuration?: Configuration) {
243
+ const localVarAxiosParamCreator = ValueFrameworkApiAxiosParamCreator(configuration)
244
+ return {
450
245
  /**
451
- * Retrieve the weight for a specific objective within this framework.
452
- * @summary Get an objective weight for this framework
453
- * @param {string} objectiveId UUID of the objective
246
+ * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
247
+ * @summary Delete a value framework
454
248
  * @param {string} valueFrameworkId UUID of the value framework
455
249
  * @param {*} [options] Override http request option.
456
250
  * @throws {RequiredError}
457
251
  */
458
- getObjectiveWeightForFramework: async (objectiveId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
459
- // verify required parameter 'objectiveId' is not null or undefined
460
- assertParamExists('getObjectiveWeightForFramework', 'objectiveId', objectiveId)
461
- // verify required parameter 'valueFrameworkId' is not null or undefined
462
- assertParamExists('getObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
463
- const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
464
- .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
465
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
466
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
467
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
468
- let baseOptions;
469
- if (configuration) {
470
- baseOptions = configuration.baseOptions;
471
- }
472
-
473
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
474
- const localVarHeaderParameter = {} as any;
475
- const localVarQueryParameter = {} as any;
476
-
477
- // authentication OAuth2AuthorizationCodeBearer required
478
- // oauth required
479
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
480
-
481
- localVarHeaderParameter['Accept'] = 'application/json';
482
-
483
- setSearchParams(localVarUrlObj, localVarQueryParameter);
484
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
485
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
486
-
487
- return {
488
- url: toPathString(localVarUrlObj),
489
- options: localVarRequestOptions,
490
- };
252
+ async deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
253
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteValueFramework(valueFrameworkId, options);
254
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
255
+ const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteValueFramework']?.[localVarOperationServerIndex]?.url;
256
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
491
257
  },
492
258
  /**
493
- * Retrieve a paginated list of all objective weights for a specific framework.
494
- * @summary List objective weights for this framework
259
+ * Retrieve a single value framework by its ID.
260
+ * @summary Get a value framework by ID
495
261
  * @param {string} valueFrameworkId UUID of the value framework
496
- * @param {number} [offset] Number of records to skip
497
- * @param {number} [limit] Max number of records to return
498
- * @param {*} [options] Override http request option.
499
- * @throws {RequiredError}
500
- */
501
- getObjectiveWeightsForFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
502
- // verify required parameter 'valueFrameworkId' is not null or undefined
503
- assertParamExists('getObjectiveWeightsForFramework', 'valueFrameworkId', valueFrameworkId)
504
- const localVarPath = `/value_framework/{value_framework_id}/objective_weight/`
505
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
506
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
507
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
508
- let baseOptions;
509
- if (configuration) {
510
- baseOptions = configuration.baseOptions;
511
- }
512
-
513
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
514
- const localVarHeaderParameter = {} as any;
515
- const localVarQueryParameter = {} as any;
516
-
517
- // authentication OAuth2AuthorizationCodeBearer required
518
- // oauth required
519
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
520
-
521
- if (offset !== undefined) {
522
- localVarQueryParameter['offset'] = offset;
523
- }
524
-
525
- if (limit !== undefined) {
526
- localVarQueryParameter['limit'] = limit;
527
- }
528
-
529
- localVarHeaderParameter['Accept'] = 'application/json';
530
-
531
- setSearchParams(localVarUrlObj, localVarQueryParameter);
532
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
533
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
534
-
535
- return {
536
- url: toPathString(localVarUrlObj),
537
- options: localVarRequestOptions,
538
- };
539
- },
540
- /**
541
- * Retrieve a single value framework by its ID.
542
- * @summary Get a value framework by ID
543
- * @param {string} valueFrameworkId UUID of the value framework
544
- * @param {*} [options] Override http request option.
545
- * @throws {RequiredError}
546
- */
547
- getValueFrameworkById: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
548
- // verify required parameter 'valueFrameworkId' is not null or undefined
549
- assertParamExists('getValueFrameworkById', 'valueFrameworkId', valueFrameworkId)
550
- const localVarPath = `/value_framework/{value_framework_id}`
551
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
552
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
553
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
554
- let baseOptions;
555
- if (configuration) {
556
- baseOptions = configuration.baseOptions;
557
- }
558
-
559
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
560
- const localVarHeaderParameter = {} as any;
561
- const localVarQueryParameter = {} as any;
562
-
563
- // authentication OAuth2AuthorizationCodeBearer required
564
- // oauth required
565
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
566
-
567
- localVarHeaderParameter['Accept'] = 'application/json';
568
-
569
- setSearchParams(localVarUrlObj, localVarQueryParameter);
570
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
571
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
572
-
573
- return {
574
- url: toPathString(localVarUrlObj),
575
- options: localVarRequestOptions,
576
- };
577
- },
578
- /**
579
- * Retrieve a paginated list of all value frameworks.
580
- * @summary List value frameworks
581
- * @param {number} [offset] Number of records to skip
582
- * @param {number} [limit] Max number of records to return
583
- * @param {*} [options] Override http request option.
584
- * @throws {RequiredError}
585
- */
586
- getValueFrameworks: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
587
- const localVarPath = `/value_framework/`;
588
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
589
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
590
- let baseOptions;
591
- if (configuration) {
592
- baseOptions = configuration.baseOptions;
593
- }
594
-
595
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
596
- const localVarHeaderParameter = {} as any;
597
- const localVarQueryParameter = {} as any;
598
-
599
- // authentication OAuth2AuthorizationCodeBearer required
600
- // oauth required
601
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
602
-
603
- if (offset !== undefined) {
604
- localVarQueryParameter['offset'] = offset;
605
- }
606
-
607
- if (limit !== undefined) {
608
- localVarQueryParameter['limit'] = limit;
609
- }
610
-
611
- localVarHeaderParameter['Accept'] = 'application/json';
612
-
613
- setSearchParams(localVarUrlObj, localVarQueryParameter);
614
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
615
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
616
-
617
- return {
618
- url: toPathString(localVarUrlObj),
619
- options: localVarRequestOptions,
620
- };
621
- },
622
- /**
623
- * Retrieve a paginated list of all objective weights for a specific value framework.
624
- * @summary List all objective weights for a value framework
625
- * @param {string} valueFrameworkId UUID of the value framework
626
- * @param {number} [offset] Number of records to skip
627
- * @param {number} [limit] Max number of records to return
628
- * @param {*} [options] Override http request option.
629
- * @throws {RequiredError}
630
- */
631
- getWeightsForValueFramework: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
632
- // verify required parameter 'valueFrameworkId' is not null or undefined
633
- assertParamExists('getWeightsForValueFramework', 'valueFrameworkId', valueFrameworkId)
634
- const localVarPath = `/value_framework/{value_framework_id}/weights/`
635
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
636
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
637
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
638
- let baseOptions;
639
- if (configuration) {
640
- baseOptions = configuration.baseOptions;
641
- }
642
-
643
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
644
- const localVarHeaderParameter = {} as any;
645
- const localVarQueryParameter = {} as any;
646
-
647
- // authentication OAuth2AuthorizationCodeBearer required
648
- // oauth required
649
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
650
-
651
- if (offset !== undefined) {
652
- localVarQueryParameter['offset'] = offset;
653
- }
654
-
655
- if (limit !== undefined) {
656
- localVarQueryParameter['limit'] = limit;
657
- }
658
-
659
- localVarHeaderParameter['Accept'] = 'application/json';
660
-
661
- setSearchParams(localVarUrlObj, localVarQueryParameter);
662
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
663
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
664
-
665
- return {
666
- url: toPathString(localVarUrlObj),
667
- options: localVarRequestOptions,
668
- };
669
- },
670
- /**
671
- * Update the perceived and/or direct cost of a metric for a specific year within this framework.
672
- * @summary Partially update metric costs for this framework
673
- * @param {string} metricId UUID of the metric
674
- * @param {number} year Year (1600-3000)
675
- * @param {string} valueFrameworkId UUID of the value framework
676
- * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
677
- * @param {*} [options] Override http request option.
678
- * @throws {RequiredError}
679
- */
680
- patchMetricCostForFramework: async (metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
681
- // verify required parameter 'metricId' is not null or undefined
682
- assertParamExists('patchMetricCostForFramework', 'metricId', metricId)
683
- // verify required parameter 'year' is not null or undefined
684
- assertParamExists('patchMetricCostForFramework', 'year', year)
685
- // verify required parameter 'valueFrameworkId' is not null or undefined
686
- assertParamExists('patchMetricCostForFramework', 'valueFrameworkId', valueFrameworkId)
687
- // verify required parameter 'metricCostsPerYearUpdate' is not null or undefined
688
- assertParamExists('patchMetricCostForFramework', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate)
689
- const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
690
- .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
691
- .replace(`{${"year"}}`, encodeURIComponent(String(year)))
692
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
693
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
694
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
695
- let baseOptions;
696
- if (configuration) {
697
- baseOptions = configuration.baseOptions;
698
- }
699
-
700
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
701
- const localVarHeaderParameter = {} as any;
702
- const localVarQueryParameter = {} as any;
703
-
704
- // authentication OAuth2AuthorizationCodeBearer required
705
- // oauth required
706
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
707
-
708
- localVarHeaderParameter['Content-Type'] = 'application/json';
709
- localVarHeaderParameter['Accept'] = 'application/json';
710
-
711
- setSearchParams(localVarUrlObj, localVarQueryParameter);
712
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
713
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
714
- localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearUpdate, localVarRequestOptions, configuration)
715
-
716
- return {
717
- url: toPathString(localVarUrlObj),
718
- options: localVarRequestOptions,
719
- };
720
- },
721
- /**
722
- * Update the weight of an objective within this value framework.
723
- * @summary Partially update an objective weight for this framework
724
- * @param {string} objectiveId UUID of the objective
725
- * @param {string} valueFrameworkId UUID of the value framework
726
- * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
727
- * @param {*} [options] Override http request option.
728
- * @throws {RequiredError}
729
- */
730
- patchObjectiveWeightForFramework: async (objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
731
- // verify required parameter 'objectiveId' is not null or undefined
732
- assertParamExists('patchObjectiveWeightForFramework', 'objectiveId', objectiveId)
733
- // verify required parameter 'valueFrameworkId' is not null or undefined
734
- assertParamExists('patchObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId)
735
- // verify required parameter 'objectiveWeightUpdate' is not null or undefined
736
- assertParamExists('patchObjectiveWeightForFramework', 'objectiveWeightUpdate', objectiveWeightUpdate)
737
- const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
738
- .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
739
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
740
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
741
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
742
- let baseOptions;
743
- if (configuration) {
744
- baseOptions = configuration.baseOptions;
745
- }
746
-
747
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
748
- const localVarHeaderParameter = {} as any;
749
- const localVarQueryParameter = {} as any;
750
-
751
- // authentication OAuth2AuthorizationCodeBearer required
752
- // oauth required
753
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
754
-
755
- localVarHeaderParameter['Content-Type'] = 'application/json';
756
- localVarHeaderParameter['Accept'] = 'application/json';
757
-
758
- setSearchParams(localVarUrlObj, localVarQueryParameter);
759
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
760
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
761
- localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightUpdate, localVarRequestOptions, configuration)
762
-
763
- return {
764
- url: toPathString(localVarUrlObj),
765
- options: localVarRequestOptions,
766
- };
767
- },
768
- /**
769
- * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
770
- * @summary Partially update a value framework
771
- * @param {string} valueFrameworkId UUID of the value framework
772
- * @param {ValueFrameworkUpdate} valueFrameworkUpdate
773
- * @param {*} [options] Override http request option.
774
- * @throws {RequiredError}
775
- */
776
- patchValueFramework: async (valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
777
- // verify required parameter 'valueFrameworkId' is not null or undefined
778
- assertParamExists('patchValueFramework', 'valueFrameworkId', valueFrameworkId)
779
- // verify required parameter 'valueFrameworkUpdate' is not null or undefined
780
- assertParamExists('patchValueFramework', 'valueFrameworkUpdate', valueFrameworkUpdate)
781
- const localVarPath = `/value_framework/{value_framework_id}`
782
- .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
783
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
784
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
785
- let baseOptions;
786
- if (configuration) {
787
- baseOptions = configuration.baseOptions;
788
- }
789
-
790
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
791
- const localVarHeaderParameter = {} as any;
792
- const localVarQueryParameter = {} as any;
793
-
794
- // authentication OAuth2AuthorizationCodeBearer required
795
- // oauth required
796
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
797
-
798
- localVarHeaderParameter['Content-Type'] = 'application/json';
799
- localVarHeaderParameter['Accept'] = 'application/json';
800
-
801
- setSearchParams(localVarUrlObj, localVarQueryParameter);
802
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
803
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
804
- localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkUpdate, localVarRequestOptions, configuration)
805
-
806
- return {
807
- url: toPathString(localVarUrlObj),
808
- options: localVarRequestOptions,
809
- };
810
- },
811
- /**
812
- * Create a new value framework. Name must be unique and non-empty.
813
- * @summary Create a value framework
814
- * @param {ValueFrameworkCreate} valueFrameworkCreate
815
- * @param {*} [options] Override http request option.
816
- * @throws {RequiredError}
817
- */
818
- postValueFramework: async (valueFrameworkCreate: ValueFrameworkCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
819
- // verify required parameter 'valueFrameworkCreate' is not null or undefined
820
- assertParamExists('postValueFramework', 'valueFrameworkCreate', valueFrameworkCreate)
821
- const localVarPath = `/value_framework/`;
822
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
823
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
824
- let baseOptions;
825
- if (configuration) {
826
- baseOptions = configuration.baseOptions;
827
- }
828
-
829
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
830
- const localVarHeaderParameter = {} as any;
831
- const localVarQueryParameter = {} as any;
832
-
833
- // authentication OAuth2AuthorizationCodeBearer required
834
- // oauth required
835
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
836
-
837
- localVarHeaderParameter['Content-Type'] = 'application/json';
838
- localVarHeaderParameter['Accept'] = 'application/json';
839
-
840
- setSearchParams(localVarUrlObj, localVarQueryParameter);
841
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
842
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
843
- localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkCreate, localVarRequestOptions, configuration)
844
-
845
- return {
846
- url: toPathString(localVarUrlObj),
847
- options: localVarRequestOptions,
848
- };
849
- },
850
- }
851
- };
852
-
853
- /**
854
- * ValueFrameworkApi - functional programming interface
855
- */
856
- export const ValueFrameworkApiFp = function(configuration?: Configuration) {
857
- const localVarAxiosParamCreator = ValueFrameworkApiAxiosParamCreator(configuration)
858
- return {
859
- /**
860
- * Create a yearly cost override for a metric within this framework.
861
- * @summary Create a yearly metric cost for this framework
862
- * @param {string} valueFrameworkId UUID of the value framework
863
- * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
864
- * @param {*} [options] Override http request option.
865
- * @throws {RequiredError}
866
- */
867
- async createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
868
- const localVarAxiosArgs = await localVarAxiosParamCreator.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options);
869
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
870
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.createMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
871
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
872
- },
873
- /**
874
- * Assign a weight to an objective within this framework.
875
- * @summary Create an objective weight for this framework
876
- * @param {string} valueFrameworkId UUID of the value framework
877
- * @param {ObjectiveWeightCreate} objectiveWeightCreate
878
- * @param {*} [options] Override http request option.
879
- * @throws {RequiredError}
880
- */
881
- async createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>> {
882
- const localVarAxiosArgs = await localVarAxiosParamCreator.createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options);
883
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
884
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.createObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
885
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
886
- },
887
- /**
888
- * Delete a metric cost entry for a specific year within this framework.
889
- * @summary Delete metric costs for this framework
890
- * @param {string} metricId UUID of the metric
891
- * @param {number} year Year (1600-3000)
892
- * @param {string} valueFrameworkId UUID of the value framework
893
- * @param {*} [options] Override http request option.
894
- * @throws {RequiredError}
895
- */
896
- async deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
897
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options);
898
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
899
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
900
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
901
- },
902
- /**
903
- * Remove an objective weight from this framework.
904
- * @summary Delete an objective weight for this framework
905
- * @param {string} objectiveId UUID of the objective
906
- * @param {string} valueFrameworkId UUID of the value framework
907
- * @param {*} [options] Override http request option.
908
- * @throws {RequiredError}
909
- */
910
- async deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
911
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options);
912
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
913
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
914
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
915
- },
916
- /**
917
- * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
918
- * @summary Delete a value framework
919
- * @param {string} valueFrameworkId UUID of the value framework
920
- * @param {*} [options] Override http request option.
921
- * @throws {RequiredError}
922
- */
923
- async deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
924
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteValueFramework(valueFrameworkId, options);
925
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
926
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.deleteValueFramework']?.[localVarOperationServerIndex]?.url;
927
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
928
- },
929
- /**
930
- * Retrieve a paginated list of all metric costs for a specific value framework.
931
- * @summary List all metric costs for a value framework
932
- * @param {string} valueFrameworkId UUID of the value framework
933
- * @param {number} [offset] Number of records to skip
934
- * @param {number} [limit] Max number of records to return
935
- * @param {*} [options] Override http request option.
936
- * @throws {RequiredError}
937
- */
938
- async getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
939
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCostsForValueFramework(valueFrameworkId, offset, limit, options);
940
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
941
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getCostsForValueFramework']?.[localVarOperationServerIndex]?.url;
942
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
943
- },
944
- /**
945
- * Retrieve a paginated list of metric costs for a specific metric within a value framework.
946
- * @summary List metric costs for a value framework filtered by metric
947
- * @param {string} metricId UUID of the metric
948
- * @param {string} valueFrameworkId UUID of the value framework
949
- * @param {number} [offset] Number of records to skip
950
- * @param {number} [limit] Max number of records to return
951
- * @param {*} [options] Override http request option.
952
- * @throws {RequiredError}
953
- */
954
- async getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
955
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options);
956
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
957
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getCostsForValueFrameworkByMetric']?.[localVarOperationServerIndex]?.url;
958
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
959
- },
960
- /**
961
- * Retrieve cost data for a specific metric within this framework for a given year.
962
- * @summary Get a yearly metric cost for this framework
963
- * @param {string} metricId UUID of the metric
964
- * @param {number} year Year (1600-3000)
965
- * @param {string} valueFrameworkId UUID of the value framework
966
- * @param {*} [options] Override http request option.
967
- * @throws {RequiredError}
968
- */
969
- async getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
970
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostForFramework(metricId, year, valueFrameworkId, options);
971
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
972
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
973
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
974
- },
975
- /**
976
- * Retrieve a paginated list of all yearly metric costs for a specific framework.
977
- * @summary List yearly metric costs for this framework
978
- * @param {string} valueFrameworkId UUID of the value framework
979
- * @param {number} [offset] Number of records to skip
980
- * @param {number} [limit] Max number of records to return
981
- * @param {*} [options] Override http request option.
982
- * @throws {RequiredError}
983
- */
984
- async getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
985
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostsForFramework(valueFrameworkId, offset, limit, options);
986
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
987
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getMetricCostsForFramework']?.[localVarOperationServerIndex]?.url;
988
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
989
- },
990
- /**
991
- * Retrieve the weight for a specific objective within this framework.
992
- * @summary Get an objective weight for this framework
993
- * @param {string} objectiveId UUID of the objective
994
- * @param {string} valueFrameworkId UUID of the value framework
995
- * @param {*} [options] Override http request option.
996
- * @throws {RequiredError}
997
- */
998
- async getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>> {
999
- const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options);
1000
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1001
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
1002
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1003
- },
1004
- /**
1005
- * Retrieve a paginated list of all objective weights for a specific framework.
1006
- * @summary List objective weights for this framework
1007
- * @param {string} valueFrameworkId UUID of the value framework
1008
- * @param {number} [offset] Number of records to skip
1009
- * @param {number} [limit] Max number of records to return
1010
- * @param {*} [options] Override http request option.
1011
- * @throws {RequiredError}
1012
- */
1013
- async getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>> {
1014
- const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options);
1015
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1016
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getObjectiveWeightsForFramework']?.[localVarOperationServerIndex]?.url;
1017
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1018
- },
1019
- /**
1020
- * Retrieve a single value framework by its ID.
1021
- * @summary Get a value framework by ID
1022
- * @param {string} valueFrameworkId UUID of the value framework
1023
- * @param {*} [options] Override http request option.
1024
- * @throws {RequiredError}
1025
- */
1026
- async getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>> {
1027
- const localVarAxiosArgs = await localVarAxiosParamCreator.getValueFrameworkById(valueFrameworkId, options);
1028
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1029
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getValueFrameworkById']?.[localVarOperationServerIndex]?.url;
1030
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1031
- },
1032
- /**
1033
- * Retrieve a paginated list of all value frameworks.
1034
- * @summary List value frameworks
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ async getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValueFrameworkResponse>> {
266
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getValueFrameworkById(valueFrameworkId, options);
267
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
268
+ const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getValueFrameworkById']?.[localVarOperationServerIndex]?.url;
269
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
270
+ },
271
+ /**
272
+ * Retrieve a paginated list of all value frameworks.
273
+ * @summary List value frameworks
1035
274
  * @param {number} [offset] Number of records to skip
1036
275
  * @param {number} [limit] Max number of records to return
1037
276
  * @param {*} [options] Override http request option.
@@ -1043,52 +282,6 @@ export const ValueFrameworkApiFp = function(configuration?: Configuration) {
1043
282
  const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getValueFrameworks']?.[localVarOperationServerIndex]?.url;
1044
283
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1045
284
  },
1046
- /**
1047
- * Retrieve a paginated list of all objective weights for a specific value framework.
1048
- * @summary List all objective weights for a value framework
1049
- * @param {string} valueFrameworkId UUID of the value framework
1050
- * @param {number} [offset] Number of records to skip
1051
- * @param {number} [limit] Max number of records to return
1052
- * @param {*} [options] Override http request option.
1053
- * @throws {RequiredError}
1054
- */
1055
- async getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>> {
1056
- const localVarAxiosArgs = await localVarAxiosParamCreator.getWeightsForValueFramework(valueFrameworkId, offset, limit, options);
1057
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1058
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.getWeightsForValueFramework']?.[localVarOperationServerIndex]?.url;
1059
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1060
- },
1061
- /**
1062
- * Update the perceived and/or direct cost of a metric for a specific year within this framework.
1063
- * @summary Partially update metric costs for this framework
1064
- * @param {string} metricId UUID of the metric
1065
- * @param {number} year Year (1600-3000)
1066
- * @param {string} valueFrameworkId UUID of the value framework
1067
- * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
1068
- * @param {*} [options] Override http request option.
1069
- * @throws {RequiredError}
1070
- */
1071
- async patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
1072
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options);
1073
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1074
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.patchMetricCostForFramework']?.[localVarOperationServerIndex]?.url;
1075
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1076
- },
1077
- /**
1078
- * Update the weight of an objective within this value framework.
1079
- * @summary Partially update an objective weight for this framework
1080
- * @param {string} objectiveId UUID of the objective
1081
- * @param {string} valueFrameworkId UUID of the value framework
1082
- * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
1083
- * @param {*} [options] Override http request option.
1084
- * @throws {RequiredError}
1085
- */
1086
- async patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>> {
1087
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options);
1088
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1089
- const localVarOperationServerBasePath = operationServerMap['ValueFrameworkApi.patchObjectiveWeightForFramework']?.[localVarOperationServerIndex]?.url;
1090
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1091
- },
1092
285
  /**
1093
286
  * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1094
287
  * @summary Partially update a value framework
@@ -1125,51 +318,6 @@ export const ValueFrameworkApiFp = function(configuration?: Configuration) {
1125
318
  export const ValueFrameworkApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1126
319
  const localVarFp = ValueFrameworkApiFp(configuration)
1127
320
  return {
1128
- /**
1129
- * Create a yearly cost override for a metric within this framework.
1130
- * @summary Create a yearly metric cost for this framework
1131
- * @param {string} valueFrameworkId UUID of the value framework
1132
- * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
1133
- * @param {*} [options] Override http request option.
1134
- * @throws {RequiredError}
1135
- */
1136
- createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
1137
- return localVarFp.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
1138
- },
1139
- /**
1140
- * Assign a weight to an objective within this framework.
1141
- * @summary Create an objective weight for this framework
1142
- * @param {string} valueFrameworkId UUID of the value framework
1143
- * @param {ObjectiveWeightCreate} objectiveWeightCreate
1144
- * @param {*} [options] Override http request option.
1145
- * @throws {RequiredError}
1146
- */
1147
- createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse> {
1148
- return localVarFp.createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options).then((request) => request(axios, basePath));
1149
- },
1150
- /**
1151
- * Delete a metric cost entry for a specific year within this framework.
1152
- * @summary Delete metric costs for this framework
1153
- * @param {string} metricId UUID of the metric
1154
- * @param {number} year Year (1600-3000)
1155
- * @param {string} valueFrameworkId UUID of the value framework
1156
- * @param {*} [options] Override http request option.
1157
- * @throws {RequiredError}
1158
- */
1159
- deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1160
- return localVarFp.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
1161
- },
1162
- /**
1163
- * Remove an objective weight from this framework.
1164
- * @summary Delete an objective weight for this framework
1165
- * @param {string} objectiveId UUID of the objective
1166
- * @param {string} valueFrameworkId UUID of the value framework
1167
- * @param {*} [options] Override http request option.
1168
- * @throws {RequiredError}
1169
- */
1170
- deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1171
- return localVarFp.deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(axios, basePath));
1172
- },
1173
321
  /**
1174
322
  * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
1175
323
  * @summary Delete a value framework
@@ -1180,78 +328,6 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
1180
328
  deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1181
329
  return localVarFp.deleteValueFramework(valueFrameworkId, options).then((request) => request(axios, basePath));
1182
330
  },
1183
- /**
1184
- * Retrieve a paginated list of all metric costs for a specific value framework.
1185
- * @summary List all metric costs for a value framework
1186
- * @param {string} valueFrameworkId UUID of the value framework
1187
- * @param {number} [offset] Number of records to skip
1188
- * @param {number} [limit] Max number of records to return
1189
- * @param {*} [options] Override http request option.
1190
- * @throws {RequiredError}
1191
- */
1192
- getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
1193
- return localVarFp.getCostsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1194
- },
1195
- /**
1196
- * Retrieve a paginated list of metric costs for a specific metric within a value framework.
1197
- * @summary List metric costs for a value framework filtered by metric
1198
- * @param {string} metricId UUID of the metric
1199
- * @param {string} valueFrameworkId UUID of the value framework
1200
- * @param {number} [offset] Number of records to skip
1201
- * @param {number} [limit] Max number of records to return
1202
- * @param {*} [options] Override http request option.
1203
- * @throws {RequiredError}
1204
- */
1205
- getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
1206
- return localVarFp.getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1207
- },
1208
- /**
1209
- * Retrieve cost data for a specific metric within this framework for a given year.
1210
- * @summary Get a yearly metric cost for this framework
1211
- * @param {string} metricId UUID of the metric
1212
- * @param {number} year Year (1600-3000)
1213
- * @param {string} valueFrameworkId UUID of the value framework
1214
- * @param {*} [options] Override http request option.
1215
- * @throws {RequiredError}
1216
- */
1217
- getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
1218
- return localVarFp.getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
1219
- },
1220
- /**
1221
- * Retrieve a paginated list of all yearly metric costs for a specific framework.
1222
- * @summary List yearly metric costs for this framework
1223
- * @param {string} valueFrameworkId UUID of the value framework
1224
- * @param {number} [offset] Number of records to skip
1225
- * @param {number} [limit] Max number of records to return
1226
- * @param {*} [options] Override http request option.
1227
- * @throws {RequiredError}
1228
- */
1229
- getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
1230
- return localVarFp.getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1231
- },
1232
- /**
1233
- * Retrieve the weight for a specific objective within this framework.
1234
- * @summary Get an objective weight for this framework
1235
- * @param {string} objectiveId UUID of the objective
1236
- * @param {string} valueFrameworkId UUID of the value framework
1237
- * @param {*} [options] Override http request option.
1238
- * @throws {RequiredError}
1239
- */
1240
- getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse> {
1241
- return localVarFp.getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(axios, basePath));
1242
- },
1243
- /**
1244
- * Retrieve a paginated list of all objective weights for a specific framework.
1245
- * @summary List objective weights for this framework
1246
- * @param {string} valueFrameworkId UUID of the value framework
1247
- * @param {number} [offset] Number of records to skip
1248
- * @param {number} [limit] Max number of records to return
1249
- * @param {*} [options] Override http request option.
1250
- * @throws {RequiredError}
1251
- */
1252
- getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>> {
1253
- return localVarFp.getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1254
- },
1255
331
  /**
1256
332
  * Retrieve a single value framework by its ID.
1257
333
  * @summary Get a value framework by ID
@@ -1273,43 +349,6 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
1273
349
  getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ValueFrameworkResponse>> {
1274
350
  return localVarFp.getValueFrameworks(offset, limit, options).then((request) => request(axios, basePath));
1275
351
  },
1276
- /**
1277
- * Retrieve a paginated list of all objective weights for a specific value framework.
1278
- * @summary List all objective weights for a value framework
1279
- * @param {string} valueFrameworkId UUID of the value framework
1280
- * @param {number} [offset] Number of records to skip
1281
- * @param {number} [limit] Max number of records to return
1282
- * @param {*} [options] Override http request option.
1283
- * @throws {RequiredError}
1284
- */
1285
- getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>> {
1286
- return localVarFp.getWeightsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1287
- },
1288
- /**
1289
- * Update the perceived and/or direct cost of a metric for a specific year within this framework.
1290
- * @summary Partially update metric costs for this framework
1291
- * @param {string} metricId UUID of the metric
1292
- * @param {number} year Year (1600-3000)
1293
- * @param {string} valueFrameworkId UUID of the value framework
1294
- * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
1295
- * @param {*} [options] Override http request option.
1296
- * @throws {RequiredError}
1297
- */
1298
- patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
1299
- return localVarFp.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
1300
- },
1301
- /**
1302
- * Update the weight of an objective within this value framework.
1303
- * @summary Partially update an objective weight for this framework
1304
- * @param {string} objectiveId UUID of the objective
1305
- * @param {string} valueFrameworkId UUID of the value framework
1306
- * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
1307
- * @param {*} [options] Override http request option.
1308
- * @throws {RequiredError}
1309
- */
1310
- patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse> {
1311
- return localVarFp.patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options).then((request) => request(axios, basePath));
1312
- },
1313
352
  /**
1314
353
  * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1315
354
  * @summary Partially update a value framework
@@ -1338,55 +377,6 @@ export const ValueFrameworkApiFactory = function (configuration?: Configuration,
1338
377
  * ValueFrameworkApi - object-oriented interface
1339
378
  */
1340
379
  export class ValueFrameworkApi extends BaseAPI {
1341
- /**
1342
- * Create a yearly cost override for a metric within this framework.
1343
- * @summary Create a yearly metric cost for this framework
1344
- * @param {string} valueFrameworkId UUID of the value framework
1345
- * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
1346
- * @param {*} [options] Override http request option.
1347
- * @throws {RequiredError}
1348
- */
1349
- public createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) {
1350
- return ValueFrameworkApiFp(this.configuration).createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
1351
- }
1352
-
1353
- /**
1354
- * Assign a weight to an objective within this framework.
1355
- * @summary Create an objective weight for this framework
1356
- * @param {string} valueFrameworkId UUID of the value framework
1357
- * @param {ObjectiveWeightCreate} objectiveWeightCreate
1358
- * @param {*} [options] Override http request option.
1359
- * @throws {RequiredError}
1360
- */
1361
- public createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig) {
1362
- return ValueFrameworkApiFp(this.configuration).createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options).then((request) => request(this.axios, this.basePath));
1363
- }
1364
-
1365
- /**
1366
- * Delete a metric cost entry for a specific year within this framework.
1367
- * @summary Delete metric costs for this framework
1368
- * @param {string} metricId UUID of the metric
1369
- * @param {number} year Year (1600-3000)
1370
- * @param {string} valueFrameworkId UUID of the value framework
1371
- * @param {*} [options] Override http request option.
1372
- * @throws {RequiredError}
1373
- */
1374
- public deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1375
- return ValueFrameworkApiFp(this.configuration).deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1376
- }
1377
-
1378
- /**
1379
- * Remove an objective weight from this framework.
1380
- * @summary Delete an objective weight for this framework
1381
- * @param {string} objectiveId UUID of the objective
1382
- * @param {string} valueFrameworkId UUID of the value framework
1383
- * @param {*} [options] Override http request option.
1384
- * @throws {RequiredError}
1385
- */
1386
- public deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1387
- return ValueFrameworkApiFp(this.configuration).deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1388
- }
1389
-
1390
380
  /**
1391
381
  * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
1392
382
  * @summary Delete a value framework
@@ -1398,84 +388,6 @@ export class ValueFrameworkApi extends BaseAPI {
1398
388
  return ValueFrameworkApiFp(this.configuration).deleteValueFramework(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1399
389
  }
1400
390
 
1401
- /**
1402
- * Retrieve a paginated list of all metric costs for a specific value framework.
1403
- * @summary List all metric costs for a value framework
1404
- * @param {string} valueFrameworkId UUID of the value framework
1405
- * @param {number} [offset] Number of records to skip
1406
- * @param {number} [limit] Max number of records to return
1407
- * @param {*} [options] Override http request option.
1408
- * @throws {RequiredError}
1409
- */
1410
- public getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
1411
- return ValueFrameworkApiFp(this.configuration).getCostsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1412
- }
1413
-
1414
- /**
1415
- * Retrieve a paginated list of metric costs for a specific metric within a value framework.
1416
- * @summary List metric costs for a value framework filtered by metric
1417
- * @param {string} metricId UUID of the metric
1418
- * @param {string} valueFrameworkId UUID of the value framework
1419
- * @param {number} [offset] Number of records to skip
1420
- * @param {number} [limit] Max number of records to return
1421
- * @param {*} [options] Override http request option.
1422
- * @throws {RequiredError}
1423
- */
1424
- public getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
1425
- return ValueFrameworkApiFp(this.configuration).getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1426
- }
1427
-
1428
- /**
1429
- * Retrieve cost data for a specific metric within this framework for a given year.
1430
- * @summary Get a yearly metric cost for this framework
1431
- * @param {string} metricId UUID of the metric
1432
- * @param {number} year Year (1600-3000)
1433
- * @param {string} valueFrameworkId UUID of the value framework
1434
- * @param {*} [options] Override http request option.
1435
- * @throws {RequiredError}
1436
- */
1437
- public getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1438
- return ValueFrameworkApiFp(this.configuration).getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1439
- }
1440
-
1441
- /**
1442
- * Retrieve a paginated list of all yearly metric costs for a specific framework.
1443
- * @summary List yearly metric costs for this framework
1444
- * @param {string} valueFrameworkId UUID of the value framework
1445
- * @param {number} [offset] Number of records to skip
1446
- * @param {number} [limit] Max number of records to return
1447
- * @param {*} [options] Override http request option.
1448
- * @throws {RequiredError}
1449
- */
1450
- public getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
1451
- return ValueFrameworkApiFp(this.configuration).getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1452
- }
1453
-
1454
- /**
1455
- * Retrieve the weight for a specific objective within this framework.
1456
- * @summary Get an objective weight for this framework
1457
- * @param {string} objectiveId UUID of the objective
1458
- * @param {string} valueFrameworkId UUID of the value framework
1459
- * @param {*} [options] Override http request option.
1460
- * @throws {RequiredError}
1461
- */
1462
- public getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1463
- return ValueFrameworkApiFp(this.configuration).getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1464
- }
1465
-
1466
- /**
1467
- * Retrieve a paginated list of all objective weights for a specific framework.
1468
- * @summary List objective weights for this framework
1469
- * @param {string} valueFrameworkId UUID of the value framework
1470
- * @param {number} [offset] Number of records to skip
1471
- * @param {number} [limit] Max number of records to return
1472
- * @param {*} [options] Override http request option.
1473
- * @throws {RequiredError}
1474
- */
1475
- public getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
1476
- return ValueFrameworkApiFp(this.configuration).getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1477
- }
1478
-
1479
391
  /**
1480
392
  * Retrieve a single value framework by its ID.
1481
393
  * @summary Get a value framework by ID
@@ -1499,46 +411,6 @@ export class ValueFrameworkApi extends BaseAPI {
1499
411
  return ValueFrameworkApiFp(this.configuration).getValueFrameworks(offset, limit, options).then((request) => request(this.axios, this.basePath));
1500
412
  }
1501
413
 
1502
- /**
1503
- * Retrieve a paginated list of all objective weights for a specific value framework.
1504
- * @summary List all objective weights for a value framework
1505
- * @param {string} valueFrameworkId UUID of the value framework
1506
- * @param {number} [offset] Number of records to skip
1507
- * @param {number} [limit] Max number of records to return
1508
- * @param {*} [options] Override http request option.
1509
- * @throws {RequiredError}
1510
- */
1511
- public getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
1512
- return ValueFrameworkApiFp(this.configuration).getWeightsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1513
- }
1514
-
1515
- /**
1516
- * Update the perceived and/or direct cost of a metric for a specific year within this framework.
1517
- * @summary Partially update metric costs for this framework
1518
- * @param {string} metricId UUID of the metric
1519
- * @param {number} year Year (1600-3000)
1520
- * @param {string} valueFrameworkId UUID of the value framework
1521
- * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
1522
- * @param {*} [options] Override http request option.
1523
- * @throws {RequiredError}
1524
- */
1525
- public patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) {
1526
- return ValueFrameworkApiFp(this.configuration).patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
1527
- }
1528
-
1529
- /**
1530
- * Update the weight of an objective within this value framework.
1531
- * @summary Partially update an objective weight for this framework
1532
- * @param {string} objectiveId UUID of the objective
1533
- * @param {string} valueFrameworkId UUID of the value framework
1534
- * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
1535
- * @param {*} [options] Override http request option.
1536
- * @throws {RequiredError}
1537
- */
1538
- public patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) {
1539
- return ValueFrameworkApiFp(this.configuration).patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options).then((request) => request(this.axios, this.basePath));
1540
- }
1541
-
1542
414
  /**
1543
415
  * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1544
416
  * @summary Partially update a value framework