@cosmotech/aip-client 0.3.0-dev2 → 0.3.0-dev3

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 (343) hide show
  1. package/README.md +4 -40
  2. package/api/budget-api.ts +1 -1
  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 +1 -454
  13. package/api/preferred-option-api.ts +1 -1
  14. package/api/value-framework-api.ts +61 -1189
  15. package/api/value-framework-costs-api.ts +1 -1
  16. package/api/value-framework-weights-api.ts +1 -1
  17. package/api.ts +1 -1
  18. package/base.ts +1 -1
  19. package/common.ts +1 -1
  20. package/configuration.ts +1 -1
  21. package/dist/api/budget-api.d.ts +1 -1
  22. package/dist/api/budget-api.js +1 -1
  23. package/dist/api/default-api.d.ts +1 -1
  24. package/dist/api/default-api.js +1 -1
  25. package/dist/api/impact-api.d.ts +42 -1
  26. package/dist/api/impact-api.js +85 -1
  27. package/dist/api/investment-api.d.ts +1 -551
  28. package/dist/api/investment-api.js +57 -1189
  29. package/dist/api/metric-api.d.ts +1 -1
  30. package/dist/api/metric-api.js +1 -1
  31. package/dist/api/metric-costs-api.d.ts +1 -1
  32. package/dist/api/metric-costs-api.js +1 -1
  33. package/dist/api/metric-costs-per-year-api.d.ts +1 -1
  34. package/dist/api/metric-costs-per-year-api.js +1 -1
  35. package/dist/api/objective-api.d.ts +1 -233
  36. package/dist/api/objective-api.js +1 -479
  37. package/dist/api/objective-weight-api.d.ts +1 -1
  38. package/dist/api/objective-weight-api.js +1 -1
  39. package/dist/api/objective-weights-api.d.ts +1 -1
  40. package/dist/api/objective-weights-api.js +1 -1
  41. package/dist/api/option-api.d.ts +1 -212
  42. package/dist/api/option-api.js +1 -431
  43. package/dist/api/preferred-option-api.d.ts +1 -1
  44. package/dist/api/preferred-option-api.js +1 -1
  45. package/dist/api/value-framework-api.d.ts +1 -519
  46. package/dist/api/value-framework-api.js +61 -1128
  47. package/dist/api/value-framework-costs-api.d.ts +1 -1
  48. package/dist/api/value-framework-costs-api.js +1 -1
  49. package/dist/api/value-framework-weights-api.d.ts +1 -1
  50. package/dist/api/value-framework-weights-api.js +1 -1
  51. package/dist/api.d.ts +1 -1
  52. package/dist/api.js +1 -1
  53. package/dist/base.d.ts +1 -1
  54. package/dist/base.js +1 -1
  55. package/dist/common.d.ts +1 -1
  56. package/dist/common.js +1 -1
  57. package/dist/configuration.d.ts +1 -1
  58. package/dist/configuration.js +1 -1
  59. package/dist/esm/api/budget-api.d.ts +1 -1
  60. package/dist/esm/api/budget-api.js +1 -1
  61. package/dist/esm/api/default-api.d.ts +1 -1
  62. package/dist/esm/api/default-api.js +1 -1
  63. package/dist/esm/api/impact-api.d.ts +42 -1
  64. package/dist/esm/api/impact-api.js +85 -1
  65. package/dist/esm/api/investment-api.d.ts +1 -551
  66. package/dist/esm/api/investment-api.js +56 -1188
  67. package/dist/esm/api/metric-api.d.ts +1 -1
  68. package/dist/esm/api/metric-api.js +1 -1
  69. package/dist/esm/api/metric-costs-api.d.ts +1 -1
  70. package/dist/esm/api/metric-costs-api.js +1 -1
  71. package/dist/esm/api/metric-costs-per-year-api.d.ts +1 -1
  72. package/dist/esm/api/metric-costs-per-year-api.js +1 -1
  73. package/dist/esm/api/objective-api.d.ts +1 -233
  74. package/dist/esm/api/objective-api.js +1 -479
  75. package/dist/esm/api/objective-weight-api.d.ts +1 -1
  76. package/dist/esm/api/objective-weight-api.js +1 -1
  77. package/dist/esm/api/objective-weights-api.d.ts +1 -1
  78. package/dist/esm/api/objective-weights-api.js +1 -1
  79. package/dist/esm/api/option-api.d.ts +1 -212
  80. package/dist/esm/api/option-api.js +1 -431
  81. package/dist/esm/api/preferred-option-api.d.ts +1 -1
  82. package/dist/esm/api/preferred-option-api.js +1 -1
  83. package/dist/esm/api/value-framework-api.d.ts +1 -519
  84. package/dist/esm/api/value-framework-api.js +61 -1128
  85. package/dist/esm/api/value-framework-costs-api.d.ts +1 -1
  86. package/dist/esm/api/value-framework-costs-api.js +1 -1
  87. package/dist/esm/api/value-framework-weights-api.d.ts +1 -1
  88. package/dist/esm/api/value-framework-weights-api.js +1 -1
  89. package/dist/esm/api.d.ts +1 -1
  90. package/dist/esm/api.js +1 -1
  91. package/dist/esm/base.d.ts +1 -1
  92. package/dist/esm/base.js +1 -1
  93. package/dist/esm/common.d.ts +1 -1
  94. package/dist/esm/common.js +1 -1
  95. package/dist/esm/configuration.d.ts +1 -1
  96. package/dist/esm/configuration.js +1 -1
  97. package/dist/esm/index.d.ts +1 -1
  98. package/dist/esm/index.js +1 -1
  99. package/dist/esm/models/budget-bulk-delete-request.d.ts +1 -1
  100. package/dist/esm/models/budget-bulk-delete-request.js +1 -1
  101. package/dist/esm/models/budget-create.d.ts +1 -1
  102. package/dist/esm/models/budget-create.js +1 -1
  103. package/dist/esm/models/budget-investment-response.d.ts +1 -1
  104. package/dist/esm/models/budget-investment-response.js +1 -1
  105. package/dist/esm/models/budget-link-options-request.d.ts +1 -1
  106. package/dist/esm/models/budget-link-options-request.js +1 -1
  107. package/dist/esm/models/budget-option-response.d.ts +1 -1
  108. package/dist/esm/models/budget-option-response.js +1 -1
  109. package/dist/esm/models/budget-overview-response.d.ts +1 -1
  110. package/dist/esm/models/budget-overview-response.js +1 -1
  111. package/dist/esm/models/budget-response.d.ts +1 -1
  112. package/dist/esm/models/budget-response.js +1 -1
  113. package/dist/esm/models/budget-update.d.ts +1 -1
  114. package/dist/esm/models/budget-update.js +1 -1
  115. package/dist/esm/models/bulk-delete-request.d.ts +1 -1
  116. package/dist/esm/models/bulk-delete-request.js +1 -1
  117. package/dist/esm/models/evolution-type.d.ts +1 -1
  118. package/dist/esm/models/evolution-type.js +1 -1
  119. package/dist/esm/models/httpvalidation-error.d.ts +1 -1
  120. package/dist/esm/models/httpvalidation-error.js +1 -1
  121. package/dist/esm/models/impact-apiresponse.d.ts +1 -1
  122. package/dist/esm/models/impact-apiresponse.js +1 -1
  123. package/dist/esm/models/impact-bulk-item.d.ts +37 -0
  124. package/dist/esm/models/impact-bulk-item.js +14 -0
  125. package/dist/esm/models/impact-create.d.ts +1 -1
  126. package/dist/esm/models/impact-create.js +1 -1
  127. package/dist/esm/models/impact-update.d.ts +1 -1
  128. package/dist/esm/models/impact-update.js +1 -1
  129. package/dist/esm/models/index.d.ts +1 -0
  130. package/dist/esm/models/index.js +1 -0
  131. package/dist/esm/models/investment-create.d.ts +1 -1
  132. package/dist/esm/models/investment-create.js +1 -1
  133. package/dist/esm/models/investment-overview-response.d.ts +1 -1
  134. package/dist/esm/models/investment-overview-response.js +1 -1
  135. package/dist/esm/models/investment-response.d.ts +1 -1
  136. package/dist/esm/models/investment-response.js +1 -1
  137. package/dist/esm/models/investment-update.d.ts +1 -1
  138. package/dist/esm/models/investment-update.js +1 -1
  139. package/dist/esm/models/location-inner.d.ts +1 -1
  140. package/dist/esm/models/location-inner.js +1 -1
  141. package/dist/esm/models/measurement-type.d.ts +1 -1
  142. package/dist/esm/models/measurement-type.js +1 -1
  143. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
  144. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  145. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
  146. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  147. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
  148. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  149. package/dist/esm/models/metric-create.d.ts +1 -1
  150. package/dist/esm/models/metric-create.js +1 -1
  151. package/dist/esm/models/metric-response.d.ts +1 -1
  152. package/dist/esm/models/metric-response.js +1 -1
  153. package/dist/esm/models/metric-type.d.ts +1 -1
  154. package/dist/esm/models/metric-type.js +1 -1
  155. package/dist/esm/models/metric-update.d.ts +1 -1
  156. package/dist/esm/models/metric-update.js +1 -1
  157. package/dist/esm/models/objective-create.d.ts +1 -1
  158. package/dist/esm/models/objective-create.js +1 -1
  159. package/dist/esm/models/objective-response.d.ts +1 -1
  160. package/dist/esm/models/objective-response.js +1 -1
  161. package/dist/esm/models/objective-update.d.ts +1 -1
  162. package/dist/esm/models/objective-update.js +1 -1
  163. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  164. package/dist/esm/models/objective-weight-create.js +1 -1
  165. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  166. package/dist/esm/models/objective-weight-response.js +1 -1
  167. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  168. package/dist/esm/models/objective-weight-update.js +1 -1
  169. package/dist/esm/models/option-chart-kpi.d.ts +1 -1
  170. package/dist/esm/models/option-chart-kpi.js +1 -1
  171. package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
  172. package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
  173. package/dist/esm/models/option-create.d.ts +1 -1
  174. package/dist/esm/models/option-create.js +1 -1
  175. package/dist/esm/models/option-overview-response.d.ts +1 -1
  176. package/dist/esm/models/option-overview-response.js +1 -1
  177. package/dist/esm/models/option-response.d.ts +1 -1
  178. package/dist/esm/models/option-response.js +1 -1
  179. package/dist/esm/models/option-update.d.ts +1 -1
  180. package/dist/esm/models/option-update.js +1 -1
  181. package/dist/esm/models/preferred-option-request.d.ts +1 -1
  182. package/dist/esm/models/preferred-option-request.js +1 -1
  183. package/dist/esm/models/preferred-option-response.d.ts +1 -1
  184. package/dist/esm/models/preferred-option-response.js +1 -1
  185. package/dist/esm/models/validation-error.d.ts +1 -1
  186. package/dist/esm/models/validation-error.js +1 -1
  187. package/dist/esm/models/value-framework-create.d.ts +1 -1
  188. package/dist/esm/models/value-framework-create.js +1 -1
  189. package/dist/esm/models/value-framework-response.d.ts +1 -1
  190. package/dist/esm/models/value-framework-response.js +1 -1
  191. package/dist/esm/models/value-framework-update.d.ts +1 -1
  192. package/dist/esm/models/value-framework-update.js +1 -1
  193. package/dist/index.d.ts +1 -1
  194. package/dist/index.js +1 -1
  195. package/dist/models/budget-bulk-delete-request.d.ts +1 -1
  196. package/dist/models/budget-bulk-delete-request.js +1 -1
  197. package/dist/models/budget-create.d.ts +1 -1
  198. package/dist/models/budget-create.js +1 -1
  199. package/dist/models/budget-investment-response.d.ts +1 -1
  200. package/dist/models/budget-investment-response.js +1 -1
  201. package/dist/models/budget-link-options-request.d.ts +1 -1
  202. package/dist/models/budget-link-options-request.js +1 -1
  203. package/dist/models/budget-option-response.d.ts +1 -1
  204. package/dist/models/budget-option-response.js +1 -1
  205. package/dist/models/budget-overview-response.d.ts +1 -1
  206. package/dist/models/budget-overview-response.js +1 -1
  207. package/dist/models/budget-response.d.ts +1 -1
  208. package/dist/models/budget-response.js +1 -1
  209. package/dist/models/budget-update.d.ts +1 -1
  210. package/dist/models/budget-update.js +1 -1
  211. package/dist/models/bulk-delete-request.d.ts +1 -1
  212. package/dist/models/bulk-delete-request.js +1 -1
  213. package/dist/models/evolution-type.d.ts +1 -1
  214. package/dist/models/evolution-type.js +1 -1
  215. package/dist/models/httpvalidation-error.d.ts +1 -1
  216. package/dist/models/httpvalidation-error.js +1 -1
  217. package/dist/models/impact-apiresponse.d.ts +1 -1
  218. package/dist/models/impact-apiresponse.js +1 -1
  219. package/dist/models/impact-bulk-item.d.ts +37 -0
  220. package/dist/models/impact-bulk-item.js +15 -0
  221. package/dist/models/impact-create.d.ts +1 -1
  222. package/dist/models/impact-create.js +1 -1
  223. package/dist/models/impact-update.d.ts +1 -1
  224. package/dist/models/impact-update.js +1 -1
  225. package/dist/models/index.d.ts +1 -0
  226. package/dist/models/index.js +1 -0
  227. package/dist/models/investment-create.d.ts +1 -1
  228. package/dist/models/investment-create.js +1 -1
  229. package/dist/models/investment-overview-response.d.ts +1 -1
  230. package/dist/models/investment-overview-response.js +1 -1
  231. package/dist/models/investment-response.d.ts +1 -1
  232. package/dist/models/investment-response.js +1 -1
  233. package/dist/models/investment-update.d.ts +1 -1
  234. package/dist/models/investment-update.js +1 -1
  235. package/dist/models/location-inner.d.ts +1 -1
  236. package/dist/models/location-inner.js +1 -1
  237. package/dist/models/measurement-type.d.ts +1 -1
  238. package/dist/models/measurement-type.js +1 -1
  239. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  240. package/dist/models/metric-costs-per-year-create.js +1 -1
  241. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  242. package/dist/models/metric-costs-per-year-response.js +1 -1
  243. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  244. package/dist/models/metric-costs-per-year-update.js +1 -1
  245. package/dist/models/metric-create.d.ts +1 -1
  246. package/dist/models/metric-create.js +1 -1
  247. package/dist/models/metric-response.d.ts +1 -1
  248. package/dist/models/metric-response.js +1 -1
  249. package/dist/models/metric-type.d.ts +1 -1
  250. package/dist/models/metric-type.js +1 -1
  251. package/dist/models/metric-update.d.ts +1 -1
  252. package/dist/models/metric-update.js +1 -1
  253. package/dist/models/objective-create.d.ts +1 -1
  254. package/dist/models/objective-create.js +1 -1
  255. package/dist/models/objective-response.d.ts +1 -1
  256. package/dist/models/objective-response.js +1 -1
  257. package/dist/models/objective-update.d.ts +1 -1
  258. package/dist/models/objective-update.js +1 -1
  259. package/dist/models/objective-weight-create.d.ts +1 -1
  260. package/dist/models/objective-weight-create.js +1 -1
  261. package/dist/models/objective-weight-response.d.ts +1 -1
  262. package/dist/models/objective-weight-response.js +1 -1
  263. package/dist/models/objective-weight-update.d.ts +1 -1
  264. package/dist/models/objective-weight-update.js +1 -1
  265. package/dist/models/option-chart-kpi.d.ts +1 -1
  266. package/dist/models/option-chart-kpi.js +1 -1
  267. package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
  268. package/dist/models/option-chart-kpis-yearly.js +1 -1
  269. package/dist/models/option-create.d.ts +1 -1
  270. package/dist/models/option-create.js +1 -1
  271. package/dist/models/option-overview-response.d.ts +1 -1
  272. package/dist/models/option-overview-response.js +1 -1
  273. package/dist/models/option-response.d.ts +1 -1
  274. package/dist/models/option-response.js +1 -1
  275. package/dist/models/option-update.d.ts +1 -1
  276. package/dist/models/option-update.js +1 -1
  277. package/dist/models/preferred-option-request.d.ts +1 -1
  278. package/dist/models/preferred-option-request.js +1 -1
  279. package/dist/models/preferred-option-response.d.ts +1 -1
  280. package/dist/models/preferred-option-response.js +1 -1
  281. package/dist/models/validation-error.d.ts +1 -1
  282. package/dist/models/validation-error.js +1 -1
  283. package/dist/models/value-framework-create.d.ts +1 -1
  284. package/dist/models/value-framework-create.js +1 -1
  285. package/dist/models/value-framework-response.d.ts +1 -1
  286. package/dist/models/value-framework-response.js +1 -1
  287. package/dist/models/value-framework-update.d.ts +1 -1
  288. package/dist/models/value-framework-update.js +1 -1
  289. package/docs/ImpactApi.md +60 -0
  290. package/docs/ImpactBulkItem.md +29 -0
  291. package/docs/InvestmentApi.md +29 -851
  292. package/docs/ObjectiveApi.md +0 -351
  293. package/docs/OptionApi.md +0 -305
  294. package/docs/ValueFrameworkApi.md +7 -778
  295. package/index.ts +1 -1
  296. package/models/budget-bulk-delete-request.ts +1 -1
  297. package/models/budget-create.ts +1 -1
  298. package/models/budget-investment-response.ts +1 -1
  299. package/models/budget-link-options-request.ts +1 -1
  300. package/models/budget-option-response.ts +1 -1
  301. package/models/budget-overview-response.ts +1 -1
  302. package/models/budget-response.ts +1 -1
  303. package/models/budget-update.ts +1 -1
  304. package/models/bulk-delete-request.ts +1 -1
  305. package/models/evolution-type.ts +1 -1
  306. package/models/httpvalidation-error.ts +1 -1
  307. package/models/impact-apiresponse.ts +1 -1
  308. package/models/impact-bulk-item.ts +47 -0
  309. package/models/impact-create.ts +1 -1
  310. package/models/impact-update.ts +1 -1
  311. package/models/index.ts +1 -0
  312. package/models/investment-create.ts +1 -1
  313. package/models/investment-overview-response.ts +1 -1
  314. package/models/investment-response.ts +1 -1
  315. package/models/investment-update.ts +1 -1
  316. package/models/location-inner.ts +1 -1
  317. package/models/measurement-type.ts +1 -1
  318. package/models/metric-costs-per-year-create.ts +1 -1
  319. package/models/metric-costs-per-year-response.ts +1 -1
  320. package/models/metric-costs-per-year-update.ts +1 -1
  321. package/models/metric-create.ts +1 -1
  322. package/models/metric-response.ts +1 -1
  323. package/models/metric-type.ts +1 -1
  324. package/models/metric-update.ts +1 -1
  325. package/models/objective-create.ts +1 -1
  326. package/models/objective-response.ts +1 -1
  327. package/models/objective-update.ts +1 -1
  328. package/models/objective-weight-create.ts +1 -1
  329. package/models/objective-weight-response.ts +1 -1
  330. package/models/objective-weight-update.ts +1 -1
  331. package/models/option-chart-kpi.ts +1 -1
  332. package/models/option-chart-kpis-yearly.ts +1 -1
  333. package/models/option-create.ts +1 -1
  334. package/models/option-overview-response.ts +1 -1
  335. package/models/option-response.ts +1 -1
  336. package/models/option-update.ts +1 -1
  337. package/models/preferred-option-request.ts +1 -1
  338. package/models/preferred-option-response.ts +1 -1
  339. package/models/validation-error.ts +1 -1
  340. package/models/value-framework-create.ts +1 -1
  341. package/models/value-framework-response.ts +1 -1
  342. package/models/value-framework-update.ts +1 -1
  343. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0-dev1
