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

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 (280) hide show
  1. package/README.md +12 -8
  2. package/api/default-api.ts +1 -1
  3. package/api/impact-api.ts +1 -1
  4. package/api/investment-api.ts +182 -94
  5. package/api/metric-api.ts +1 -1
  6. package/api/metric-costs-api.ts +1 -1
  7. package/api/metric-costs-per-year-api.ts +1 -1
  8. package/api/objective-api.ts +1 -1
  9. package/api/objective-weight-api.ts +1 -1
  10. package/api/objective-weights-api.ts +1 -1
  11. package/api/option-api.ts +89 -1
  12. package/api/{favored-option-api.ts → preferred-option-api.ts} +40 -40
  13. package/api/value-framework-api.ts +1 -1
  14. package/api/value-framework-costs-api.ts +1 -1
  15. package/api/value-framework-weights-api.ts +1 -1
  16. package/api.ts +2 -2
  17. package/base.ts +1 -1
  18. package/common.ts +1 -1
  19. package/configuration.ts +1 -1
  20. package/dist/api/default-api.d.ts +1 -1
  21. package/dist/api/default-api.js +1 -1
  22. package/dist/api/impact-api.d.ts +1 -1
  23. package/dist/api/impact-api.js +1 -1
  24. package/dist/api/investment-api.d.ts +84 -43
  25. package/dist/api/investment-api.js +170 -87
  26. package/dist/api/metric-api.d.ts +1 -1
  27. package/dist/api/metric-api.js +1 -1
  28. package/dist/api/metric-costs-api.d.ts +1 -1
  29. package/dist/api/metric-costs-api.js +1 -1
  30. package/dist/api/metric-costs-per-year-api.d.ts +1 -1
  31. package/dist/api/metric-costs-per-year-api.js +1 -1
  32. package/dist/api/objective-api.d.ts +1 -1
  33. package/dist/api/objective-api.js +1 -1
  34. package/dist/api/objective-weight-api.d.ts +1 -1
  35. package/dist/api/objective-weight-api.js +1 -1
  36. package/dist/api/objective-weights-api.d.ts +1 -1
  37. package/dist/api/objective-weights-api.js +1 -1
  38. package/dist/api/option-api.d.ts +42 -1
  39. package/dist/api/option-api.js +84 -1
  40. package/dist/api/{favored-option-api.d.ts → preferred-option-api.d.ts} +23 -23
  41. package/dist/api/{favored-option-api.js → preferred-option-api.js} +43 -43
  42. package/dist/api/value-framework-api.d.ts +1 -1
  43. package/dist/api/value-framework-api.js +1 -1
  44. package/dist/api/value-framework-costs-api.d.ts +1 -1
  45. package/dist/api/value-framework-costs-api.js +1 -1
  46. package/dist/api/value-framework-weights-api.d.ts +1 -1
  47. package/dist/api/value-framework-weights-api.js +1 -1
  48. package/dist/api.d.ts +2 -2
  49. package/dist/api.js +2 -2
  50. package/dist/base.d.ts +1 -1
  51. package/dist/base.js +1 -1
  52. package/dist/common.d.ts +1 -1
  53. package/dist/common.js +1 -1
  54. package/dist/configuration.d.ts +1 -1
  55. package/dist/configuration.js +1 -1
  56. package/dist/esm/api/default-api.d.ts +1 -1
  57. package/dist/esm/api/default-api.js +1 -1
  58. package/dist/esm/api/impact-api.d.ts +1 -1
  59. package/dist/esm/api/impact-api.js +1 -1
  60. package/dist/esm/api/investment-api.d.ts +84 -43
  61. package/dist/esm/api/investment-api.js +170 -87
  62. package/dist/esm/api/metric-api.d.ts +1 -1
  63. package/dist/esm/api/metric-api.js +1 -1
  64. package/dist/esm/api/metric-costs-api.d.ts +1 -1
  65. package/dist/esm/api/metric-costs-api.js +1 -1
  66. package/dist/esm/api/metric-costs-per-year-api.d.ts +1 -1
  67. package/dist/esm/api/metric-costs-per-year-api.js +1 -1
  68. package/dist/esm/api/objective-api.d.ts +1 -1
  69. package/dist/esm/api/objective-api.js +1 -1
  70. package/dist/esm/api/objective-weight-api.d.ts +1 -1
  71. package/dist/esm/api/objective-weight-api.js +1 -1
  72. package/dist/esm/api/objective-weights-api.d.ts +1 -1
  73. package/dist/esm/api/objective-weights-api.js +1 -1
  74. package/dist/esm/api/option-api.d.ts +42 -1
  75. package/dist/esm/api/option-api.js +84 -1
  76. package/dist/esm/api/{favored-option-api.d.ts → preferred-option-api.d.ts} +23 -23
  77. package/dist/esm/api/{favored-option-api.js → preferred-option-api.js} +38 -38
  78. package/dist/esm/api/value-framework-api.d.ts +1 -1
  79. package/dist/esm/api/value-framework-api.js +1 -1
  80. package/dist/esm/api/value-framework-costs-api.d.ts +1 -1
  81. package/dist/esm/api/value-framework-costs-api.js +1 -1
  82. package/dist/esm/api/value-framework-weights-api.d.ts +1 -1
  83. package/dist/esm/api/value-framework-weights-api.js +1 -1
  84. package/dist/esm/api.d.ts +2 -2
  85. package/dist/esm/api.js +2 -2
  86. package/dist/esm/base.d.ts +1 -1
  87. package/dist/esm/base.js +1 -1
  88. package/dist/esm/common.d.ts +1 -1
  89. package/dist/esm/common.js +1 -1
  90. package/dist/esm/configuration.d.ts +1 -1
  91. package/dist/esm/configuration.js +1 -1
  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 +1 -1
  95. package/dist/esm/models/evolution-type.js +1 -1
  96. package/dist/esm/models/httpvalidation-error.d.ts +1 -1
  97. package/dist/esm/models/httpvalidation-error.js +1 -1
  98. package/dist/esm/models/impact-apiresponse.d.ts +1 -1
  99. package/dist/esm/models/impact-apiresponse.js +1 -1
  100. package/dist/esm/models/impact-create.d.ts +1 -1
  101. package/dist/esm/models/impact-create.js +1 -1
  102. package/dist/esm/models/impact-update.d.ts +1 -1
  103. package/dist/esm/models/impact-update.js +1 -1
  104. package/dist/esm/models/index.d.ts +4 -2
  105. package/dist/esm/models/index.js +4 -2
  106. package/dist/esm/models/investment-create.d.ts +1 -1
  107. package/dist/esm/models/investment-create.js +1 -1
  108. package/dist/esm/models/investment-response.d.ts +1 -1
  109. package/dist/esm/models/investment-response.js +1 -1
  110. package/dist/esm/models/investment-update.d.ts +1 -1
  111. package/dist/esm/models/investment-update.js +1 -1
  112. package/dist/esm/models/location-inner.d.ts +1 -1
  113. package/dist/esm/models/location-inner.js +1 -1
  114. package/dist/esm/models/measurement-type.d.ts +1 -1
  115. package/dist/esm/models/measurement-type.js +1 -1
  116. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
  117. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  118. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
  119. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  120. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
  121. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  122. package/dist/esm/models/metric-create.d.ts +1 -1
  123. package/dist/esm/models/metric-create.js +1 -1
  124. package/dist/esm/models/metric-response.d.ts +1 -1
  125. package/dist/esm/models/metric-response.js +1 -1
  126. package/dist/esm/models/metric-type.d.ts +1 -1
  127. package/dist/esm/models/metric-type.js +1 -1
  128. package/dist/esm/models/metric-update.d.ts +1 -1
  129. package/dist/esm/models/metric-update.js +1 -1
  130. package/dist/esm/models/objective-create.d.ts +1 -1
  131. package/dist/esm/models/objective-create.js +1 -1
  132. package/dist/esm/models/objective-response.d.ts +1 -1
  133. package/dist/esm/models/objective-response.js +1 -1
  134. package/dist/esm/models/objective-update.d.ts +1 -1
  135. package/dist/esm/models/objective-update.js +1 -1
  136. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  137. package/dist/esm/models/objective-weight-create.js +1 -1
  138. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  139. package/dist/esm/models/objective-weight-response.js +1 -1
  140. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  141. package/dist/esm/models/objective-weight-update.js +1 -1
  142. package/dist/esm/models/option-chart-kpi.d.ts +29 -0
  143. package/dist/esm/models/{favored-option-request.js → option-chart-kpi.js} +1 -1
  144. package/dist/esm/models/option-chart-kpis-yearly.d.ts +29 -0
  145. package/dist/esm/models/{favored-option-response.js → option-chart-kpis-yearly.js} +1 -1
  146. package/dist/esm/models/option-create.d.ts +2 -2
  147. package/dist/esm/models/option-create.js +1 -1
  148. package/dist/esm/models/option-response.d.ts +1 -1
  149. package/dist/esm/models/option-response.js +1 -1
  150. package/dist/esm/models/option-update.d.ts +1 -1
  151. package/dist/esm/models/option-update.js +1 -1
  152. package/dist/esm/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  153. package/dist/esm/models/preferred-option-request.js +14 -0
  154. package/dist/esm/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  155. package/dist/esm/models/preferred-option-response.js +14 -0
  156. package/dist/esm/models/validation-error.d.ts +1 -1
  157. package/dist/esm/models/validation-error.js +1 -1
  158. package/dist/esm/models/value-framework-create.d.ts +1 -1
  159. package/dist/esm/models/value-framework-create.js +1 -1
  160. package/dist/esm/models/value-framework-response.d.ts +1 -1
  161. package/dist/esm/models/value-framework-response.js +1 -1
  162. package/dist/esm/models/value-framework-update.d.ts +1 -1
  163. package/dist/esm/models/value-framework-update.js +1 -1
  164. package/dist/index.d.ts +1 -1
  165. package/dist/index.js +1 -1
  166. package/dist/models/evolution-type.d.ts +1 -1
  167. package/dist/models/evolution-type.js +1 -1
  168. package/dist/models/httpvalidation-error.d.ts +1 -1
  169. package/dist/models/httpvalidation-error.js +1 -1
  170. package/dist/models/impact-apiresponse.d.ts +1 -1
  171. package/dist/models/impact-apiresponse.js +1 -1
  172. package/dist/models/impact-create.d.ts +1 -1
  173. package/dist/models/impact-create.js +1 -1
  174. package/dist/models/impact-update.d.ts +1 -1
  175. package/dist/models/impact-update.js +1 -1
  176. package/dist/models/index.d.ts +4 -2
  177. package/dist/models/index.js +4 -2
  178. package/dist/models/investment-create.d.ts +1 -1
  179. package/dist/models/investment-create.js +1 -1
  180. package/dist/models/investment-response.d.ts +1 -1
  181. package/dist/models/investment-response.js +1 -1
  182. package/dist/models/investment-update.d.ts +1 -1
  183. package/dist/models/investment-update.js +1 -1
  184. package/dist/models/location-inner.d.ts +1 -1
  185. package/dist/models/location-inner.js +1 -1
  186. package/dist/models/measurement-type.d.ts +1 -1
  187. package/dist/models/measurement-type.js +1 -1
  188. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  189. package/dist/models/metric-costs-per-year-create.js +1 -1
  190. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  191. package/dist/models/metric-costs-per-year-response.js +1 -1
  192. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  193. package/dist/models/metric-costs-per-year-update.js +1 -1
  194. package/dist/models/metric-create.d.ts +1 -1
  195. package/dist/models/metric-create.js +1 -1
  196. package/dist/models/metric-response.d.ts +1 -1
  197. package/dist/models/metric-response.js +1 -1
  198. package/dist/models/metric-type.d.ts +1 -1
  199. package/dist/models/metric-type.js +1 -1
  200. package/dist/models/metric-update.d.ts +1 -1
  201. package/dist/models/metric-update.js +1 -1
  202. package/dist/models/objective-create.d.ts +1 -1
  203. package/dist/models/objective-create.js +1 -1
  204. package/dist/models/objective-response.d.ts +1 -1
  205. package/dist/models/objective-response.js +1 -1
  206. package/dist/models/objective-update.d.ts +1 -1
  207. package/dist/models/objective-update.js +1 -1
  208. package/dist/models/objective-weight-create.d.ts +1 -1
  209. package/dist/models/objective-weight-create.js +1 -1
  210. package/dist/models/objective-weight-response.d.ts +1 -1
  211. package/dist/models/objective-weight-response.js +1 -1
  212. package/dist/models/objective-weight-update.d.ts +1 -1
  213. package/dist/models/objective-weight-update.js +1 -1
  214. package/dist/models/option-chart-kpi.d.ts +29 -0
  215. package/dist/models/{favored-option-request.js → option-chart-kpi.js} +1 -1
  216. package/dist/models/option-chart-kpis-yearly.d.ts +29 -0
  217. package/dist/models/{favored-option-response.js → option-chart-kpis-yearly.js} +1 -1
  218. package/dist/models/option-create.d.ts +2 -2
  219. package/dist/models/option-create.js +1 -1
  220. package/dist/models/option-response.d.ts +1 -1
  221. package/dist/models/option-response.js +1 -1
  222. package/dist/models/option-update.d.ts +1 -1
  223. package/dist/models/option-update.js +1 -1
  224. package/dist/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  225. package/dist/models/preferred-option-request.js +15 -0
  226. package/dist/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  227. package/dist/models/preferred-option-response.js +15 -0
  228. package/dist/models/validation-error.d.ts +1 -1
  229. package/dist/models/validation-error.js +1 -1
  230. package/dist/models/value-framework-create.d.ts +1 -1
  231. package/dist/models/value-framework-create.js +1 -1
  232. package/dist/models/value-framework-response.d.ts +1 -1
  233. package/dist/models/value-framework-response.js +1 -1
  234. package/dist/models/value-framework-update.d.ts +1 -1
  235. package/dist/models/value-framework-update.js +1 -1
  236. package/docs/InvestmentApi.md +122 -63
  237. package/docs/OptionApi.md +59 -0
  238. package/docs/OptionChartKPI.md +27 -0
  239. package/docs/OptionChartKPIsYearly.md +25 -0
  240. package/docs/OptionCreate.md +1 -1
  241. package/docs/{FavoredOptionApi.md → PreferredOptionApi.md} +19 -19
  242. package/docs/{FavoredOptionRequest.md → PreferredOptionRequest.md} +3 -3
  243. package/docs/{FavoredOptionResponse.md → PreferredOptionResponse.md} +4 -4
  244. package/index.ts +1 -1
  245. package/models/evolution-type.ts +1 -1
  246. package/models/httpvalidation-error.ts +1 -1
  247. package/models/impact-apiresponse.ts +1 -1
  248. package/models/impact-create.ts +1 -1
  249. package/models/impact-update.ts +1 -1
  250. package/models/index.ts +4 -2
  251. package/models/investment-create.ts +1 -1
  252. package/models/investment-response.ts +1 -1
  253. package/models/investment-update.ts +1 -1
  254. package/models/location-inner.ts +1 -1
  255. package/models/measurement-type.ts +1 -1
  256. package/models/metric-costs-per-year-create.ts +1 -1
  257. package/models/metric-costs-per-year-response.ts +1 -1
  258. package/models/metric-costs-per-year-update.ts +1 -1
  259. package/models/metric-create.ts +1 -1
  260. package/models/metric-response.ts +1 -1
  261. package/models/metric-type.ts +1 -1
  262. package/models/metric-update.ts +1 -1
  263. package/models/objective-create.ts +1 -1
  264. package/models/objective-response.ts +1 -1
  265. package/models/objective-update.ts +1 -1
  266. package/models/objective-weight-create.ts +1 -1
  267. package/models/objective-weight-response.ts +1 -1
  268. package/models/objective-weight-update.ts +1 -1
  269. package/models/option-chart-kpi.ts +35 -0
  270. package/models/option-chart-kpis-yearly.ts +37 -0
  271. package/models/option-create.ts +2 -2
  272. package/models/option-response.ts +1 -1
  273. package/models/option-update.ts +1 -1
  274. package/models/{favored-option-request.ts → preferred-option-request.ts} +2 -2
  275. package/models/{favored-option-response.ts → preferred-option-response.ts} +3 -3
  276. package/models/validation-error.ts +1 -1
  277. package/models/value-framework-create.ts +1 -1
  278. package/models/value-framework-response.ts +1 -1
  279. package/models/value-framework-update.ts +1 -1
  280. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @cosmotech/aip-client@0.2.0-dev4
