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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. package/README.md +147 -4
  2. package/api/default-api.ts +8 -15
  3. package/api/favored-option-api.ts +210 -0
  4. package/api/impact-api.ts +507 -0
  5. package/api/investment-api.ts +1464 -0
  6. package/api/metric-api.ts +185 -164
  7. package/api/metric-costs-api.ts +144 -0
  8. package/api/metric-costs-per-year-api.ts +200 -200
  9. package/api/objective-api.ts +538 -44
  10. package/api/objective-weight-api.ts +190 -190
  11. package/api/objective-weights-api.ts +144 -0
  12. package/api/option-api.ts +925 -0
  13. package/api/value-framework-api.ts +1223 -109
  14. package/api/value-framework-costs-api.ts +239 -0
  15. package/api/value-framework-weights-api.ts +144 -0
  16. package/api.ts +9 -1
  17. package/base.ts +1 -25
  18. package/common.ts +20 -43
  19. package/configuration.ts +31 -20
  20. package/dist/api/default-api.d.ts +3 -10
  21. package/dist/api/default-api.js +7 -13
  22. package/dist/api/favored-option-api.d.ts +104 -0
  23. package/dist/api/favored-option-api.js +209 -0
  24. package/dist/api/impact-api.d.ts +245 -0
  25. package/dist/api/impact-api.js +493 -0
  26. package/dist/api/investment-api.d.ts +677 -0
  27. package/dist/api/investment-api.js +1394 -0
  28. package/dist/api/metric-api.d.ts +97 -88
  29. package/dist/api/metric-api.js +185 -157
  30. package/dist/api/metric-costs-api.d.ts +75 -0
  31. package/dist/api/metric-costs-api.js +146 -0
  32. package/dist/api/metric-costs-per-year-api.d.ts +105 -108
  33. package/dist/api/metric-costs-per-year-api.js +199 -192
  34. package/dist/api/objective-api.d.ts +242 -21
  35. package/dist/api/objective-api.js +508 -37
  36. package/dist/api/objective-weight-api.d.ts +105 -108
  37. package/dist/api/objective-weight-api.js +189 -182
  38. package/dist/api/objective-weights-api.d.ts +75 -0
  39. package/dist/api/objective-weights-api.js +146 -0
  40. package/dist/api/option-api.d.ts +436 -0
  41. package/dist/api/option-api.js +888 -0
  42. package/dist/api/value-framework-api.d.ts +528 -21
  43. package/dist/api/value-framework-api.js +1138 -78
  44. package/dist/api/value-framework-costs-api.d.ts +119 -0
  45. package/dist/api/value-framework-costs-api.js +236 -0
  46. package/dist/api/value-framework-weights-api.d.ts +75 -0
  47. package/dist/api/value-framework-weights-api.js +146 -0
  48. package/dist/api.d.ts +9 -1
  49. package/dist/api.js +9 -1
  50. package/dist/base.d.ts +1 -25
  51. package/dist/base.js +1 -20
  52. package/dist/common.d.ts +6 -37
  53. package/dist/common.js +17 -39
  54. package/dist/configuration.d.ts +25 -18
  55. package/dist/configuration.js +4 -3
  56. package/dist/esm/api/default-api.d.ts +3 -10
  57. package/dist/esm/api/default-api.js +7 -13
  58. package/dist/esm/api/favored-option-api.d.ts +104 -0
  59. package/dist/esm/api/favored-option-api.js +202 -0
  60. package/dist/esm/api/impact-api.d.ts +245 -0
  61. package/dist/esm/api/impact-api.js +486 -0
  62. package/dist/esm/api/investment-api.d.ts +677 -0
  63. package/dist/esm/api/investment-api.js +1387 -0
  64. package/dist/esm/api/metric-api.d.ts +97 -88
  65. package/dist/esm/api/metric-api.js +185 -157
  66. package/dist/esm/api/metric-costs-api.d.ts +75 -0
  67. package/dist/esm/api/metric-costs-api.js +139 -0
  68. package/dist/esm/api/metric-costs-per-year-api.d.ts +105 -108
  69. package/dist/esm/api/metric-costs-per-year-api.js +199 -192
  70. package/dist/esm/api/objective-api.d.ts +242 -21
  71. package/dist/esm/api/objective-api.js +508 -37
  72. package/dist/esm/api/objective-weight-api.d.ts +105 -108
  73. package/dist/esm/api/objective-weight-api.js +189 -182
  74. package/dist/esm/api/objective-weights-api.d.ts +75 -0
  75. package/dist/esm/api/objective-weights-api.js +139 -0
  76. package/dist/esm/api/option-api.d.ts +436 -0
  77. package/dist/esm/api/option-api.js +881 -0
  78. package/dist/esm/api/value-framework-api.d.ts +528 -21
  79. package/dist/esm/api/value-framework-api.js +1137 -77
  80. package/dist/esm/api/value-framework-costs-api.d.ts +119 -0
  81. package/dist/esm/api/value-framework-costs-api.js +229 -0
  82. package/dist/esm/api/value-framework-weights-api.d.ts +75 -0
  83. package/dist/esm/api/value-framework-weights-api.js +139 -0
  84. package/dist/esm/api.d.ts +9 -1
  85. package/dist/esm/api.js +9 -1
  86. package/dist/esm/base.d.ts +1 -25
  87. package/dist/esm/base.js +1 -20
  88. package/dist/esm/common.d.ts +6 -37
  89. package/dist/esm/common.js +15 -38
  90. package/dist/esm/configuration.d.ts +25 -18
  91. package/dist/esm/configuration.js +4 -3
  92. package/dist/esm/index.d.ts +1 -1
  93. package/dist/esm/index.js +1 -1
  94. package/dist/esm/models/evolution-type.d.ts +16 -0
  95. package/dist/esm/models/evolution-type.js +17 -0
  96. package/dist/esm/models/favored-option-request.d.ts +20 -0
  97. package/dist/esm/models/{validation-error-loc-inner.js → favored-option-request.js} +1 -1
  98. package/dist/esm/models/favored-option-response.d.ts +20 -0
  99. package/dist/esm/models/favored-option-response.js +14 -0
  100. package/dist/esm/models/httpvalidation-error.d.ts +2 -12
  101. package/dist/esm/models/httpvalidation-error.js +1 -1
  102. package/dist/esm/models/impact-apiresponse.d.ts +33 -0
  103. package/dist/esm/models/impact-apiresponse.js +14 -0
  104. package/dist/esm/models/impact-create.d.ts +37 -0
  105. package/dist/esm/models/impact-create.js +14 -0
  106. package/dist/esm/models/impact-update.d.ts +22 -0
  107. package/dist/esm/models/impact-update.js +14 -0
  108. package/dist/esm/models/index.d.ts +13 -1
  109. package/dist/esm/models/index.js +13 -1
  110. package/dist/esm/models/investment-create.d.ts +21 -0
  111. package/dist/esm/models/investment-create.js +14 -0
  112. package/dist/esm/models/investment-response.d.ts +26 -0
  113. package/dist/esm/models/investment-response.js +14 -0
  114. package/dist/esm/models/investment-update.d.ts +18 -0
  115. package/dist/esm/models/investment-update.js +14 -0
  116. package/dist/esm/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
  117. package/dist/esm/models/location-inner.js +14 -0
  118. package/dist/esm/models/measurement-type.d.ts +1 -6
  119. package/dist/esm/models/measurement-type.js +1 -6
  120. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -17
  121. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  122. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -18
  123. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  124. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -13
  125. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  126. package/dist/esm/models/metric-create.d.ts +3 -28
  127. package/dist/esm/models/metric-create.js +1 -1
  128. package/dist/esm/models/metric-response.d.ts +3 -50
  129. package/dist/esm/models/metric-response.js +1 -1
  130. package/dist/esm/models/metric-type.d.ts +1 -6
  131. package/dist/esm/models/metric-type.js +1 -6
  132. package/dist/esm/models/metric-update.d.ts +3 -35
  133. package/dist/esm/models/metric-update.js +1 -1
  134. package/dist/esm/models/objective-create.d.ts +1 -10
  135. package/dist/esm/models/objective-create.js +1 -1
  136. package/dist/esm/models/objective-response.d.ts +1 -30
  137. package/dist/esm/models/objective-response.js +1 -1
  138. package/dist/esm/models/objective-update.d.ts +1 -13
  139. package/dist/esm/models/objective-update.js +1 -1
  140. package/dist/esm/models/objective-weight-create.d.ts +1 -9
  141. package/dist/esm/models/objective-weight-create.js +1 -1
  142. package/dist/esm/models/objective-weight-response.d.ts +1 -14
  143. package/dist/esm/models/objective-weight-response.js +1 -1
  144. package/dist/esm/models/objective-weight-update.d.ts +1 -8
  145. package/dist/esm/models/objective-weight-update.js +1 -1
  146. package/dist/esm/models/option-create.d.ts +33 -0
  147. package/dist/esm/models/option-create.js +14 -0
  148. package/dist/esm/models/option-response.d.ts +32 -0
  149. package/dist/esm/models/option-response.js +14 -0
  150. package/dist/esm/models/option-update.d.ts +21 -0
  151. package/dist/esm/models/option-update.js +14 -0
  152. package/dist/esm/models/validation-error.d.ts +3 -33
  153. package/dist/esm/models/validation-error.js +1 -1
  154. package/dist/esm/models/value-framework-create.d.ts +1 -10
  155. package/dist/esm/models/value-framework-create.js +1 -1
  156. package/dist/esm/models/value-framework-response.d.ts +1 -30
  157. package/dist/esm/models/value-framework-response.js +1 -1
  158. package/dist/esm/models/value-framework-update.d.ts +1 -13
  159. package/dist/esm/models/value-framework-update.js +1 -1
  160. package/dist/index.d.ts +1 -1
  161. package/dist/index.js +1 -1
  162. package/dist/models/evolution-type.d.ts +16 -0
  163. package/dist/models/evolution-type.js +20 -0
  164. package/dist/models/favored-option-request.d.ts +20 -0
  165. package/dist/models/{validation-error-loc-inner.js → favored-option-request.js} +1 -1
  166. package/dist/models/favored-option-response.d.ts +20 -0
  167. package/dist/models/favored-option-response.js +15 -0
  168. package/dist/models/httpvalidation-error.d.ts +2 -12
  169. package/dist/models/httpvalidation-error.js +1 -1
  170. package/dist/models/impact-apiresponse.d.ts +33 -0
  171. package/dist/models/impact-apiresponse.js +15 -0
  172. package/dist/models/impact-create.d.ts +37 -0
  173. package/dist/models/impact-create.js +15 -0
  174. package/dist/models/impact-update.d.ts +22 -0
  175. package/dist/models/impact-update.js +15 -0
  176. package/dist/models/index.d.ts +13 -1
  177. package/dist/models/index.js +13 -1
  178. package/dist/models/investment-create.d.ts +21 -0
  179. package/dist/models/investment-create.js +15 -0
  180. package/dist/models/investment-response.d.ts +26 -0
  181. package/dist/models/investment-response.js +15 -0
  182. package/dist/models/investment-update.d.ts +18 -0
  183. package/dist/models/investment-update.js +15 -0
  184. package/dist/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
  185. package/dist/models/location-inner.js +15 -0
  186. package/dist/models/measurement-type.d.ts +1 -6
  187. package/dist/models/measurement-type.js +1 -6
  188. package/dist/models/metric-costs-per-year-create.d.ts +1 -17
  189. package/dist/models/metric-costs-per-year-create.js +1 -1
  190. package/dist/models/metric-costs-per-year-response.d.ts +1 -18
  191. package/dist/models/metric-costs-per-year-response.js +1 -1
  192. package/dist/models/metric-costs-per-year-update.d.ts +1 -13
  193. package/dist/models/metric-costs-per-year-update.js +1 -1
  194. package/dist/models/metric-create.d.ts +3 -28
  195. package/dist/models/metric-create.js +1 -1
  196. package/dist/models/metric-response.d.ts +3 -50
  197. package/dist/models/metric-response.js +1 -1
  198. package/dist/models/metric-type.d.ts +1 -6
  199. package/dist/models/metric-type.js +1 -6
  200. package/dist/models/metric-update.d.ts +3 -35
  201. package/dist/models/metric-update.js +1 -1
  202. package/dist/models/objective-create.d.ts +1 -10
  203. package/dist/models/objective-create.js +1 -1
  204. package/dist/models/objective-response.d.ts +1 -30
  205. package/dist/models/objective-response.js +1 -1
  206. package/dist/models/objective-update.d.ts +1 -13
  207. package/dist/models/objective-update.js +1 -1
  208. package/dist/models/objective-weight-create.d.ts +1 -9
  209. package/dist/models/objective-weight-create.js +1 -1
  210. package/dist/models/objective-weight-response.d.ts +1 -14
  211. package/dist/models/objective-weight-response.js +1 -1
  212. package/dist/models/objective-weight-update.d.ts +1 -8
  213. package/dist/models/objective-weight-update.js +1 -1
  214. package/dist/models/option-create.d.ts +33 -0
  215. package/dist/models/option-create.js +15 -0
  216. package/dist/models/option-response.d.ts +32 -0
  217. package/dist/models/option-response.js +15 -0
  218. package/dist/models/option-update.d.ts +21 -0
  219. package/dist/models/option-update.js +15 -0
  220. package/dist/models/validation-error.d.ts +3 -33
  221. package/dist/models/validation-error.js +1 -1
  222. package/dist/models/value-framework-create.d.ts +1 -10
  223. package/dist/models/value-framework-create.js +1 -1
  224. package/dist/models/value-framework-response.d.ts +1 -30
  225. package/dist/models/value-framework-response.js +1 -1
  226. package/dist/models/value-framework-update.d.ts +1 -13
  227. package/dist/models/value-framework-update.js +1 -1
  228. package/docs/DefaultApi.md +51 -0
  229. package/docs/EvolutionType.md +10 -0
  230. package/docs/FavoredOptionApi.md +119 -0
  231. package/docs/FavoredOptionRequest.md +21 -0
  232. package/docs/FavoredOptionResponse.md +21 -0
  233. package/docs/HTTPValidationError.md +20 -0
  234. package/docs/ImpactAPIResponse.md +39 -0
  235. package/docs/ImpactApi.md +312 -0
  236. package/docs/ImpactCreate.md +29 -0
  237. package/docs/ImpactUpdate.md +29 -0
  238. package/docs/InvestmentApi.md +987 -0
  239. package/docs/InvestmentCreate.md +23 -0
  240. package/docs/InvestmentResponse.md +33 -0
  241. package/docs/InvestmentUpdate.md +23 -0
  242. package/docs/LocationInner.md +18 -0
  243. package/docs/MeasurementType.md +10 -0
  244. package/docs/MetricApi.md +299 -0
  245. package/docs/MetricCostsApi.md +66 -0
  246. package/docs/MetricCostsPerYearApi.md +307 -0
  247. package/docs/MetricCostsPerYearCreate.md +27 -0
  248. package/docs/MetricCostsPerYearResponse.md +31 -0
  249. package/docs/MetricCostsPerYearUpdate.md +23 -0
  250. package/docs/MetricCreate.md +33 -0
  251. package/docs/MetricResponse.md +43 -0
  252. package/docs/MetricType.md +12 -0
  253. package/docs/MetricUpdate.md +31 -0
  254. package/docs/ObjectiveApi.md +633 -0
  255. package/docs/ObjectiveCreate.md +23 -0
  256. package/docs/ObjectiveResponse.md +31 -0
  257. package/docs/ObjectiveUpdate.md +23 -0
  258. package/docs/ObjectiveWeightApi.md +298 -0
  259. package/docs/ObjectiveWeightCreate.md +25 -0
  260. package/docs/ObjectiveWeightResponse.md +27 -0
  261. package/docs/ObjectiveWeightUpdate.md +21 -0
  262. package/docs/ObjectiveWeightsApi.md +66 -0
  263. package/docs/OptionApi.md +602 -0
  264. package/docs/OptionCreate.md +29 -0
  265. package/docs/OptionResponse.md +39 -0
  266. package/docs/OptionUpdate.md +29 -0
  267. package/docs/ValidationError.md +28 -0
  268. package/docs/ValueFrameworkApi.md +1053 -0
  269. package/docs/ValueFrameworkCostsApi.md +128 -0
  270. package/docs/ValueFrameworkCreate.md +23 -0
  271. package/docs/ValueFrameworkResponse.md +31 -0
  272. package/docs/ValueFrameworkUpdate.md +23 -0
  273. package/docs/ValueFrameworkWeightsApi.md +66 -0
  274. package/index.ts +1 -1
  275. package/models/evolution-type.ts +26 -0
  276. package/models/favored-option-request.ts +26 -0
  277. package/models/favored-option-response.ts +26 -0
  278. package/models/httpvalidation-error.ts +2 -12
  279. package/models/impact-apiresponse.ts +43 -0
  280. package/models/impact-create.ts +47 -0
  281. package/models/impact-update.ts +32 -0
  282. package/models/index.ts +13 -1
  283. package/models/investment-create.ts +27 -0
  284. package/models/investment-response.ts +32 -0
  285. package/models/investment-update.ts +24 -0
  286. package/models/{validation-error-loc-inner.ts → location-inner.ts} +2 -7
  287. package/models/measurement-type.ts +1 -6
  288. package/models/metric-costs-per-year-create.ts +1 -17
  289. package/models/metric-costs-per-year-response.ts +1 -18
  290. package/models/metric-costs-per-year-update.ts +1 -13
  291. package/models/metric-create.ts +3 -28
  292. package/models/metric-response.ts +3 -50
  293. package/models/metric-type.ts +1 -6
  294. package/models/metric-update.ts +3 -35
  295. package/models/objective-create.ts +1 -10
  296. package/models/objective-response.ts +1 -30
  297. package/models/objective-update.ts +1 -13
  298. package/models/objective-weight-create.ts +1 -9
  299. package/models/objective-weight-response.ts +1 -14
  300. package/models/objective-weight-update.ts +1 -8
  301. package/models/option-create.ts +39 -0
  302. package/models/option-response.ts +38 -0
  303. package/models/option-update.ts +27 -0
  304. package/models/validation-error.ts +3 -33
  305. package/models/value-framework-create.ts +1 -10
  306. package/models/value-framework-response.ts +1 -30
  307. package/models/value-framework-update.ts +1 -13
  308. package/package.json +4 -4
