@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
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @cosmotech/aip-client@0.2.0-dev2
1
+ ## @cosmotech/aip-client@0.2.0-dev4
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -15,7 +15,7 @@ Module system
15
15
  * CommonJS
16
16
  * ES6 module system
17
17
 
18
- It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
18
+ It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
19
19
 
20
20
  ### Building
21
21
 
@@ -27,7 +27,7 @@ npm run build
27
27
 
28
28
  ### Publishing
29
29
 
30
- First build the package then run ```npm publish```
30
+ First build the package then run `npm publish`
31
31
 
32
32
  ### Consuming
33
33
 
@@ -36,10 +36,153 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @cosmotech/aip-client@0.2.0-dev2 --save
39
+ npm install @cosmotech/aip-client@0.2.0-dev4 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
43
43
 
44
44
  ```
45
45
  npm install PATH_TO_GENERATED_PACKAGE --save
46
+ ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *http://localhost*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root
55
+ *FavoredOptionApi* | [**getFavoredOption**](docs/FavoredOptionApi.md#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment
56
+ *FavoredOptionApi* | [**setFavoredOption**](docs/FavoredOptionApi.md#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment
57
+ *ImpactApi* | [**createImpactForOption**](docs/ImpactApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
58
+ *ImpactApi* | [**deleteImpactForOption**](docs/ImpactApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
59
+ *ImpactApi* | [**getImpactForOption**](docs/ImpactApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
60
+ *ImpactApi* | [**getImpactsForOption**](docs/ImpactApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
61
+ *ImpactApi* | [**patchImpactForOption**](docs/ImpactApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
62
+ *InvestmentApi* | [**createImpactForOption**](docs/InvestmentApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
63
+ *InvestmentApi* | [**createOptionForInvestment**](docs/InvestmentApi.md#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment
64
+ *InvestmentApi* | [**deleteImpactForOption**](docs/InvestmentApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
65
+ *InvestmentApi* | [**deleteInvestment**](docs/InvestmentApi.md#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment
66
+ *InvestmentApi* | [**deleteOptionForInvestment**](docs/InvestmentApi.md#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
67
+ *InvestmentApi* | [**getFavoredOption**](docs/InvestmentApi.md#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment
68
+ *InvestmentApi* | [**getImpactForOption**](docs/InvestmentApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
69
+ *InvestmentApi* | [**getImpactsForOption**](docs/InvestmentApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
70
+ *InvestmentApi* | [**getInvestmentById**](docs/InvestmentApi.md#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID
71
+ *InvestmentApi* | [**getInvestments**](docs/InvestmentApi.md#getinvestments) | **GET** /investment/ | List investments
72
+ *InvestmentApi* | [**getOptionForInvestment**](docs/InvestmentApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
73
+ *InvestmentApi* | [**getOptionsForInvestment**](docs/InvestmentApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
74
+ *InvestmentApi* | [**patchImpactForOption**](docs/InvestmentApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
75
+ *InvestmentApi* | [**patchInvestment**](docs/InvestmentApi.md#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment
76
+ *InvestmentApi* | [**patchOptionForInvestment**](docs/InvestmentApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
77
+ *InvestmentApi* | [**postInvestment**](docs/InvestmentApi.md#postinvestment) | **POST** /investment/ | Create an investment
78
+ *InvestmentApi* | [**setFavoredOption**](docs/InvestmentApi.md#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment
79
+ *MetricApi* | [**createMetricForObjective**](docs/MetricApi.md#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
80
+ *MetricApi* | [**deleteMetricForObjective**](docs/MetricApi.md#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
81
+ *MetricApi* | [**getMetricForObjective**](docs/MetricApi.md#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
82
+ *MetricApi* | [**getMetricsForObjective**](docs/MetricApi.md#getmetricsforobjective) | **GET** /objective/{objective_id}/metric/ | List metrics for this objective
83
+ *MetricApi* | [**patchMetricForObjective**](docs/MetricApi.md#patchmetricforobjective) | **PATCH** /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective
84
+ *MetricCostsApi* | [**getCostsForMetric**](docs/MetricCostsApi.md#getcostsformetric) | **GET** /metric/{metric_id}/costs/ | List all metric costs for a metric
85
+ *MetricCostsPerYearApi* | [**createMetricCostForFramework**](docs/MetricCostsPerYearApi.md#createmetriccostforframework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework
86
+ *MetricCostsPerYearApi* | [**deleteMetricCostForFramework**](docs/MetricCostsPerYearApi.md#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework
87
+ *MetricCostsPerYearApi* | [**getMetricCostForFramework**](docs/MetricCostsPerYearApi.md#getmetriccostforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework
88
+ *MetricCostsPerYearApi* | [**getMetricCostsForFramework**](docs/MetricCostsPerYearApi.md#getmetriccostsforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework
89
+ *MetricCostsPerYearApi* | [**patchMetricCostForFramework**](docs/MetricCostsPerYearApi.md#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework
90
+ *ObjectiveApi* | [**createMetricForObjective**](docs/ObjectiveApi.md#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
91
+ *ObjectiveApi* | [**deleteMetricForObjective**](docs/ObjectiveApi.md#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
92
+ *ObjectiveApi* | [**deleteObjective**](docs/ObjectiveApi.md#deleteobjective) | **DELETE** /objective/{objective_id} | Delete an objective
93
+ *ObjectiveApi* | [**getMetricForObjective**](docs/ObjectiveApi.md#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
94
+ *ObjectiveApi* | [**getMetricsForObjective**](docs/ObjectiveApi.md#getmetricsforobjective) | **GET** /objective/{objective_id}/metric/ | List metrics for this objective
95
+ *ObjectiveApi* | [**getObjectiveById**](docs/ObjectiveApi.md#getobjectivebyid) | **GET** /objective/{objective_id} | Get an objective by ID
96
+ *ObjectiveApi* | [**getObjectives**](docs/ObjectiveApi.md#getobjectives) | **GET** /objective/ | List objectives
97
+ *ObjectiveApi* | [**getWeightsForObjective**](docs/ObjectiveApi.md#getweightsforobjective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective
98
+ *ObjectiveApi* | [**patchMetricForObjective**](docs/ObjectiveApi.md#patchmetricforobjective) | **PATCH** /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective
99
+ *ObjectiveApi* | [**patchObjective**](docs/ObjectiveApi.md#patchobjective) | **PATCH** /objective/{objective_id} | Partially update an objective
100
+ *ObjectiveApi* | [**postObjective**](docs/ObjectiveApi.md#postobjective) | **POST** /objective/ | Create an objective
101
+ *ObjectiveWeightApi* | [**createObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework
102
+ *ObjectiveWeightApi* | [**deleteObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework
103
+ *ObjectiveWeightApi* | [**getObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#getobjectiveweightforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework
104
+ *ObjectiveWeightApi* | [**getObjectiveWeightsForFramework**](docs/ObjectiveWeightApi.md#getobjectiveweightsforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework
105
+ *ObjectiveWeightApi* | [**patchObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework
106
+ *ObjectiveWeightsApi* | [**getWeightsForObjective**](docs/ObjectiveWeightsApi.md#getweightsforobjective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective
107
+ *OptionApi* | [**createImpactForOption**](docs/OptionApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
108
+ *OptionApi* | [**createOptionForInvestment**](docs/OptionApi.md#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment
109
+ *OptionApi* | [**deleteImpactForOption**](docs/OptionApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
110
+ *OptionApi* | [**deleteOptionForInvestment**](docs/OptionApi.md#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
111
+ *OptionApi* | [**getImpactForOption**](docs/OptionApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
112
+ *OptionApi* | [**getImpactsForOption**](docs/OptionApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
113
+ *OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
114
+ *OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
115
+ *OptionApi* | [**patchImpactForOption**](docs/OptionApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
116
+ *OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
117
+ *ValueFrameworkApi* | [**createMetricCostForFramework**](docs/ValueFrameworkApi.md#createmetriccostforframework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework
118
+ *ValueFrameworkApi* | [**createObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework
119
+ *ValueFrameworkApi* | [**deleteMetricCostForFramework**](docs/ValueFrameworkApi.md#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework
120
+ *ValueFrameworkApi* | [**deleteObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework
121
+ *ValueFrameworkApi* | [**deleteValueFramework**](docs/ValueFrameworkApi.md#deletevalueframework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework
122
+ *ValueFrameworkApi* | [**getCostsForValueFramework**](docs/ValueFrameworkApi.md#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework
123
+ *ValueFrameworkApi* | [**getCostsForValueFrameworkByMetric**](docs/ValueFrameworkApi.md#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric
124
+ *ValueFrameworkApi* | [**getMetricCostForFramework**](docs/ValueFrameworkApi.md#getmetriccostforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework
125
+ *ValueFrameworkApi* | [**getMetricCostsForFramework**](docs/ValueFrameworkApi.md#getmetriccostsforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework
126
+ *ValueFrameworkApi* | [**getObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#getobjectiveweightforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework
127
+ *ValueFrameworkApi* | [**getObjectiveWeightsForFramework**](docs/ValueFrameworkApi.md#getobjectiveweightsforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework
128
+ *ValueFrameworkApi* | [**getValueFrameworkById**](docs/ValueFrameworkApi.md#getvalueframeworkbyid) | **GET** /value_framework/{value_framework_id} | Get a value framework by ID
129
+ *ValueFrameworkApi* | [**getValueFrameworks**](docs/ValueFrameworkApi.md#getvalueframeworks) | **GET** /value_framework/ | List value frameworks
130
+ *ValueFrameworkApi* | [**getWeightsForValueFramework**](docs/ValueFrameworkApi.md#getweightsforvalueframework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework
131
+ *ValueFrameworkApi* | [**patchMetricCostForFramework**](docs/ValueFrameworkApi.md#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework
132
+ *ValueFrameworkApi* | [**patchObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework
133
+ *ValueFrameworkApi* | [**patchValueFramework**](docs/ValueFrameworkApi.md#patchvalueframework) | **PATCH** /value_framework/{value_framework_id} | Partially update a value framework
134
+ *ValueFrameworkApi* | [**postValueFramework**](docs/ValueFrameworkApi.md#postvalueframework) | **POST** /value_framework/ | Create a value framework
135
+ *ValueFrameworkCostsApi* | [**getCostsForValueFramework**](docs/ValueFrameworkCostsApi.md#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework
136
+ *ValueFrameworkCostsApi* | [**getCostsForValueFrameworkByMetric**](docs/ValueFrameworkCostsApi.md#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric
137
+ *ValueFrameworkWeightsApi* | [**getWeightsForValueFramework**](docs/ValueFrameworkWeightsApi.md#getweightsforvalueframework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework
138
+
139
+
140
+ ### Documentation For Models
141
+
142
+ - [EvolutionType](docs/EvolutionType.md)
143
+ - [FavoredOptionRequest](docs/FavoredOptionRequest.md)
144
+ - [FavoredOptionResponse](docs/FavoredOptionResponse.md)
145
+ - [HTTPValidationError](docs/HTTPValidationError.md)
146
+ - [ImpactAPIResponse](docs/ImpactAPIResponse.md)
147
+ - [ImpactCreate](docs/ImpactCreate.md)
148
+ - [ImpactUpdate](docs/ImpactUpdate.md)
149
+ - [InvestmentCreate](docs/InvestmentCreate.md)
150
+ - [InvestmentResponse](docs/InvestmentResponse.md)
151
+ - [InvestmentUpdate](docs/InvestmentUpdate.md)
152
+ - [LocationInner](docs/LocationInner.md)
153
+ - [MeasurementType](docs/MeasurementType.md)
154
+ - [MetricCostsPerYearCreate](docs/MetricCostsPerYearCreate.md)
155
+ - [MetricCostsPerYearResponse](docs/MetricCostsPerYearResponse.md)
156
+ - [MetricCostsPerYearUpdate](docs/MetricCostsPerYearUpdate.md)
157
+ - [MetricCreate](docs/MetricCreate.md)
158
+ - [MetricResponse](docs/MetricResponse.md)
159
+ - [MetricType](docs/MetricType.md)
160
+ - [MetricUpdate](docs/MetricUpdate.md)
161
+ - [ObjectiveCreate](docs/ObjectiveCreate.md)
162
+ - [ObjectiveResponse](docs/ObjectiveResponse.md)
163
+ - [ObjectiveUpdate](docs/ObjectiveUpdate.md)
164
+ - [ObjectiveWeightCreate](docs/ObjectiveWeightCreate.md)
165
+ - [ObjectiveWeightResponse](docs/ObjectiveWeightResponse.md)
166
+ - [ObjectiveWeightUpdate](docs/ObjectiveWeightUpdate.md)
167
+ - [OptionCreate](docs/OptionCreate.md)
168
+ - [OptionResponse](docs/OptionResponse.md)
169
+ - [OptionUpdate](docs/OptionUpdate.md)
170
+ - [ValidationError](docs/ValidationError.md)
171
+ - [ValueFrameworkCreate](docs/ValueFrameworkCreate.md)
172
+ - [ValueFrameworkResponse](docs/ValueFrameworkResponse.md)
173
+ - [ValueFrameworkUpdate](docs/ValueFrameworkUpdate.md)
174
+
175
+
176
+ <a id="documentation-for-authorization"></a>
177
+ ## Documentation For Authorization
178
+
179
+
180
+ Authentication schemes defined for the API:
181
+ <a id="OAuth2AuthorizationCodeBearer"></a>
182
+ ### OAuth2AuthorizationCodeBearer
183
+
184
+ - **Type**: OAuth
185
+ - **Flow**: accessCode
186
+ - **Authorization URL**: None/protocol/openid-connect/auth
187
+ - **Scopes**: N/A
188
+
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev2
7
+ * The version of the OpenAPI document: 0.2.0-dev3
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,12 +18,11 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
18
  import globalAxios from 'axios';
19
19
  // Some imports not used depending on template conditions
20
20
  // @ts-ignore
21
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
22
  // @ts-ignore
23
- import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  /**
25
25
  * DefaultApi - axios parameter creator
26
- * @export
27
26
  */
28
27
  export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
29
28
  return {
@@ -46,8 +45,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
46
45
  const localVarHeaderParameter = {} as any;
47
46
  const localVarQueryParameter = {} as any;
48
47
 
48
+ localVarHeaderParameter['Accept'] = 'application/json';
49
49
 
50
-
51
50
  setSearchParams(localVarUrlObj, localVarQueryParameter);
52
51
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
53
52
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -62,7 +61,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
62
61
 
63
62
  /**
64
63
  * DefaultApi - functional programming interface
65
- * @export
66
64
  */
67
65
  export const DefaultApiFp = function(configuration?: Configuration) {
68
66
  const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
@@ -75,16 +73,15 @@ export const DefaultApiFp = function(configuration?: Configuration) {
75
73
  */
76
74
  async root(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
77
75
  const localVarAxiosArgs = await localVarAxiosParamCreator.root(options);
78
- const index = configuration?.serverIndex ?? 0;
79
- const operationBasePath = operationServerMap['DefaultApi.root']?.[index]?.url;
80
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
76
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
77
+ const localVarOperationServerBasePath = operationServerMap['DefaultApi.root']?.[localVarOperationServerIndex]?.url;
78
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
81
79
  },
82
80
  }
83
81
  };
84
82
 
85
83
  /**
86
84
  * DefaultApi - factory interface
87
- * @export
88
85
  */
89
86
  export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
90
87
  const localVarFp = DefaultApiFp(configuration)
@@ -95,7 +92,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
95
92
  * @param {*} [options] Override http request option.
96
93
  * @throws {RequiredError}
97
94
  */
98
- root(options?: any): AxiosPromise<any> {
95
+ root(options?: RawAxiosRequestConfig): AxiosPromise<any> {
99
96
  return localVarFp.root(options).then((request) => request(axios, basePath));
100
97
  },
101
98
  };
@@ -103,9 +100,6 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
103
100
 
104
101
  /**
105
102
  * DefaultApi - object-oriented interface
106
- * @export
107
- * @class DefaultApi
108
- * @extends {BaseAPI}
109
103
  */
110
104
  export class DefaultApi extends BaseAPI {
111
105
  /**
@@ -113,7 +107,6 @@ export class DefaultApi extends BaseAPI {
113
107
  * @summary Root
114
108
  * @param {*} [options] Override http request option.
115
109
  * @throws {RequiredError}
116
- * @memberof DefaultApi
117
110
  */
118
111
  public root(options?: RawAxiosRequestConfig) {
119
112
  return DefaultApiFp(this.configuration).root(options).then((request) => request(this.axios, this.basePath));
@@ -0,0 +1,210 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Asset Investment Planning
5
+ * API for Asset Investment Planning
6
+ *
7
+ * The version of the OpenAPI document: 0.2.0-dev3
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { FavoredOptionRequest } from '../models';
26
+ // @ts-ignore
27
+ import type { FavoredOptionResponse } from '../models';
28
+ /**
29
+ * FavoredOptionApi - axios parameter creator
30
+ */
31
+ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * Get the preferred option for an investment.
35
+ * @summary Get the preferred option for an investment
36
+ * @param {string} investmentId UUID of the investment
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
41
+ // verify required parameter 'investmentId' is not null or undefined
42
+ assertParamExists('getFavoredOption', 'investmentId', investmentId)
43
+ const localVarPath = `/investment/{investment_id}/favored_option`
44
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ // authentication OAuth2AuthorizationCodeBearer required
57
+ // oauth required
58
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
59
+
60
+ localVarHeaderParameter['Accept'] = 'application/json';
61
+
62
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
65
+
66
+ return {
67
+ url: toPathString(localVarUrlObj),
68
+ options: localVarRequestOptions,
69
+ };
70
+ },
71
+ /**
72
+ * Set the preferred option for an investment.
73
+ * @summary Set the preferred option for an investment
74
+ * @param {string} investmentId UUID of the investment
75
+ * @param {FavoredOptionRequest} favoredOptionRequest
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ setFavoredOption: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
80
+ // verify required parameter 'investmentId' is not null or undefined
81
+ assertParamExists('setFavoredOption', 'investmentId', investmentId)
82
+ // verify required parameter 'favoredOptionRequest' is not null or undefined
83
+ assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest)
84
+ const localVarPath = `/investment/{investment_id}/favored_option`
85
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
86
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
87
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
88
+ let baseOptions;
89
+ if (configuration) {
90
+ baseOptions = configuration.baseOptions;
91
+ }
92
+
93
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
94
+ const localVarHeaderParameter = {} as any;
95
+ const localVarQueryParameter = {} as any;
96
+
97
+ // authentication OAuth2AuthorizationCodeBearer required
98
+ // oauth required
99
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
100
+
101
+ localVarHeaderParameter['Content-Type'] = 'application/json';
102
+ localVarHeaderParameter['Accept'] = 'application/json';
103
+
104
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
105
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
107
+ localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
108
+
109
+ return {
110
+ url: toPathString(localVarUrlObj),
111
+ options: localVarRequestOptions,
112
+ };
113
+ },
114
+ }
115
+ };
116
+
117
+ /**
118
+ * FavoredOptionApi - functional programming interface
119
+ */
120
+ export const FavoredOptionApiFp = function(configuration?: Configuration) {
121
+ const localVarAxiosParamCreator = FavoredOptionApiAxiosParamCreator(configuration)
122
+ return {
123
+ /**
124
+ * Get the preferred option for an investment.
125
+ * @summary Get the preferred option for an investment
126
+ * @param {string} investmentId UUID of the investment
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
131
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
132
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
133
+ const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.getFavoredOption']?.[localVarOperationServerIndex]?.url;
134
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
135
+ },
136
+ /**
137
+ * Set the preferred option for an investment.
138
+ * @summary Set the preferred option for an investment
139
+ * @param {string} investmentId UUID of the investment
140
+ * @param {FavoredOptionRequest} favoredOptionRequest
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ */
144
+ async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
145
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
146
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
147
+ const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
148
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
149
+ },
150
+ }
151
+ };
152
+
153
+ /**
154
+ * FavoredOptionApi - factory interface
155
+ */
156
+ export const FavoredOptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
157
+ const localVarFp = FavoredOptionApiFp(configuration)
158
+ return {
159
+ /**
160
+ * Get the preferred option for an investment.
161
+ * @summary Get the preferred option for an investment
162
+ * @param {string} investmentId UUID of the investment
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
167
+ return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
168
+ },
169
+ /**
170
+ * Set the preferred option for an investment.
171
+ * @summary Set the preferred option for an investment
172
+ * @param {string} investmentId UUID of the investment
173
+ * @param {FavoredOptionRequest} favoredOptionRequest
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
178
+ return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
179
+ },
180
+ };
181
+ };
182
+
183
+ /**
184
+ * FavoredOptionApi - object-oriented interface
185
+ */
186
+ export class FavoredOptionApi extends BaseAPI {
187
+ /**
188
+ * Get the preferred option for an investment.
189
+ * @summary Get the preferred option for an investment
190
+ * @param {string} investmentId UUID of the investment
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
195
+ return FavoredOptionApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
196
+ }
197
+
198
+ /**
199
+ * Set the preferred option for an investment.
200
+ * @summary Set the preferred option for an investment
201
+ * @param {string} investmentId UUID of the investment
202
+ * @param {FavoredOptionRequest} favoredOptionRequest
203
+ * @param {*} [options] Override http request option.
204
+ * @throws {RequiredError}
205
+ */
206
+ public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
207
+ return FavoredOptionApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
208
+ }
209
+ }
210
+