1
+ ## @cosmotech/aip-client@0.2.0-dev6
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
 
@@ -36,7 +36,7 @@ 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-dev4 --save
39
+ npm install @cosmotech/aip-client@0.2.0-dev6 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -52,8 +52,6 @@ All URIs are relative to *http://localhost*
52
52
  Class | Method | HTTP request | Description
53
53
  ------------ | ------------- | ------------- | -------------
54
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
55
  *ImpactApi* | [**createImpactForOption**](docs/ImpactApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
58
56
  *ImpactApi* | [**deleteImpactForOption**](docs/ImpactApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
59
57
  *ImpactApi* | [**getImpactForOption**](docs/ImpactApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
@@ -64,18 +62,19 @@ Class | Method | HTTP request | Description
64
62
  *InvestmentApi* | [**deleteImpactForOption**](docs/InvestmentApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
65
63
  *InvestmentApi* | [**deleteInvestment**](docs/InvestmentApi.md#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment
66
64
  *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
65
  *InvestmentApi* | [**getImpactForOption**](docs/InvestmentApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
69
66
  *InvestmentApi* | [**getImpactsForOption**](docs/InvestmentApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
70
67
  *InvestmentApi* | [**getInvestmentById**](docs/InvestmentApi.md#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID
71
68
  *InvestmentApi* | [**getInvestments**](docs/InvestmentApi.md#getinvestments) | **GET** /investment/ | List investments
72
69
  *InvestmentApi* | [**getOptionForInvestment**](docs/InvestmentApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
70
+ *InvestmentApi* | [**getOptionKpis**](docs/InvestmentApi.md#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework
73
71
  *InvestmentApi* | [**getOptionsForInvestment**](docs/InvestmentApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
72
+ *InvestmentApi* | [**getPreferredOption**](docs/InvestmentApi.md#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment
74
73
  *InvestmentApi* | [**patchImpactForOption**](docs/InvestmentApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
75
74
  *InvestmentApi* | [**patchInvestment**](docs/InvestmentApi.md#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment
76
75
  *InvestmentApi* | [**patchOptionForInvestment**](docs/InvestmentApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
77
76
  *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
77
+ *InvestmentApi* | [**setPreferredOption**](docs/InvestmentApi.md#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment
79
78
  *MetricApi* | [**createMetricForObjective**](docs/MetricApi.md#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
80
79
  *MetricApi* | [**deleteMetricForObjective**](docs/MetricApi.md#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
81
80
  *MetricApi* | [**getMetricForObjective**](docs/MetricApi.md#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
@@ -111,9 +110,12 @@ Class | Method | HTTP request | Description
111
110
  *OptionApi* | [**getImpactForOption**](docs/OptionApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
112
111
  *OptionApi* | [**getImpactsForOption**](docs/OptionApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
113
112
  *OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
113
+ *OptionApi* | [**getOptionKpis**](docs/OptionApi.md#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework
114
114
  *OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
115
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
116
  *OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
117
+ *PreferredOptionApi* | [**getPreferredOption**](docs/PreferredOptionApi.md#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment
118
+ *PreferredOptionApi* | [**setPreferredOption**](docs/PreferredOptionApi.md#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment
117
119
  *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
120
  *ValueFrameworkApi* | [**createObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework
119
121
  *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
@@ -140,8 +142,6 @@ Class | Method | HTTP request | Description
140
142
  ### Documentation For Models
141
143
 
142
144
  - [EvolutionType](docs/EvolutionType.md)
143
- - [FavoredOptionRequest](docs/FavoredOptionRequest.md)
144
- - [FavoredOptionResponse](docs/FavoredOptionResponse.md)
145
145
  - [HTTPValidationError](docs/HTTPValidationError.md)
146
146
  - [ImpactAPIResponse](docs/ImpactAPIResponse.md)
147
147
  - [ImpactCreate](docs/ImpactCreate.md)
@@ -164,9 +164,13 @@ Class | Method | HTTP request | Description
164
164
  - [ObjectiveWeightCreate](docs/ObjectiveWeightCreate.md)
165
165
  - [ObjectiveWeightResponse](docs/ObjectiveWeightResponse.md)
166
166
  - [ObjectiveWeightUpdate](docs/ObjectiveWeightUpdate.md)
167
+ - [OptionChartKPI](docs/OptionChartKPI.md)
168
+ - [OptionChartKPIsYearly](docs/OptionChartKPIsYearly.md)
167
169
  - [OptionCreate](docs/OptionCreate.md)
168
170
  - [OptionResponse](docs/OptionResponse.md)
169
171
  - [OptionUpdate](docs/OptionUpdate.md)
172
+ - [PreferredOptionRequest](docs/PreferredOptionRequest.md)
173
+ - [PreferredOptionResponse](docs/PreferredOptionResponse.md)
170
174
  - [ValidationError](docs/ValidationError.md)
171
175
  - [ValueFrameworkCreate](docs/ValueFrameworkCreate.md)
172
176
  - [ValueFrameworkResponse](docs/ValueFrameworkResponse.md)
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/api/impact-api.ts CHANGED
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,10 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  // @ts-ignore
23
23
  import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
24
  // @ts-ignore
25
- import type { FavoredOptionRequest } from '../models';
26
- // @ts-ignore
27
- import type { FavoredOptionResponse } from '../models';
28
- // @ts-ignore
29
25
  import type { ImpactAPIResponse } from '../models';
30
26
  // @ts-ignore
31
27
  import type { ImpactCreate } from '../models';
@@ -38,11 +34,17 @@ import type { InvestmentResponse } from '../models';
38
34
  // @ts-ignore
39
35
  import type { InvestmentUpdate } from '../models';
40
36
  // @ts-ignore
37
+ import type { OptionChartKPIsYearly } from '../models';
38
+ // @ts-ignore
41
39
  import type { OptionCreate } from '../models';
42
40
  // @ts-ignore
43
41
  import type { OptionResponse } from '../models';
44
42
  // @ts-ignore
45
43
  import type { OptionUpdate } from '../models';
44
+ // @ts-ignore
45
+ import type { PreferredOptionRequest } from '../models';
46
+ // @ts-ignore
47
+ import type { PreferredOptionResponse } from '../models';
46
48
  /**
47
49
  * InvestmentApi - axios parameter creator
48
50
  */
@@ -252,44 +254,6 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
252
254
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
253
255
 
254
256
 
255
- setSearchParams(localVarUrlObj, localVarQueryParameter);
256
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
257
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
258
-
259
- return {
260
- url: toPathString(localVarUrlObj),
261
- options: localVarRequestOptions,
262
- };
263
- },
264
- /**
265
- * Get the preferred option for an investment.
266
- * @summary Get the preferred option for an investment
267
- * @param {string} investmentId UUID of the investment
268
- * @param {*} [options] Override http request option.
269
- * @throws {RequiredError}
270
- */
271
- getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
272
- // verify required parameter 'investmentId' is not null or undefined
273
- assertParamExists('getFavoredOption', 'investmentId', investmentId)
274
- const localVarPath = `/investment/{investment_id}/favored_option`
275
- .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
276
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
277
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
278
- let baseOptions;
279
- if (configuration) {
280
- baseOptions = configuration.baseOptions;
281
- }
282
-
283
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
284
- const localVarHeaderParameter = {} as any;
285
- const localVarQueryParameter = {} as any;
286
-
287
- // authentication OAuth2AuthorizationCodeBearer required
288
- // oauth required
289
- await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
290
-
291
- localVarHeaderParameter['Accept'] = 'application/json';
292
-
293
257
  setSearchParams(localVarUrlObj, localVarQueryParameter);
294
258
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
295
259
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -521,6 +485,52 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
521
485
  options: localVarRequestOptions,
522
486
  };
523
487
  },
488
+ /**
489
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
490
+ * @summary Get the kpis for a given option inside a value framework
491
+ * @param {string} investmentId UUID of the investment
492
+ * @param {string} optionId UUID of the option
493
+ * @param {string} valueFrameworkId UUID of the value framework
494
+ * @param {*} [options] Override http request option.
495
+ * @throws {RequiredError}
496
+ */
497
+ getOptionKpis: async (investmentId: string, optionId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
498
+ // verify required parameter 'investmentId' is not null or undefined
499
+ assertParamExists('getOptionKpis', 'investmentId', investmentId)
500
+ // verify required parameter 'optionId' is not null or undefined
501
+ assertParamExists('getOptionKpis', 'optionId', optionId)
502
+ // verify required parameter 'valueFrameworkId' is not null or undefined
503
+ assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId)
504
+ const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
505
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
506
+ .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
507
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
508
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
509
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
510
+ let baseOptions;
511
+ if (configuration) {
512
+ baseOptions = configuration.baseOptions;
513
+ }
514
+
515
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
516
+ const localVarHeaderParameter = {} as any;
517
+ const localVarQueryParameter = {} as any;
518
+
519
+ // authentication OAuth2AuthorizationCodeBearer required
520
+ // oauth required
521
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
522
+
523
+ localVarHeaderParameter['Accept'] = 'application/json';
524
+
525
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
526
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
527
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
528
+
529
+ return {
530
+ url: toPathString(localVarUrlObj),
531
+ options: localVarRequestOptions,
532
+ };
533
+ },
524
534
  /**
525
535
  * Retrieve a paginated list of all options for a specific investment.
526
536
  * @summary List options for this investment
@@ -569,6 +579,44 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
569
579
  options: localVarRequestOptions,
570
580
  };
571
581
  },
582
+ /**
583
+ * Get the preferred option for an investment.
584
+ * @summary Get the preferred option for an investment
585
+ * @param {string} investmentId UUID of the investment
586
+ * @param {*} [options] Override http request option.
587
+ * @throws {RequiredError}
588
+ */
589
+ getPreferredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
590
+ // verify required parameter 'investmentId' is not null or undefined
591
+ assertParamExists('getPreferredOption', 'investmentId', investmentId)
592
+ const localVarPath = `/investment/{investment_id}/preferred_option`
593
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
594
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
595
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
596
+ let baseOptions;
597
+ if (configuration) {
598
+ baseOptions = configuration.baseOptions;
599
+ }
600
+
601
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
602
+ const localVarHeaderParameter = {} as any;
603
+ const localVarQueryParameter = {} as any;
604
+
605
+ // authentication OAuth2AuthorizationCodeBearer required
606
+ // oauth required
607
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
608
+
609
+ localVarHeaderParameter['Accept'] = 'application/json';
610
+
611
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
612
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
613
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
614
+
615
+ return {
616
+ url: toPathString(localVarUrlObj),
617
+ options: localVarRequestOptions,
618
+ };
619
+ },
572
620
  /**
573
621
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
574
622
  * @summary Partially update an impact for this option
@@ -753,16 +801,16 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
753
801
  * Set the preferred option for an investment.
754
802
  * @summary Set the preferred option for an investment
755
803
  * @param {string} investmentId UUID of the investment
756
- * @param {FavoredOptionRequest} favoredOptionRequest
804
+ * @param {PreferredOptionRequest} preferredOptionRequest
757
805
  * @param {*} [options] Override http request option.
758
806
  * @throws {RequiredError}
759
807
  */
760
- setFavoredOption: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
808
+ setPreferredOption: async (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
761
809
  // verify required parameter 'investmentId' is not null or undefined
762
- assertParamExists('setFavoredOption', 'investmentId', investmentId)
763
- // verify required parameter 'favoredOptionRequest' is not null or undefined
764
- assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest)
765
- const localVarPath = `/investment/{investment_id}/favored_option`
810
+ assertParamExists('setPreferredOption', 'investmentId', investmentId)
811
+ // verify required parameter 'preferredOptionRequest' is not null or undefined
812
+ assertParamExists('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest)
813
+ const localVarPath = `/investment/{investment_id}/preferred_option`
766
814
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
767
815
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
768
816
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -785,7 +833,7 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
785
833
  setSearchParams(localVarUrlObj, localVarQueryParameter);
786
834
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
787
835
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
788
- localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
836
+ localVarRequestOptions.data = serializeDataIfNeeded(preferredOptionRequest, localVarRequestOptions, configuration)
789
837
 
790
838
  return {
791
839
  url: toPathString(localVarUrlObj),
@@ -872,19 +920,6 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
872
920
  const localVarOperationServerBasePath = operationServerMap['InvestmentApi.deleteOptionForInvestment']?.[localVarOperationServerIndex]?.url;
873
921
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
874
922
  },
875
- /**
876
- * Get the preferred option for an investment.
877
- * @summary Get the preferred option for an investment
878
- * @param {string} investmentId UUID of the investment
879
- * @param {*} [options] Override http request option.
880
- * @throws {RequiredError}
881
- */
882
- async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
883
- const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
884
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
885
- const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getFavoredOption']?.[localVarOperationServerIndex]?.url;
886
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
887
- },
888
923
  /**
889
924
  * Retrieve a specific impact for the option.
890
925
  * @summary Get an impact for this option
@@ -957,6 +992,21 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
957
992
  const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionForInvestment']?.[localVarOperationServerIndex]?.url;
958
993
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
959
994
  },
995
+ /**
996
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
997
+ * @summary Get the kpis for a given option inside a value framework
998
+ * @param {string} investmentId UUID of the investment
999
+ * @param {string} optionId UUID of the option
1000
+ * @param {string} valueFrameworkId UUID of the value framework
1001
+ * @param {*} [options] Override http request option.
1002
+ * @throws {RequiredError}
1003
+ */
1004
+ async getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
1005
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
1006
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1007
+ const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
1008
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1009
+ },
960
1010
  /**
961
1011
  * Retrieve a paginated list of all options for a specific investment.
962
1012
  * @summary List options for this investment
@@ -972,6 +1022,19 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
972
1022
  const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionsForInvestment']?.[localVarOperationServerIndex]?.url;
973
1023
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
974
1024
  },
1025
+ /**
1026
+ * Get the preferred option for an investment.
1027
+ * @summary Get the preferred option for an investment
1028
+ * @param {string} investmentId UUID of the investment
1029
+ * @param {*} [options] Override http request option.
1030
+ * @throws {RequiredError}
1031
+ */
1032
+ async getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
1033
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPreferredOption(investmentId, options);
1034
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1035
+ const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getPreferredOption']?.[localVarOperationServerIndex]?.url;
1036
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1037
+ },
975
1038
  /**
976
1039
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
977
1040
  * @summary Partially update an impact for this option
@@ -1034,14 +1097,14 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
1034
1097
  * Set the preferred option for an investment.
1035
1098
  * @summary Set the preferred option for an investment
1036
1099
  * @param {string} investmentId UUID of the investment
1037
- * @param {FavoredOptionRequest} favoredOptionRequest
1100
+ * @param {PreferredOptionRequest} preferredOptionRequest
1038
1101
  * @param {*} [options] Override http request option.
1039
1102
  * @throws {RequiredError}
1040
1103
  */
1041
- async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
1042
- const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
1104
+ async setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
1105
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
1043
1106
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1044
- const localVarOperationServerBasePath = operationServerMap['InvestmentApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
1107
+ const localVarOperationServerBasePath = operationServerMap['InvestmentApi.setPreferredOption']?.[localVarOperationServerIndex]?.url;
1045
1108
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1046
1109
  },
1047
1110
  }
@@ -1109,16 +1172,6 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
1109
1172
  deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
1110
1173
  return localVarFp.deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1111
1174
  },
1112
- /**
1113
- * Get the preferred option for an investment.
1114
- * @summary Get the preferred option for an investment
1115
- * @param {string} investmentId UUID of the investment
1116
- * @param {*} [options] Override http request option.
1117
- * @throws {RequiredError}
1118
- */
1119
- getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
1120
- return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
1121
- },
1122
1175
  /**
1123
1176
  * Retrieve a specific impact for the option.
1124
1177
  * @summary Get an impact for this option
@@ -1176,6 +1229,18 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
1176
1229
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse> {
1177
1230
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1178
1231
  },
1232
+ /**
1233
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1234
+ * @summary Get the kpis for a given option inside a value framework
1235
+ * @param {string} investmentId UUID of the investment
1236
+ * @param {string} optionId UUID of the option
1237
+ * @param {string} valueFrameworkId UUID of the value framework
1238
+ * @param {*} [options] Override http request option.
1239
+ * @throws {RequiredError}
1240
+ */
1241
+ getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
1242
+ return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
1243
+ },
1179
1244
  /**
1180
1245
  * Retrieve a paginated list of all options for a specific investment.
1181
1246
  * @summary List options for this investment
@@ -1188,6 +1253,16 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
1188
1253
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>> {
1189
1254
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
1190
1255
  },
1256
+ /**
1257
+ * Get the preferred option for an investment.
1258
+ * @summary Get the preferred option for an investment
1259
+ * @param {string} investmentId UUID of the investment
1260
+ * @param {*} [options] Override http request option.
1261
+ * @throws {RequiredError}
1262
+ */
1263
+ getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
1264
+ return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
1265
+ },
1191
1266
  /**
1192
1267
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1193
1268
  * @summary Partially update an impact for this option
@@ -1238,12 +1313,12 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
1238
1313
  * Set the preferred option for an investment.
1239
1314
  * @summary Set the preferred option for an investment
1240
1315
  * @param {string} investmentId UUID of the investment
1241
- * @param {FavoredOptionRequest} favoredOptionRequest
1316
+ * @param {PreferredOptionRequest} preferredOptionRequest
1242
1317
  * @param {*} [options] Override http request option.
1243
1318
  * @throws {RequiredError}
1244
1319
  */
1245
- setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
1246
- return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
1320
+ setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
1321
+ return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
1247
1322
  },
1248
1323
  };
1249
1324
  };
@@ -1313,17 +1388,6 @@ export class InvestmentApi extends BaseAPI {
1313
1388
  return InvestmentApiFp(this.configuration).deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1314
1389
  }
1315
1390
 
1316
- /**
1317
- * Get the preferred option for an investment.
1318
- * @summary Get the preferred option for an investment
1319
- * @param {string} investmentId UUID of the investment
1320
- * @param {*} [options] Override http request option.
1321
- * @throws {RequiredError}
1322
- */
1323
- public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
1324
- return InvestmentApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1325
- }
1326
-
1327
1391
  /**
1328
1392
  * Retrieve a specific impact for the option.
1329
1393
  * @summary Get an impact for this option
@@ -1386,6 +1450,19 @@ export class InvestmentApi extends BaseAPI {
1386
1450
  return InvestmentApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1387
1451
  }
1388
1452
 
1453
+ /**
1454
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1455
+ * @summary Get the kpis for a given option inside a value framework
1456
+ * @param {string} investmentId UUID of the investment
1457
+ * @param {string} optionId UUID of the option
1458
+ * @param {string} valueFrameworkId UUID of the value framework
1459
+ * @param {*} [options] Override http request option.
1460
+ * @throws {RequiredError}
1461
+ */
1462
+ public getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1463
+ return InvestmentApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1464
+ }
1465
+
1389
1466
  /**
1390
1467
  * Retrieve a paginated list of all options for a specific investment.
1391
1468
  * @summary List options for this investment
@@ -1399,6 +1476,17 @@ export class InvestmentApi extends BaseAPI {
1399
1476
  return InvestmentApiFp(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1400
1477
  }
1401
1478
 
1479
+ /**
1480
+ * Get the preferred option for an investment.
1481
+ * @summary Get the preferred option for an investment
1482
+ * @param {string} investmentId UUID of the investment
1483
+ * @param {*} [options] Override http request option.
1484
+ * @throws {RequiredError}
1485
+ */
1486
+ public getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig) {
1487
+ return InvestmentApiFp(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1488
+ }
1489
+
1402
1490
  /**
1403
1491
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
1404
1492
  * @summary Partially update an impact for this option
@@ -1453,12 +1541,12 @@ export class InvestmentApi extends BaseAPI {
1453
1541
  * Set the preferred option for an investment.
1454
1542
  * @summary Set the preferred option for an investment
1455
1543
  * @param {string} investmentId UUID of the investment
1456
- * @param {FavoredOptionRequest} favoredOptionRequest
1544
+ * @param {PreferredOptionRequest} preferredOptionRequest
1457
1545
  * @param {*} [options] Override http request option.
1458
1546
  * @throws {RequiredError}
1459
1547
  */
1460
- public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
1461
- return InvestmentApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1548
+ public setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) {
1549
+ return InvestmentApiFp(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1462
1550
  }
1463
1551
  }
1464
1552
 
package/api/metric-api.ts CHANGED
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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-dev3
7
+ * The version of the OpenAPI document: 0.2.0-dev6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).