@@ -0,0 +1,677 @@
1
+ /**
2
+ * Asset Investment Planning
3
+ * API for Asset Investment Planning
4
+ *
5
+ * The version of the OpenAPI document: 0.2.0-dev3
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { FavoredOptionRequest } from '../models';
16
+ import type { FavoredOptionResponse } from '../models';
17
+ import type { ImpactAPIResponse } from '../models';
18
+ import type { ImpactCreate } from '../models';
19
+ import type { ImpactUpdate } from '../models';
20
+ import type { InvestmentCreate } from '../models';
21
+ import type { InvestmentResponse } from '../models';
22
+ import type { InvestmentUpdate } from '../models';
23
+ import type { OptionCreate } from '../models';
24
+ import type { OptionResponse } from '../models';
25
+ import type { OptionUpdate } from '../models';
26
+ /**
27
+ * InvestmentApi - axios parameter creator
28
+ */
29
+ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configuration) => {
30
+ /**
31
+ * Create a new impact under this option.
32
+ * @summary Create an impact for this option
33
+ * @param {string} optionId UUID of the option
34
+ * @param {string} investmentId UUID of the investment
35
+ * @param {ImpactCreate} impactCreate
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ createImpactForOption: (optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
40
+ /**
41
+ * Create a new option under this investment.
42
+ * @summary Create an option for this investment
43
+ * @param {string} investmentId UUID of the investment
44
+ * @param {OptionCreate} optionCreate
45
+ * @param {*} [options] Override http request option.
46
+ * @throws {RequiredError}
47
+ */
48
+ createOptionForInvestment: (investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
49
+ /**
50
+ * Delete an existing impact by its ID.
51
+ * @summary Delete an impact for this option
52
+ * @param {string} impactId UUID of the impact
53
+ * @param {string} optionId UUID of the option
54
+ * @param {string} investmentId UUID of the investment
55
+ * @param {*} [options] Override http request option.
56
+ * @throws {RequiredError}
57
+ */
58
+ deleteImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
59
+ /**
60
+ * Delete an existing investment by its ID. Associated options are also deleted via cascade.
61
+ * @summary Delete an investment
62
+ * @param {string} investmentId UUID of the investment
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ deleteInvestment: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67
+ /**
68
+ * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
69
+ * @summary Delete an option for this investment
70
+ * @param {string} optionId UUID of the option
71
+ * @param {string} investmentId UUID of the investment
72
+ * @param {*} [options] Override http request option.
73
+ * @throws {RequiredError}
74
+ */
75
+ deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
76
+ /**
77
+ * Get the preferred option for an investment.
78
+ * @summary Get the preferred option for an investment
79
+ * @param {string} investmentId UUID of the investment
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ getFavoredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
84
+ /**
85
+ * Retrieve a specific impact for the option.
86
+ * @summary Get an impact for this option
87
+ * @param {string} impactId UUID of the impact
88
+ * @param {string} optionId UUID of the option
89
+ * @param {string} investmentId UUID of the investment
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ getImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
94
+ /**
95
+ * Retrieve a paginated list of all impacts for a specific option.
96
+ * @summary List impacts for this option
97
+ * @param {string} optionId UUID of the option
98
+ * @param {string} investmentId UUID of the investment
99
+ * @param {number} [offset] Number of records to skip
100
+ * @param {number} [limit] Max number of records to return
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ getImpactsForOption: (optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
105
+ /**
106
+ * Retrieve a single investment by its ID.
107
+ * @summary Get an investment by ID
108
+ * @param {string} investmentId UUID of the investment
109
+ * @param {*} [options] Override http request option.
110
+ * @throws {RequiredError}
111
+ */
112
+ getInvestmentById: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
113
+ /**
114
+ * Retrieve a paginated list of all investments.
115
+ * @summary List investments
116
+ * @param {number} [offset] Number of records to skip
117
+ * @param {number} [limit] Max number of records to return
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ getInvestments: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
122
+ /**
123
+ * Retrieve a specific option for the investment.
124
+ * @summary Get an option for this investment
125
+ * @param {string} optionId UUID of the option
126
+ * @param {string} investmentId UUID of the investment
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
131
+ /**
132
+ * Retrieve a paginated list of all options for a specific investment.
133
+ * @summary List options for this investment
134
+ * @param {string} investmentId UUID of the investment
135
+ * @param {number} [offset] Number of records to skip
136
+ * @param {number} [limit] Max number of records to return
137
+ * @param {*} [options] Override http request option.
138
+ * @throws {RequiredError}
139
+ */
140
+ getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
141
+ /**
142
+ * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
143
+ * @summary Partially update an impact for this option
144
+ * @param {string} impactId UUID of the impact
145
+ * @param {string} optionId UUID of the option
146
+ * @param {string} investmentId UUID of the investment
147
+ * @param {ImpactUpdate} impactUpdate
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ patchImpactForOption: (impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
152
+ /**
153
+ * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
154
+ * @summary Partially update an investment
155
+ * @param {string} investmentId UUID of the investment
156
+ * @param {InvestmentUpdate} investmentUpdate
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ patchInvestment: (investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
161
+ /**
162
+ * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
163
+ * @summary Partially update an option for this investment
164
+ * @param {string} optionId UUID of the option
165
+ * @param {string} investmentId UUID of the investment
166
+ * @param {OptionUpdate} optionUpdate
167
+ * @param {*} [options] Override http request option.
168
+ * @throws {RequiredError}
169
+ */
170
+ patchOptionForInvestment: (optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
171
+ /**
172
+ * Create a new investment.
173
+ * @summary Create an investment
174
+ * @param {InvestmentCreate} investmentCreate
175
+ * @param {*} [options] Override http request option.
176
+ * @throws {RequiredError}
177
+ */
178
+ postInvestment: (investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
179
+ /**
180
+ * Set the preferred option for an investment.
181
+ * @summary Set the preferred option for an investment
182
+ * @param {string} investmentId UUID of the investment
183
+ * @param {FavoredOptionRequest} favoredOptionRequest
184
+ * @param {*} [options] Override http request option.
185
+ * @throws {RequiredError}
186
+ */
187
+ setFavoredOption: (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
188
+ };
189
+ /**
190
+ * InvestmentApi - functional programming interface
191
+ */
192
+ export declare const InvestmentApiFp: (configuration?: Configuration) => {
193
+ /**
194
+ * Create a new impact under this option.
195
+ * @summary Create an impact for this option
196
+ * @param {string} optionId UUID of the option
197
+ * @param {string} investmentId UUID of the investment
198
+ * @param {ImpactCreate} impactCreate
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
203
+ /**
204
+ * Create a new option under this investment.
205
+ * @summary Create an option for this investment
206
+ * @param {string} investmentId UUID of the investment
207
+ * @param {OptionCreate} optionCreate
208
+ * @param {*} [options] Override http request option.
209
+ * @throws {RequiredError}
210
+ */
211
+ createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
212
+ /**
213
+ * Delete an existing impact by its ID.
214
+ * @summary Delete an impact for this option
215
+ * @param {string} impactId UUID of the impact
216
+ * @param {string} optionId UUID of the option
217
+ * @param {string} investmentId UUID of the investment
218
+ * @param {*} [options] Override http request option.
219
+ * @throws {RequiredError}
220
+ */
221
+ deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
222
+ /**
223
+ * Delete an existing investment by its ID. Associated options are also deleted via cascade.
224
+ * @summary Delete an investment
225
+ * @param {string} investmentId UUID of the investment
226
+ * @param {*} [options] Override http request option.
227
+ * @throws {RequiredError}
228
+ */
229
+ deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
230
+ /**
231
+ * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
232
+ * @summary Delete an option for this investment
233
+ * @param {string} optionId UUID of the option
234
+ * @param {string} investmentId UUID of the investment
235
+ * @param {*} [options] Override http request option.
236
+ * @throws {RequiredError}
237
+ */
238
+ deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
239
+ /**
240
+ * Get the preferred option for an investment.
241
+ * @summary Get the preferred option for an investment
242
+ * @param {string} investmentId UUID of the investment
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
247
+ /**
248
+ * Retrieve a specific impact for the option.
249
+ * @summary Get an impact for this option
250
+ * @param {string} impactId UUID of the impact
251
+ * @param {string} optionId UUID of the option
252
+ * @param {string} investmentId UUID of the investment
253
+ * @param {*} [options] Override http request option.
254
+ * @throws {RequiredError}
255
+ */
256
+ getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
257
+ /**
258
+ * Retrieve a paginated list of all impacts for a specific option.
259
+ * @summary List impacts for this option
260
+ * @param {string} optionId UUID of the option
261
+ * @param {string} investmentId UUID of the investment
262
+ * @param {number} [offset] Number of records to skip
263
+ * @param {number} [limit] Max number of records to return
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImpactAPIResponse>>>;
268
+ /**
269
+ * Retrieve a single investment by its ID.
270
+ * @summary Get an investment by ID
271
+ * @param {string} investmentId UUID of the investment
272
+ * @param {*} [options] Override http request option.
273
+ * @throws {RequiredError}
274
+ */
275
+ getInvestmentById(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
276
+ /**
277
+ * Retrieve a paginated list of all investments.
278
+ * @summary List investments
279
+ * @param {number} [offset] Number of records to skip
280
+ * @param {number} [limit] Max number of records to return
281
+ * @param {*} [options] Override http request option.
282
+ * @throws {RequiredError}
283
+ */
284
+ getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentResponse>>>;
285
+ /**
286
+ * Retrieve a specific option for the investment.
287
+ * @summary Get an option for this investment
288
+ * @param {string} optionId UUID of the option
289
+ * @param {string} investmentId UUID of the investment
290
+ * @param {*} [options] Override http request option.
291
+ * @throws {RequiredError}
292
+ */
293
+ getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
294
+ /**
295
+ * Retrieve a paginated list of all options for a specific investment.
296
+ * @summary List options for this investment
297
+ * @param {string} investmentId UUID of the investment
298
+ * @param {number} [offset] Number of records to skip
299
+ * @param {number} [limit] Max number of records to return
300
+ * @param {*} [options] Override http request option.
301
+ * @throws {RequiredError}
302
+ */
303
+ getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
304
+ /**
305
+ * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
306
+ * @summary Partially update an impact for this option
307
+ * @param {string} impactId UUID of the impact
308
+ * @param {string} optionId UUID of the option
309
+ * @param {string} investmentId UUID of the investment
310
+ * @param {ImpactUpdate} impactUpdate
311
+ * @param {*} [options] Override http request option.
312
+ * @throws {RequiredError}
313
+ */
314
+ patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
315
+ /**
316
+ * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
317
+ * @summary Partially update an investment
318
+ * @param {string} investmentId UUID of the investment
319
+ * @param {InvestmentUpdate} investmentUpdate
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ */
323
+ patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
324
+ /**
325
+ * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
326
+ * @summary Partially update an option for this investment
327
+ * @param {string} optionId UUID of the option
328
+ * @param {string} investmentId UUID of the investment
329
+ * @param {OptionUpdate} optionUpdate
330
+ * @param {*} [options] Override http request option.
331
+ * @throws {RequiredError}
332
+ */
333
+ patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
334
+ /**
335
+ * Create a new investment.
336
+ * @summary Create an investment
337
+ * @param {InvestmentCreate} investmentCreate
338
+ * @param {*} [options] Override http request option.
339
+ * @throws {RequiredError}
340
+ */
341
+ postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
342
+ /**
343
+ * Set the preferred option for an investment.
344
+ * @summary Set the preferred option for an investment
345
+ * @param {string} investmentId UUID of the investment
346
+ * @param {FavoredOptionRequest} favoredOptionRequest
347
+ * @param {*} [options] Override http request option.
348
+ * @throws {RequiredError}
349
+ */
350
+ setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
351
+ };
352
+ /**
353
+ * InvestmentApi - factory interface
354
+ */
355
+ export declare const InvestmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
356
+ /**
357
+ * Create a new impact under this option.
358
+ * @summary Create an impact for this option
359
+ * @param {string} optionId UUID of the option
360
+ * @param {string} investmentId UUID of the investment
361
+ * @param {ImpactCreate} impactCreate
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
366
+ /**
367
+ * Create a new option under this investment.
368
+ * @summary Create an option for this investment
369
+ * @param {string} investmentId UUID of the investment
370
+ * @param {OptionCreate} optionCreate
371
+ * @param {*} [options] Override http request option.
372
+ * @throws {RequiredError}
373
+ */
374
+ createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
375
+ /**
376
+ * Delete an existing impact by its ID.
377
+ * @summary Delete an impact for this option
378
+ * @param {string} impactId UUID of the impact
379
+ * @param {string} optionId UUID of the option
380
+ * @param {string} investmentId UUID of the investment
381
+ * @param {*} [options] Override http request option.
382
+ * @throws {RequiredError}
383
+ */
384
+ deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
385
+ /**
386
+ * Delete an existing investment by its ID. Associated options are also deleted via cascade.
387
+ * @summary Delete an investment
388
+ * @param {string} investmentId UUID of the investment
389
+ * @param {*} [options] Override http request option.
390
+ * @throws {RequiredError}
391
+ */
392
+ deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
393
+ /**
394
+ * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
395
+ * @summary Delete an option for this investment
396
+ * @param {string} optionId UUID of the option
397
+ * @param {string} investmentId UUID of the investment
398
+ * @param {*} [options] Override http request option.
399
+ * @throws {RequiredError}
400
+ */
401
+ deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
402
+ /**
403
+ * Get the preferred option for an investment.
404
+ * @summary Get the preferred option for an investment
405
+ * @param {string} investmentId UUID of the investment
406
+ * @param {*} [options] Override http request option.
407
+ * @throws {RequiredError}
408
+ */
409
+ getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
410
+ /**
411
+ * Retrieve a specific impact for the option.
412
+ * @summary Get an impact for this option
413
+ * @param {string} impactId UUID of the impact
414
+ * @param {string} optionId UUID of the option
415
+ * @param {string} investmentId UUID of the investment
416
+ * @param {*} [options] Override http request option.
417
+ * @throws {RequiredError}
418
+ */
419
+ getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
420
+ /**
421
+ * Retrieve a paginated list of all impacts for a specific option.
422
+ * @summary List impacts for this option
423
+ * @param {string} optionId UUID of the option
424
+ * @param {string} investmentId UUID of the investment
425
+ * @param {number} [offset] Number of records to skip
426
+ * @param {number} [limit] Max number of records to return
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ */
430
+ getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImpactAPIResponse>>;
431
+ /**
432
+ * Retrieve a single investment by its ID.
433
+ * @summary Get an investment by ID
434
+ * @param {string} investmentId UUID of the investment
435
+ * @param {*} [options] Override http request option.
436
+ * @throws {RequiredError}
437
+ */
438
+ getInvestmentById(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
439
+ /**
440
+ * Retrieve a paginated list of all investments.
441
+ * @summary List investments
442
+ * @param {number} [offset] Number of records to skip
443
+ * @param {number} [limit] Max number of records to return
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ */
447
+ getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentResponse>>;
448
+ /**
449
+ * Retrieve a specific option for the investment.
450
+ * @summary Get an option for this investment
451
+ * @param {string} optionId UUID of the option
452
+ * @param {string} investmentId UUID of the investment
453
+ * @param {*} [options] Override http request option.
454
+ * @throws {RequiredError}
455
+ */
456
+ getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
457
+ /**
458
+ * Retrieve a paginated list of all options for a specific investment.
459
+ * @summary List options for this investment
460
+ * @param {string} investmentId UUID of the investment
461
+ * @param {number} [offset] Number of records to skip
462
+ * @param {number} [limit] Max number of records to return
463
+ * @param {*} [options] Override http request option.
464
+ * @throws {RequiredError}
465
+ */
466
+ getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
467
+ /**
468
+ * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
469
+ * @summary Partially update an impact for this option
470
+ * @param {string} impactId UUID of the impact
471
+ * @param {string} optionId UUID of the option
472
+ * @param {string} investmentId UUID of the investment
473
+ * @param {ImpactUpdate} impactUpdate
474
+ * @param {*} [options] Override http request option.
475
+ * @throws {RequiredError}
476
+ */
477
+ patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
478
+ /**
479
+ * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
480
+ * @summary Partially update an investment
481
+ * @param {string} investmentId UUID of the investment
482
+ * @param {InvestmentUpdate} investmentUpdate
483
+ * @param {*} [options] Override http request option.
484
+ * @throws {RequiredError}
485
+ */
486
+ patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
487
+ /**
488
+ * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
489
+ * @summary Partially update an option for this investment
490
+ * @param {string} optionId UUID of the option
491
+ * @param {string} investmentId UUID of the investment
492
+ * @param {OptionUpdate} optionUpdate
493
+ * @param {*} [options] Override http request option.
494
+ * @throws {RequiredError}
495
+ */
496
+ patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
497
+ /**
498
+ * Create a new investment.
499
+ * @summary Create an investment
500
+ * @param {InvestmentCreate} investmentCreate
501
+ * @param {*} [options] Override http request option.
502
+ * @throws {RequiredError}
503
+ */
504
+ postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
505
+ /**
506
+ * Set the preferred option for an investment.
507
+ * @summary Set the preferred option for an investment
508
+ * @param {string} investmentId UUID of the investment
509
+ * @param {FavoredOptionRequest} favoredOptionRequest
510
+ * @param {*} [options] Override http request option.
511
+ * @throws {RequiredError}
512
+ */
513
+ setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
514
+ };
515
+ /**
516
+ * InvestmentApi - object-oriented interface
517
+ */
518
+ export declare class InvestmentApi extends BaseAPI {
519
+ /**
520
+ * Create a new impact under this option.
521
+ * @summary Create an impact for this option
522
+ * @param {string} optionId UUID of the option
523
+ * @param {string} investmentId UUID of the investment
524
+ * @param {ImpactCreate} impactCreate
525
+ * @param {*} [options] Override http request option.
526
+ * @throws {RequiredError}
527
+ */
528
+ createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
529
+ /**
530
+ * Create a new option under this investment.
531
+ * @summary Create an option for this investment
532
+ * @param {string} investmentId UUID of the investment
533
+ * @param {OptionCreate} optionCreate
534
+ * @param {*} [options] Override http request option.
535
+ * @throws {RequiredError}
536
+ */
537
+ createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
538
+ /**
539
+ * Delete an existing impact by its ID.
540
+ * @summary Delete an impact for this option
541
+ * @param {string} impactId UUID of the impact
542
+ * @param {string} optionId UUID of the option
543
+ * @param {string} investmentId UUID of the investment
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ */
547
+ deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
548
+ /**
549
+ * Delete an existing investment by its ID. Associated options are also deleted via cascade.
550
+ * @summary Delete an investment
551
+ * @param {string} investmentId UUID of the investment
552
+ * @param {*} [options] Override http request option.
553
+ * @throws {RequiredError}
554
+ */
555
+ deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
556
+ /**
557
+ * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
558
+ * @summary Delete an option for this investment
559
+ * @param {string} optionId UUID of the option
560
+ * @param {string} investmentId UUID of the investment
561
+ * @param {*} [options] Override http request option.
562
+ * @throws {RequiredError}
563
+ */
564
+ deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
565
+ /**
566
+ * Get the preferred option for an investment.
567
+ * @summary Get the preferred option for an investment
568
+ * @param {string} investmentId UUID of the investment
569
+ * @param {*} [options] Override http request option.
570
+ * @throws {RequiredError}
571
+ */
572
+ getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
573
+ /**
574
+ * Retrieve a specific impact for the option.
575
+ * @summary Get an impact for this option
576
+ * @param {string} impactId UUID of the impact
577
+ * @param {string} optionId UUID of the option
578
+ * @param {string} investmentId UUID of the investment
579
+ * @param {*} [options] Override http request option.
580
+ * @throws {RequiredError}
581
+ */
582
+ getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
583
+ /**
584
+ * Retrieve a paginated list of all impacts for a specific option.
585
+ * @summary List impacts for this option
586
+ * @param {string} optionId UUID of the option
587
+ * @param {string} investmentId UUID of the investment
588
+ * @param {number} [offset] Number of records to skip
589
+ * @param {number} [limit] Max number of records to return
590
+ * @param {*} [options] Override http request option.
591
+ * @throws {RequiredError}
592
+ */
593
+ getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse[], any, {}>>;
594
+ /**
595
+ * Retrieve a single investment by its ID.
596
+ * @summary Get an investment by ID
597
+ * @param {string} investmentId UUID of the investment
598
+ * @param {*} [options] Override http request option.
599
+ * @throws {RequiredError}
600
+ */
601
+ getInvestmentById(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
602
+ /**
603
+ * Retrieve a paginated list of all investments.
604
+ * @summary List investments
605
+ * @param {number} [offset] Number of records to skip
606
+ * @param {number} [limit] Max number of records to return
607
+ * @param {*} [options] Override http request option.
608
+ * @throws {RequiredError}
609
+ */
610
+ getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse[], any, {}>>;
611
+ /**
612
+ * Retrieve a specific option for the investment.
613
+ * @summary Get an option for this investment
614
+ * @param {string} optionId UUID of the option
615
+ * @param {string} investmentId UUID of the investment
616
+ * @param {*} [options] Override http request option.
617
+ * @throws {RequiredError}
618
+ */
619
+ getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
620
+ /**
621
+ * Retrieve a paginated list of all options for a specific investment.
622
+ * @summary List options for this investment
623
+ * @param {string} investmentId UUID of the investment
624
+ * @param {number} [offset] Number of records to skip
625
+ * @param {number} [limit] Max number of records to return
626
+ * @param {*} [options] Override http request option.
627
+ * @throws {RequiredError}
628
+ */
629
+ getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
630
+ /**
631
+ * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
632
+ * @summary Partially update an impact for this option
633
+ * @param {string} impactId UUID of the impact
634
+ * @param {string} optionId UUID of the option
635
+ * @param {string} investmentId UUID of the investment
636
+ * @param {ImpactUpdate} impactUpdate
637
+ * @param {*} [options] Override http request option.
638
+ * @throws {RequiredError}
639
+ */
640
+ patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
641
+ /**
642
+ * Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
643
+ * @summary Partially update an investment
644
+ * @param {string} investmentId UUID of the investment
645
+ * @param {InvestmentUpdate} investmentUpdate
646
+ * @param {*} [options] Override http request option.
647
+ * @throws {RequiredError}
648
+ */
649
+ patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
650
+ /**
651
+ * Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
652
+ * @summary Partially update an option for this investment
653
+ * @param {string} optionId UUID of the option
654
+ * @param {string} investmentId UUID of the investment
655
+ * @param {OptionUpdate} optionUpdate
656
+ * @param {*} [options] Override http request option.
657
+ * @throws {RequiredError}
658
+ */
659
+ patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
660
+ /**
661
+ * Create a new investment.
662
+ * @summary Create an investment
663
+ * @param {InvestmentCreate} investmentCreate
664
+ * @param {*} [options] Override http request option.
665
+ * @throws {RequiredError}
666
+ */
667
+ postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
668
+ /**
669
+ * Set the preferred option for an investment.
670
+ * @summary Set the preferred option for an investment
671
+ * @param {string} investmentId UUID of the investment
672
+ * @param {FavoredOptionRequest} favoredOptionRequest
673
+ * @param {*} [options] Override http request option.
674
+ * @throws {RequiredError}
675
+ */
676
+ setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
677
+ }