5
+ * The version of the OpenAPI document: 0.3.0-dev3
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,20 +13,10 @@ import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
15
  import type { BulkDeleteRequest } from '../models';
16
- import type { ImpactAPIResponse } from '../models';
17
- import type { ImpactCreate } from '../models';
18
- import type { ImpactUpdate } from '../models';
19
16
  import type { InvestmentCreate } from '../models';
20
17
  import type { InvestmentOverviewResponse } from '../models';
21
18
  import type { InvestmentResponse } from '../models';
22
19
  import type { InvestmentUpdate } from '../models';
23
- import type { OptionChartKPIsYearly } from '../models';
24
- import type { OptionCreate } from '../models';
25
- import type { OptionOverviewResponse } from '../models';
26
- import type { OptionResponse } from '../models';
27
- import type { OptionUpdate } from '../models';
28
- import type { PreferredOptionRequest } from '../models';
29
- import type { PreferredOptionResponse } from '../models';
30
20
  /**
31
21
  * InvestmentApi - axios parameter creator
32
22
  */
@@ -39,35 +29,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
39
29
  * @throws {RequiredError}
40
30
  */
41
31
  bulkDeleteInvestments: (bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
42
- /**
43
- * Create a new impact under this option.
44
- * @summary Create an impact for this option
45
- * @param {string} optionId UUID of the option
46
- * @param {string} investmentId UUID of the investment
47
- * @param {ImpactCreate} impactCreate
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- createImpactForOption: (optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
52
- /**
53
- * Create a new option under this investment.
54
- * @summary Create an option for this investment
55
- * @param {string} investmentId UUID of the investment
56
- * @param {OptionCreate} optionCreate
57
- * @param {*} [options] Override http request option.
58
- * @throws {RequiredError}
59
- */
60
- createOptionForInvestment: (investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61
- /**
62
- * Delete an existing impact by its ID.
63
- * @summary Delete an impact for this option
64
- * @param {string} impactId UUID of the impact
65
- * @param {string} optionId UUID of the option
66
- * @param {string} investmentId UUID of the investment
67
- * @param {*} [options] Override http request option.
68
- * @throws {RequiredError}
69
- */
70
- deleteImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
71
32
  /**
72
33
  * Delete an existing investment by its ID. Associated options are also deleted via cascade.
73
34
  * @summary Delete an investment
@@ -76,36 +37,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
76
37
  * @throws {RequiredError}
77
38
  */
78
39
  deleteInvestment: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
79
- /**
80
- * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
81
- * @summary Delete an option for this investment
82
- * @param {string} optionId UUID of the option
83
- * @param {string} investmentId UUID of the investment
84
- * @param {*} [options] Override http request option.
85
- * @throws {RequiredError}
86
- */
87
- deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
88
- /**
89
- * Retrieve a specific impact for the option.
90
- * @summary Get an impact for this option
91
- * @param {string} impactId UUID of the impact
92
- * @param {string} optionId UUID of the option
93
- * @param {string} investmentId UUID of the investment
94
- * @param {*} [options] Override http request option.
95
- * @throws {RequiredError}
96
- */
97
- getImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
98
- /**
99
- * Retrieve a paginated list of all impacts for a specific option.
100
- * @summary List impacts for this option
101
- * @param {string} optionId UUID of the option
102
- * @param {string} investmentId UUID of the investment
103
- * @param {number} [offset] Number of records to skip
104
- * @param {number} [limit] Max number of records to return
105
- * @param {*} [options] Override http request option.
106
- * @throws {RequiredError}
107
- */
108
- getImpactsForOption: (optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
109
40
  /**
110
41
  * Retrieve a single investment by its ID.
111
42
  * @summary Get an investment by ID
@@ -131,63 +62,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
131
62
  * @throws {RequiredError}
132
63
  */
133
64
  getInvestmentsOverview: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
134
- /**
135
- * Retrieve a specific option for the investment.
136
- * @summary Get an option for this investment
137
- * @param {string} optionId UUID of the option
138
- * @param {string} investmentId UUID of the investment
139
- * @param {*} [options] Override http request option.
140
- * @throws {RequiredError}
141
- */
142
- getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
143
- /**
144
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
145
- * @summary Get the kpis for a given option inside a value framework
146
- * @param {string} investmentId UUID of the investment
147
- * @param {string} optionId UUID of the option
148
- * @param {string} valueFrameworkId UUID of the value framework
149
- * @param {*} [options] Override http request option.
150
- * @throws {RequiredError}
151
- */
152
- getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
153
- /**
154
- * Retrieve a paginated list of all options for a specific investment.
155
- * @summary List options for this investment
156
- * @param {string} investmentId UUID of the investment
157
- * @param {number} [offset] Number of records to skip
158
- * @param {number} [limit] Max number of records to return
159
- * @param {*} [options] Override http request option.
160
- * @throws {RequiredError}
161
- */
162
- getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
163
- /**
164
- * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
165
- * @summary Option overview table for this investment
166
- * @param {string} investmentId UUID of the investment
167
- * @param {string} valueFrameworkId UUID of the value framework
168
- * @param {*} [options] Override http request option.
169
- * @throws {RequiredError}
170
- */
171
- getOptionsOverview: (investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
172
- /**
173
- * Get the preferred option for an investment.
174
- * @summary Get the preferred option for an investment
175
- * @param {string} investmentId UUID of the investment
176
- * @param {*} [options] Override http request option.
177
- * @throws {RequiredError}
178
- */
179
- getPreferredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
180
- /**
181
- * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
182
- * @summary Partially update an impact for this option
183
- * @param {string} impactId UUID of the impact
184
- * @param {string} optionId UUID of the option
185
- * @param {string} investmentId UUID of the investment
186
- * @param {ImpactUpdate} impactUpdate
187
- * @param {*} [options] Override http request option.
188
- * @throws {RequiredError}
189
- */
190
- patchImpactForOption: (impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
191
65
  /**
192
66
  * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
193
67
  * @summary Partially update an investment
@@ -197,16 +71,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
197
71
  * @throws {RequiredError}
198
72
  */
199
73
  patchInvestment: (investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
200
- /**
201
- * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
202
- * @summary Partially update an option for this investment
203
- * @param {string} optionId UUID of the option
204
- * @param {string} investmentId UUID of the investment
205
- * @param {OptionUpdate} optionUpdate
206
- * @param {*} [options] Override http request option.
207
- * @throws {RequiredError}
208
- */
209
- patchOptionForInvestment: (optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
210
74
  /**
211
75
  * Create a new investment.
212
76
  * @summary Create an investment
@@ -215,15 +79,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
215
79
  * @throws {RequiredError}
216
80
  */
217
81
  postInvestment: (investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
218
- /**
219
- * Set the preferred option for an investment.
220
- * @summary Set the preferred option for an investment
221
- * @param {string} investmentId UUID of the investment
222
- * @param {PreferredOptionRequest} preferredOptionRequest
223
- * @param {*} [options] Override http request option.
224
- * @throws {RequiredError}
225
- */
226
- setPreferredOption: (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
227
82
  };
228
83
  /**
229
84
  * InvestmentApi - functional programming interface
@@ -237,35 +92,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
237
92
  * @throws {RequiredError}
238
93
  */
239
94
  bulkDeleteInvestments(bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
240
- /**
241
- * Create a new impact under this option.
242
- * @summary Create an impact for this option
243
- * @param {string} optionId UUID of the option
244
- * @param {string} investmentId UUID of the investment
245
- * @param {ImpactCreate} impactCreate
246
- * @param {*} [options] Override http request option.
247
- * @throws {RequiredError}
248
- */
249
- createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
250
- /**
251
- * Create a new option under this investment.
252
- * @summary Create an option for this investment
253
- * @param {string} investmentId UUID of the investment
254
- * @param {OptionCreate} optionCreate
255
- * @param {*} [options] Override http request option.
256
- * @throws {RequiredError}
257
- */
258
- createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
259
- /**
260
- * Delete an existing impact by its ID.
261
- * @summary Delete an impact for this option
262
- * @param {string} impactId UUID of the impact
263
- * @param {string} optionId UUID of the option
264
- * @param {string} investmentId UUID of the investment
265
- * @param {*} [options] Override http request option.
266
- * @throws {RequiredError}
267
- */
268
- deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
269
95
  /**
270
96
  * Delete an existing investment by its ID. Associated options are also deleted via cascade.
271
97
  * @summary Delete an investment
@@ -274,36 +100,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
274
100
  * @throws {RequiredError}
275
101
  */
276
102
  deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
277
- /**
278
- * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
279
- * @summary Delete an option for this investment
280
- * @param {string} optionId UUID of the option
281
- * @param {string} investmentId UUID of the investment
282
- * @param {*} [options] Override http request option.
283
- * @throws {RequiredError}
284
- */
285
- deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
286
- /**
287
- * Retrieve a specific impact for the option.
288
- * @summary Get an impact for this option
289
- * @param {string} impactId UUID of the impact
290
- * @param {string} optionId UUID of the option
291
- * @param {string} investmentId UUID of the investment
292
- * @param {*} [options] Override http request option.
293
- * @throws {RequiredError}
294
- */
295
- getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
296
- /**
297
- * Retrieve a paginated list of all impacts for a specific option.
298
- * @summary List impacts for this option
299
- * @param {string} optionId UUID of the option
300
- * @param {string} investmentId UUID of the investment
301
- * @param {number} [offset] Number of records to skip
302
- * @param {number} [limit] Max number of records to return
303
- * @param {*} [options] Override http request option.
304
- * @throws {RequiredError}
305
- */
306
- getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImpactAPIResponse>>>;
307
103
  /**
308
104
  * Retrieve a single investment by its ID.
309
105
  * @summary Get an investment by ID
@@ -329,63 +125,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
329
125
  * @throws {RequiredError}
330
126
  */
331
127
  getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>>;
332
- /**
333
- * Retrieve a specific option for the investment.
334
- * @summary Get an option for this investment
335
- * @param {string} optionId UUID of the option
336
- * @param {string} investmentId UUID of the investment
337
- * @param {*} [options] Override http request option.
338
- * @throws {RequiredError}
339
- */
340
- getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
341
- /**
342
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
343
- * @summary Get the kpis for a given option inside a value framework
344
- * @param {string} investmentId UUID of the investment
345
- * @param {string} optionId UUID of the option
346
- * @param {string} valueFrameworkId UUID of the value framework
347
- * @param {*} [options] Override http request option.
348
- * @throws {RequiredError}
349
- */
350
- getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
351
- /**
352
- * Retrieve a paginated list of all options for a specific investment.
353
- * @summary List options for this investment
354
- * @param {string} investmentId UUID of the investment
355
- * @param {number} [offset] Number of records to skip
356
- * @param {number} [limit] Max number of records to return
357
- * @param {*} [options] Override http request option.
358
- * @throws {RequiredError}
359
- */
360
- getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
361
- /**
362
- * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
363
- * @summary Option overview table for this investment
364
- * @param {string} investmentId UUID of the investment
365
- * @param {string} valueFrameworkId UUID of the value framework
366
- * @param {*} [options] Override http request option.
367
- * @throws {RequiredError}
368
- */
369
- getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
370
- /**
371
- * Get the preferred option for an investment.
372
- * @summary Get the preferred option for an investment
373
- * @param {string} investmentId UUID of the investment
374
- * @param {*} [options] Override http request option.
375
- * @throws {RequiredError}
376
- */
377
- getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
378
- /**
379
- * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
380
- * @summary Partially update an impact for this option
381
- * @param {string} impactId UUID of the impact
382
- * @param {string} optionId UUID of the option
383
- * @param {string} investmentId UUID of the investment
384
- * @param {ImpactUpdate} impactUpdate
385
- * @param {*} [options] Override http request option.
386
- * @throws {RequiredError}
387
- */
388
- patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
389
128
  /**
390
129
  * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
391
130
  * @summary Partially update an investment
@@ -395,16 +134,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
395
134
  * @throws {RequiredError}
396
135
  */
397
136
  patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
398
- /**
399
- * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
400
- * @summary Partially update an option for this investment
401
- * @param {string} optionId UUID of the option
402
- * @param {string} investmentId UUID of the investment
403
- * @param {OptionUpdate} optionUpdate
404
- * @param {*} [options] Override http request option.
405
- * @throws {RequiredError}
406
- */
407
- patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
408
137
  /**
409
138
  * Create a new investment.
410
139
  * @summary Create an investment
@@ -413,15 +142,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
413
142
  * @throws {RequiredError}
414
143
  */
415
144
  postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
416
- /**
417
- * Set the preferred option for an investment.
418
- * @summary Set the preferred option for an investment
419
- * @param {string} investmentId UUID of the investment
420
- * @param {PreferredOptionRequest} preferredOptionRequest
421
- * @param {*} [options] Override http request option.
422
- * @throws {RequiredError}
423
- */
424
- setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
425
145
  };
426
146
  /**
427
147
  * InvestmentApi - factory interface
@@ -435,35 +155,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
435
155
  * @throws {RequiredError}
436
156
  */
437
157
  bulkDeleteInvestments(bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
438
- /**
439
- * Create a new impact under this option.
440
- * @summary Create an impact for this option
441
- * @param {string} optionId UUID of the option
442
- * @param {string} investmentId UUID of the investment
443
- * @param {ImpactCreate} impactCreate
444
- * @param {*} [options] Override http request option.
445
- * @throws {RequiredError}
446
- */
447
- createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
448
- /**
449
- * Create a new option under this investment.
450
- * @summary Create an option for this investment
451
- * @param {string} investmentId UUID of the investment
452
- * @param {OptionCreate} optionCreate
453
- * @param {*} [options] Override http request option.
454
- * @throws {RequiredError}
455
- */
456
- createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
457
- /**
458
- * Delete an existing impact by its ID.
459
- * @summary Delete an impact for this option
460
- * @param {string} impactId UUID of the impact
461
- * @param {string} optionId UUID of the option
462
- * @param {string} investmentId UUID of the investment
463
- * @param {*} [options] Override http request option.
464
- * @throws {RequiredError}
465
- */
466
- deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
467
158
  /**
468
159
  * Delete an existing investment by its ID. Associated options are also deleted via cascade.
469
160
  * @summary Delete an investment
@@ -472,36 +163,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
472
163
  * @throws {RequiredError}
473
164
  */
474
165
  deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
475
- /**
476
- * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
477
- * @summary Delete an option for this investment
478
- * @param {string} optionId UUID of the option
479
- * @param {string} investmentId UUID of the investment
480
- * @param {*} [options] Override http request option.
481
- * @throws {RequiredError}
482
- */
483
- deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
484
- /**
485
- * Retrieve a specific impact for the option.
486
- * @summary Get an impact for this option
487
- * @param {string} impactId UUID of the impact
488
- * @param {string} optionId UUID of the option
489
- * @param {string} investmentId UUID of the investment
490
- * @param {*} [options] Override http request option.
491
- * @throws {RequiredError}
492
- */
493
- getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
494
- /**
495
- * Retrieve a paginated list of all impacts for a specific option.
496
- * @summary List impacts for this option
497
- * @param {string} optionId UUID of the option
498
- * @param {string} investmentId UUID of the investment
499
- * @param {number} [offset] Number of records to skip
500
- * @param {number} [limit] Max number of records to return
501
- * @param {*} [options] Override http request option.
502
- * @throws {RequiredError}
503
- */
504
- getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImpactAPIResponse>>;
505
166
  /**
506
167
  * Retrieve a single investment by its ID.
507
168
  * @summary Get an investment by ID
@@ -527,63 +188,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
527
188
  * @throws {RequiredError}
528
189
  */
529
190
  getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>>;
530
- /**
531
- * Retrieve a specific option for the investment.
532
- * @summary Get an option for this investment
533
- * @param {string} optionId UUID of the option
534
- * @param {string} investmentId UUID of the investment
535
- * @param {*} [options] Override http request option.
536
- * @throws {RequiredError}
537
- */
538
- getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
539
- /**
540
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
541
- * @summary Get the kpis for a given option inside a value framework
542
- * @param {string} investmentId UUID of the investment
543
- * @param {string} optionId UUID of the option
544
- * @param {string} valueFrameworkId UUID of the value framework
545
- * @param {*} [options] Override http request option.
546
- * @throws {RequiredError}
547
- */
548
- getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
549
- /**
550
- * Retrieve a paginated list of all options for a specific investment.
551
- * @summary List options for this investment
552
- * @param {string} investmentId UUID of the investment
553
- * @param {number} [offset] Number of records to skip
554
- * @param {number} [limit] Max number of records to return
555
- * @param {*} [options] Override http request option.
556
- * @throws {RequiredError}
557
- */
558
- getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
559
- /**
560
- * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
561
- * @summary Option overview table for this investment
562
- * @param {string} investmentId UUID of the investment
563
- * @param {string} valueFrameworkId UUID of the value framework
564
- * @param {*} [options] Override http request option.
565
- * @throws {RequiredError}
566
- */
567
- getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>>;
568
- /**
569
- * Get the preferred option for an investment.
570
- * @summary Get the preferred option for an investment
571
- * @param {string} investmentId UUID of the investment
572
- * @param {*} [options] Override http request option.
573
- * @throws {RequiredError}
574
- */
575
- getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
576
- /**
577
- * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
578
- * @summary Partially update an impact for this option
579
- * @param {string} impactId UUID of the impact
580
- * @param {string} optionId UUID of the option
581
- * @param {string} investmentId UUID of the investment
582
- * @param {ImpactUpdate} impactUpdate
583
- * @param {*} [options] Override http request option.
584
- * @throws {RequiredError}
585
- */
586
- patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
587
191
  /**
588
192
  * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
589
193
  * @summary Partially update an investment
@@ -593,16 +197,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
593
197
  * @throws {RequiredError}
594
198
  */
595
199
  patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
596
- /**
597
- * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
598
- * @summary Partially update an option for this investment
599
- * @param {string} optionId UUID of the option
600
- * @param {string} investmentId UUID of the investment
601
- * @param {OptionUpdate} optionUpdate
602
- * @param {*} [options] Override http request option.
603
- * @throws {RequiredError}
604
- */
605
- patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
606
200
  /**
607
201
  * Create a new investment.
608
202
  * @summary Create an investment
@@ -611,15 +205,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
611
205
  * @throws {RequiredError}
612
206
  */
613
207
  postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
614
- /**
615
- * Set the preferred option for an investment.
616
- * @summary Set the preferred option for an investment
617
- * @param {string} investmentId UUID of the investment
618
- * @param {PreferredOptionRequest} preferredOptionRequest
619
- * @param {*} [options] Override http request option.
620
- * @throws {RequiredError}
621
- */
622
- setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
623
208
  };
624
209
  /**
625
210
  * InvestmentApi - object-oriented interface
@@ -633,35 +218,6 @@ export declare class InvestmentApi extends BaseAPI {
633
218
  * @throws {RequiredError}
634
219
  */
635
220
  bulkDeleteInvestments(bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
636
- /**
637
- * Create a new impact under this option.
638
- * @summary Create an impact for this option
639
- * @param {string} optionId UUID of the option
640
- * @param {string} investmentId UUID of the investment
641
- * @param {ImpactCreate} impactCreate
642
- * @param {*} [options] Override http request option.
643
- * @throws {RequiredError}
644
- */
645
- createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
646
- /**
647
- * Create a new option under this investment.
648
- * @summary Create an option for this investment
649
- * @param {string} investmentId UUID of the investment
650
- * @param {OptionCreate} optionCreate
651
- * @param {*} [options] Override http request option.
652
- * @throws {RequiredError}
653
- */
654
- createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
655
- /**
656
- * Delete an existing impact by its ID.
657
- * @summary Delete an impact for this option
658
- * @param {string} impactId UUID of the impact
659
- * @param {string} optionId UUID of the option
660
- * @param {string} investmentId UUID of the investment
661
- * @param {*} [options] Override http request option.
662
- * @throws {RequiredError}
663
- */
664
- deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
665
221
  /**
666
222
  * Delete an existing investment by its ID. Associated options are also deleted via cascade.
667
223
  * @summary Delete an investment
@@ -670,36 +226,6 @@ export declare class InvestmentApi extends BaseAPI {
670
226
  * @throws {RequiredError}
671
227
  */
672
228
  deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
673
- /**
674
- * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
675
- * @summary Delete an option for this investment
676
- * @param {string} optionId UUID of the option
677
- * @param {string} investmentId UUID of the investment
678
- * @param {*} [options] Override http request option.
679
- * @throws {RequiredError}
680
- */
681
- deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
682
- /**
683
- * Retrieve a specific impact for the option.
684
- * @summary Get an impact for this option
685
- * @param {string} impactId UUID of the impact
686
- * @param {string} optionId UUID of the option
687
- * @param {string} investmentId UUID of the investment
688
- * @param {*} [options] Override http request option.
689
- * @throws {RequiredError}
690
- */
691
- getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
692
- /**
693
- * Retrieve a paginated list of all impacts for a specific option.
694
- * @summary List impacts for this option
695
- * @param {string} optionId UUID of the option
696
- * @param {string} investmentId UUID of the investment
697
- * @param {number} [offset] Number of records to skip
698
- * @param {number} [limit] Max number of records to return
699
- * @param {*} [options] Override http request option.
700
- * @throws {RequiredError}
701
- */
702
- getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse[], any, {}>>;
703
229
  /**
704
230
  * Retrieve a single investment by its ID.
705
231
  * @summary Get an investment by ID
@@ -725,63 +251,6 @@ export declare class InvestmentApi extends BaseAPI {
725
251
  * @throws {RequiredError}
726
252
  */
727
253
  getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentOverviewResponse[], any, {}>>;
728
- /**
729
- * Retrieve a specific option for the investment.
730
- * @summary Get an option for this investment
731
- * @param {string} optionId UUID of the option
732
- * @param {string} investmentId UUID of the investment
733
- * @param {*} [options] Override http request option.
734
- * @throws {RequiredError}
735
- */
736
- getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
737
- /**
738
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
739
- * @summary Get the kpis for a given option inside a value framework
740
- * @param {string} investmentId UUID of the investment
741
- * @param {string} optionId UUID of the option
742
- * @param {string} valueFrameworkId UUID of the value framework
743
- * @param {*} [options] Override http request option.
744
- * @throws {RequiredError}
745
- */
746
- getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
747
- /**
748
- * Retrieve a paginated list of all options for a specific investment.
749
- * @summary List options for this investment
750
- * @param {string} investmentId UUID of the investment
751
- * @param {number} [offset] Number of records to skip
752
- * @param {number} [limit] Max number of records to return
753
- * @param {*} [options] Override http request option.
754
- * @throws {RequiredError}
755
- */
756
- getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
757
- /**
758
- * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
759
- * @summary Option overview table for this investment
760
- * @param {string} investmentId UUID of the investment
761
- * @param {string} valueFrameworkId UUID of the value framework
762
- * @param {*} [options] Override http request option.
763
- * @throws {RequiredError}
764
- */
765
- getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
766
- /**
767
- * Get the preferred option for an investment.
768
- * @summary Get the preferred option for an investment
769
- * @param {string} investmentId UUID of the investment
770
- * @param {*} [options] Override http request option.
771
- * @throws {RequiredError}
772
- */
773
- getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
774
- /**
775
- * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
776
- * @summary Partially update an impact for this option
777
- * @param {string} impactId UUID of the impact
778
- * @param {string} optionId UUID of the option
779
- * @param {string} investmentId UUID of the investment
780
- * @param {ImpactUpdate} impactUpdate
781
- * @param {*} [options] Override http request option.
782
- * @throws {RequiredError}
783
- */
784
- patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
785
254
  /**
786
255
  * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
787
256
  * @summary Partially update an investment
@@ -791,16 +260,6 @@ export declare class InvestmentApi extends BaseAPI {
791
260
  * @throws {RequiredError}
792
261
  */
793
262
  patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
794
- /**
795
- * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
796
- * @summary Partially update an option for this investment
797
- * @param {string} optionId UUID of the option
798
- * @param {string} investmentId UUID of the investment
799
- * @param {OptionUpdate} optionUpdate
800
- * @param {*} [options] Override http request option.
801
- * @throws {RequiredError}
802
- */
803
- patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
804
263
  /**
805
264
  * Create a new investment.
806
265
  * @summary Create an investment
@@ -809,13 +268,4 @@ export declare class InvestmentApi extends BaseAPI {
809
268
  * @throws {RequiredError}
810
269
  */
811
270
  postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
812
- /**
813
- * Set the preferred option for an investment.
814
- * @summary Set the preferred option for an investment
815
- * @param {string} investmentId UUID of the investment
816
- * @param {PreferredOptionRequest} preferredOptionRequest
817
- * @param {*} [options] Override http request option.
818
- * @throws {RequiredError}
819
- */
820
- setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
821
271
  }