@cosmotech/aip-client 0.2.0-dev5 → 0.2.0-dev7

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 (289) hide show
  1. package/README.md +13 -8
  2. package/api/default-api.ts +1 -1
  3. package/api/impact-api.ts +1 -1
  4. package/api/investment-api.ts +259 -98
  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 -5
  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 +117 -47
  25. package/dist/api/investment-api.js +240 -91
  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 -5
  39. package/dist/api/option-api.js +83 -5
  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 +117 -47
  61. package/dist/esm/api/investment-api.js +240 -91
  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 -5
  75. package/dist/esm/api/option-api.js +83 -5
  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-overview-response.d.ts +29 -0
  109. package/dist/esm/models/{favored-option-request.js → investment-overview-response.js} +1 -1
  110. package/dist/esm/models/investment-response.d.ts +1 -1
  111. package/dist/esm/models/investment-response.js +1 -1
  112. package/dist/esm/models/investment-update.d.ts +1 -1
  113. package/dist/esm/models/investment-update.js +1 -1
  114. package/dist/esm/models/location-inner.d.ts +1 -1
  115. package/dist/esm/models/location-inner.js +1 -1
  116. package/dist/esm/models/measurement-type.d.ts +1 -1
  117. package/dist/esm/models/measurement-type.js +1 -1
  118. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
  119. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  120. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
  121. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  122. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
  123. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  124. package/dist/esm/models/metric-create.d.ts +1 -1
  125. package/dist/esm/models/metric-create.js +1 -1
  126. package/dist/esm/models/metric-response.d.ts +1 -1
  127. package/dist/esm/models/metric-response.js +1 -1
  128. package/dist/esm/models/metric-type.d.ts +1 -1
  129. package/dist/esm/models/metric-type.js +1 -1
  130. package/dist/esm/models/metric-update.d.ts +1 -1
  131. package/dist/esm/models/metric-update.js +1 -1
  132. package/dist/esm/models/objective-create.d.ts +1 -1
  133. package/dist/esm/models/objective-create.js +1 -1
  134. package/dist/esm/models/objective-response.d.ts +1 -1
  135. package/dist/esm/models/objective-response.js +1 -1
  136. package/dist/esm/models/objective-update.d.ts +1 -1
  137. package/dist/esm/models/objective-update.js +1 -1
  138. package/dist/esm/models/objective-weight-create.d.ts +1 -1
  139. package/dist/esm/models/objective-weight-create.js +1 -1
  140. package/dist/esm/models/objective-weight-response.d.ts +1 -1
  141. package/dist/esm/models/objective-weight-response.js +1 -1
  142. package/dist/esm/models/objective-weight-update.d.ts +1 -1
  143. package/dist/esm/models/objective-weight-update.js +1 -1
  144. package/dist/esm/models/option-chart-kpi.d.ts +1 -1
  145. package/dist/esm/models/option-chart-kpi.js +1 -1
  146. package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
  147. package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
  148. package/dist/esm/models/option-create.d.ts +1 -1
  149. package/dist/esm/models/option-create.js +1 -1
  150. package/dist/esm/models/option-overview-response.d.ts +37 -0
  151. package/dist/esm/models/{favored-option-response.js → option-overview-response.js} +1 -1
  152. package/dist/esm/models/option-response.d.ts +1 -1
  153. package/dist/esm/models/option-response.js +1 -1
  154. package/dist/esm/models/option-update.d.ts +1 -1
  155. package/dist/esm/models/option-update.js +1 -1
  156. package/dist/esm/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  157. package/dist/esm/models/preferred-option-request.js +14 -0
  158. package/dist/esm/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  159. package/dist/esm/models/preferred-option-response.js +14 -0
  160. package/dist/esm/models/validation-error.d.ts +1 -1
  161. package/dist/esm/models/validation-error.js +1 -1
  162. package/dist/esm/models/value-framework-create.d.ts +1 -1
  163. package/dist/esm/models/value-framework-create.js +1 -1
  164. package/dist/esm/models/value-framework-response.d.ts +1 -1
  165. package/dist/esm/models/value-framework-response.js +1 -1
  166. package/dist/esm/models/value-framework-update.d.ts +1 -1
  167. package/dist/esm/models/value-framework-update.js +1 -1
  168. package/dist/index.d.ts +1 -1
  169. package/dist/index.js +1 -1
  170. package/dist/models/evolution-type.d.ts +1 -1
  171. package/dist/models/evolution-type.js +1 -1
  172. package/dist/models/httpvalidation-error.d.ts +1 -1
  173. package/dist/models/httpvalidation-error.js +1 -1
  174. package/dist/models/impact-apiresponse.d.ts +1 -1
  175. package/dist/models/impact-apiresponse.js +1 -1
  176. package/dist/models/impact-create.d.ts +1 -1
  177. package/dist/models/impact-create.js +1 -1
  178. package/dist/models/impact-update.d.ts +1 -1
  179. package/dist/models/impact-update.js +1 -1
  180. package/dist/models/index.d.ts +4 -2
  181. package/dist/models/index.js +4 -2
  182. package/dist/models/investment-create.d.ts +1 -1
  183. package/dist/models/investment-create.js +1 -1
  184. package/dist/models/investment-overview-response.d.ts +29 -0
  185. package/dist/models/{favored-option-request.js → investment-overview-response.js} +1 -1
  186. package/dist/models/investment-response.d.ts +1 -1
  187. package/dist/models/investment-response.js +1 -1
  188. package/dist/models/investment-update.d.ts +1 -1
  189. package/dist/models/investment-update.js +1 -1
  190. package/dist/models/location-inner.d.ts +1 -1
  191. package/dist/models/location-inner.js +1 -1
  192. package/dist/models/measurement-type.d.ts +1 -1
  193. package/dist/models/measurement-type.js +1 -1
  194. package/dist/models/metric-costs-per-year-create.d.ts +1 -1
  195. package/dist/models/metric-costs-per-year-create.js +1 -1
  196. package/dist/models/metric-costs-per-year-response.d.ts +1 -1
  197. package/dist/models/metric-costs-per-year-response.js +1 -1
  198. package/dist/models/metric-costs-per-year-update.d.ts +1 -1
  199. package/dist/models/metric-costs-per-year-update.js +1 -1
  200. package/dist/models/metric-create.d.ts +1 -1
  201. package/dist/models/metric-create.js +1 -1
  202. package/dist/models/metric-response.d.ts +1 -1
  203. package/dist/models/metric-response.js +1 -1
  204. package/dist/models/metric-type.d.ts +1 -1
  205. package/dist/models/metric-type.js +1 -1
  206. package/dist/models/metric-update.d.ts +1 -1
  207. package/dist/models/metric-update.js +1 -1
  208. package/dist/models/objective-create.d.ts +1 -1
  209. package/dist/models/objective-create.js +1 -1
  210. package/dist/models/objective-response.d.ts +1 -1
  211. package/dist/models/objective-response.js +1 -1
  212. package/dist/models/objective-update.d.ts +1 -1
  213. package/dist/models/objective-update.js +1 -1
  214. package/dist/models/objective-weight-create.d.ts +1 -1
  215. package/dist/models/objective-weight-create.js +1 -1
  216. package/dist/models/objective-weight-response.d.ts +1 -1
  217. package/dist/models/objective-weight-response.js +1 -1
  218. package/dist/models/objective-weight-update.d.ts +1 -1
  219. package/dist/models/objective-weight-update.js +1 -1
  220. package/dist/models/option-chart-kpi.d.ts +1 -1
  221. package/dist/models/option-chart-kpi.js +1 -1
  222. package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
  223. package/dist/models/option-chart-kpis-yearly.js +1 -1
  224. package/dist/models/option-create.d.ts +1 -1
  225. package/dist/models/option-create.js +1 -1
  226. package/dist/models/option-overview-response.d.ts +37 -0
  227. package/dist/models/{favored-option-response.js → option-overview-response.js} +1 -1
  228. package/dist/models/option-response.d.ts +1 -1
  229. package/dist/models/option-response.js +1 -1
  230. package/dist/models/option-update.d.ts +1 -1
  231. package/dist/models/option-update.js +1 -1
  232. package/dist/models/{favored-option-request.d.ts → preferred-option-request.d.ts} +2 -2
  233. package/dist/models/preferred-option-request.js +15 -0
  234. package/dist/models/{favored-option-response.d.ts → preferred-option-response.d.ts} +3 -3
  235. package/dist/models/preferred-option-response.js +15 -0
  236. package/dist/models/validation-error.d.ts +1 -1
  237. package/dist/models/validation-error.js +1 -1
  238. package/dist/models/value-framework-create.d.ts +1 -1
  239. package/dist/models/value-framework-create.js +1 -1
  240. package/dist/models/value-framework-response.d.ts +1 -1
  241. package/dist/models/value-framework-response.js +1 -1
  242. package/dist/models/value-framework-update.d.ts +1 -1
  243. package/dist/models/value-framework-update.js +1 -1
  244. package/docs/InvestmentApi.md +174 -65
  245. package/docs/InvestmentOverviewResponse.md +33 -0
  246. package/docs/OptionApi.md +58 -2
  247. package/docs/OptionOverviewResponse.md +31 -0
  248. package/docs/{FavoredOptionApi.md → PreferredOptionApi.md} +19 -19
  249. package/docs/{FavoredOptionRequest.md → PreferredOptionRequest.md} +3 -3
  250. package/docs/{FavoredOptionResponse.md → PreferredOptionResponse.md} +4 -4
  251. package/index.ts +1 -1
  252. package/models/evolution-type.ts +1 -1
  253. package/models/httpvalidation-error.ts +1 -1
  254. package/models/impact-apiresponse.ts +1 -1
  255. package/models/impact-create.ts +1 -1
  256. package/models/impact-update.ts +1 -1
  257. package/models/index.ts +4 -2
  258. package/models/investment-create.ts +1 -1
  259. package/models/investment-overview-response.ts +35 -0
  260. package/models/investment-response.ts +1 -1
  261. package/models/investment-update.ts +1 -1
  262. package/models/location-inner.ts +1 -1
  263. package/models/measurement-type.ts +1 -1
  264. package/models/metric-costs-per-year-create.ts +1 -1
  265. package/models/metric-costs-per-year-response.ts +1 -1
  266. package/models/metric-costs-per-year-update.ts +1 -1
  267. package/models/metric-create.ts +1 -1
  268. package/models/metric-response.ts +1 -1
  269. package/models/metric-type.ts +1 -1
  270. package/models/metric-update.ts +1 -1
  271. package/models/objective-create.ts +1 -1
  272. package/models/objective-response.ts +1 -1
  273. package/models/objective-update.ts +1 -1
  274. package/models/objective-weight-create.ts +1 -1
  275. package/models/objective-weight-response.ts +1 -1
  276. package/models/objective-weight-update.ts +1 -1
  277. package/models/option-chart-kpi.ts +1 -1
  278. package/models/option-chart-kpis-yearly.ts +1 -1
  279. package/models/option-create.ts +1 -1
  280. package/models/option-overview-response.ts +43 -0
  281. package/models/option-response.ts +1 -1
  282. package/models/option-update.ts +1 -1
  283. package/models/{favored-option-request.ts → preferred-option-request.ts} +2 -2
  284. package/models/{favored-option-response.ts → preferred-option-response.ts} +3 -3
  285. package/models/validation-error.ts +1 -1
  286. package/models/value-framework-create.ts +1 -1
  287. package/models/value-framework-response.ts +1 -1
  288. package/models/value-framework-update.ts +1 -1
  289. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,6 +17,7 @@ import type { ImpactCreate } from '../models';
17
17
  import type { ImpactUpdate } from '../models';
18
18
  import type { OptionChartKPIsYearly } from '../models';
19
19
  import type { OptionCreate } from '../models';
20
+ import type { OptionOverviewResponse } from '../models';
20
21
  import type { OptionResponse } from '../models';
21
22
  import type { OptionUpdate } from '../models';
22
23
  /**
@@ -92,7 +93,7 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
92
93
  */
93
94
  getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
94
95
  /**
95
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
96
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
96
97
  * @summary Get the kpis for a given option inside a value framework
97
98
  * @param {string} investmentId UUID of the investment
98
99
  * @param {string} optionId UUID of the option
@@ -111,6 +112,15 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
111
112
  * @throws {RequiredError}
112
113
  */
113
114
  getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
115
+ /**
116
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
117
+ * @summary Option overview table for this investment
118
+ * @param {string} investmentId UUID of the investment
119
+ * @param {string} valueFrameworkId UUID of the value framework
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ */
123
+ getOptionsOverview: (investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
114
124
  /**
115
125
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
116
126
  * @summary Partially update an impact for this option
@@ -206,7 +216,7 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
206
216
  */
207
217
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
208
218
  /**
209
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
219
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
210
220
  * @summary Get the kpis for a given option inside a value framework
211
221
  * @param {string} investmentId UUID of the investment
212
222
  * @param {string} optionId UUID of the option
@@ -225,6 +235,15 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
225
235
  * @throws {RequiredError}
226
236
  */
227
237
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
238
+ /**
239
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
240
+ * @summary Option overview table for this investment
241
+ * @param {string} investmentId UUID of the investment
242
+ * @param {string} valueFrameworkId UUID of the value framework
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
228
247
  /**
229
248
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
230
249
  * @summary Partially update an impact for this option
@@ -320,7 +339,7 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
320
339
  */
321
340
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
322
341
  /**
323
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
342
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
324
343
  * @summary Get the kpis for a given option inside a value framework
325
344
  * @param {string} investmentId UUID of the investment
326
345
  * @param {string} optionId UUID of the option
@@ -339,6 +358,15 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
339
358
  * @throws {RequiredError}
340
359
  */
341
360
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
361
+ /**
362
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
363
+ * @summary Option overview table for this investment
364
+ * @param {string} investmentId UUID of the investment
365
+ * @param {string} valueFrameworkId UUID of the value framework
366
+ * @param {*} [options] Override http request option.
367
+ * @throws {RequiredError}
368
+ */
369
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>>;
342
370
  /**
343
371
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
344
372
  * @summary Partially update an impact for this option
@@ -434,7 +462,7 @@ export declare class OptionApi extends BaseAPI {
434
462
  */
435
463
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
436
464
  /**
437
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
465
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
438
466
  * @summary Get the kpis for a given option inside a value framework
439
467
  * @param {string} investmentId UUID of the investment
440
468
  * @param {string} optionId UUID of the option
@@ -453,6 +481,15 @@ export declare class OptionApi extends BaseAPI {
453
481
  * @throws {RequiredError}
454
482
  */
455
483
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
484
+ /**
485
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
486
+ * @summary Option overview table for this investment
487
+ * @param {string} investmentId UUID of the investment
488
+ * @param {string} valueFrameworkId UUID of the value framework
489
+ * @param {*} [options] Override http request option.
490
+ * @throws {RequiredError}
491
+ */
492
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
456
493
  /**
457
494
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
458
495
  * @summary Partially update an impact for this option
@@ -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).
@@ -311,7 +311,7 @@ export const OptionApiAxiosParamCreator = function (configuration) {
311
311
  };
312
312
  }),
313
313
  /**
314
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
314
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
315
315
  * @summary Get the kpis for a given option inside a value framework
316
316
  * @param {string} investmentId UUID of the investment
317
317
  * @param {string} optionId UUID of the option
@@ -392,6 +392,45 @@ export const OptionApiAxiosParamCreator = function (configuration) {
392
392
  options: localVarRequestOptions,
393
393
  };
394
394
  }),
395
+ /**
396
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
397
+ * @summary Option overview table for this investment
398
+ * @param {string} investmentId UUID of the investment
399
+ * @param {string} valueFrameworkId UUID of the value framework
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ */
403
+ getOptionsOverview: (investmentId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, valueFrameworkId, options = {}) {
404
+ // verify required parameter 'investmentId' is not null or undefined
405
+ assertParamExists('getOptionsOverview', 'investmentId', investmentId);
406
+ // verify required parameter 'valueFrameworkId' is not null or undefined
407
+ assertParamExists('getOptionsOverview', 'valueFrameworkId', valueFrameworkId);
408
+ const localVarPath = `/investment/{investment_id}/option/overview`
409
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
410
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
411
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
412
+ let baseOptions;
413
+ if (configuration) {
414
+ baseOptions = configuration.baseOptions;
415
+ }
416
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
417
+ const localVarHeaderParameter = {};
418
+ const localVarQueryParameter = {};
419
+ // authentication OAuth2AuthorizationCodeBearer required
420
+ // oauth required
421
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
422
+ if (valueFrameworkId !== undefined) {
423
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
424
+ }
425
+ localVarHeaderParameter['Accept'] = 'application/json';
426
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
427
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
428
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
429
+ return {
430
+ url: toPathString(localVarUrlObj),
431
+ options: localVarRequestOptions,
432
+ };
433
+ }),
395
434
  /**
396
435
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
397
436
  * @summary Partially update an impact for this option
@@ -613,7 +652,7 @@ export const OptionApiFp = function (configuration) {
613
652
  });
614
653
  },
615
654
  /**
616
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
655
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
617
656
  * @summary Get the kpis for a given option inside a value framework
618
657
  * @param {string} investmentId UUID of the investment
619
658
  * @param {string} optionId UUID of the option
@@ -648,6 +687,23 @@ export const OptionApiFp = function (configuration) {
648
687
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
649
688
  });
650
689
  },
690
+ /**
691
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
692
+ * @summary Option overview table for this investment
693
+ * @param {string} investmentId UUID of the investment
694
+ * @param {string} valueFrameworkId UUID of the value framework
695
+ * @param {*} [options] Override http request option.
696
+ * @throws {RequiredError}
697
+ */
698
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
699
+ return __awaiter(this, void 0, void 0, function* () {
700
+ var _a, _b, _c;
701
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
702
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
703
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OptionApi.getOptionsOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
704
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
705
+ });
706
+ },
651
707
  /**
652
708
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
653
709
  * @summary Partially update an impact for this option
@@ -776,7 +832,7 @@ export const OptionApiFactory = function (configuration, basePath, axios) {
776
832
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
777
833
  },
778
834
  /**
779
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
835
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
780
836
  * @summary Get the kpis for a given option inside a value framework
781
837
  * @param {string} investmentId UUID of the investment
782
838
  * @param {string} optionId UUID of the option
@@ -799,6 +855,17 @@ export const OptionApiFactory = function (configuration, basePath, axios) {
799
855
  getOptionsForInvestment(investmentId, offset, limit, options) {
800
856
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
801
857
  },
858
+ /**
859
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
860
+ * @summary Option overview table for this investment
861
+ * @param {string} investmentId UUID of the investment
862
+ * @param {string} valueFrameworkId UUID of the value framework
863
+ * @param {*} [options] Override http request option.
864
+ * @throws {RequiredError}
865
+ */
866
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
867
+ return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
868
+ },
802
869
  /**
803
870
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
804
871
  * @summary Partially update an impact for this option
@@ -913,7 +980,7 @@ export class OptionApi extends BaseAPI {
913
980
  return OptionApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
914
981
  }
915
982
  /**
916
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
983
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
917
984
  * @summary Get the kpis for a given option inside a value framework
918
985
  * @param {string} investmentId UUID of the investment
919
986
  * @param {string} optionId UUID of the option
@@ -936,6 +1003,17 @@ export class OptionApi extends BaseAPI {
936
1003
  getOptionsForInvestment(investmentId, offset, limit, options) {
937
1004
  return OptionApiFp(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
938
1005
  }
1006
+ /**
1007
+ * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
1008
+ * @summary Option overview table for this investment
1009
+ * @param {string} investmentId UUID of the investment
1010
+ * @param {string} valueFrameworkId UUID of the value framework
1011
+ * @param {*} [options] Override http request option.
1012
+ * @throws {RequiredError}
1013
+ */
1014
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
1015
+ return OptionApiFp(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1016
+ }
939
1017
  /**
940
1018
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
941
1019
  * @summary Partially update an impact for this option
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,12 +12,12 @@
12
12
  import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
- import type { FavoredOptionRequest } from '../models';
16
- import type { FavoredOptionResponse } from '../models';
15
+ import type { PreferredOptionRequest } from '../models';
16
+ import type { PreferredOptionResponse } from '../models';
17
17
  /**
18
- * FavoredOptionApi - axios parameter creator
18
+ * PreferredOptionApi - axios parameter creator
19
19
  */
20
- export declare const FavoredOptionApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ export declare const PreferredOptionApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
22
  * Get the preferred option for an investment.
23
23
  * @summary Get the preferred option for an investment
@@ -25,21 +25,21 @@ export declare const FavoredOptionApiAxiosParamCreator: (configuration?: Configu
25
25
  * @param {*} [options] Override http request option.
26
26
  * @throws {RequiredError}
27
27
  */
28
- getFavoredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
28
+ getPreferredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
29
29
  /**
30
30
  * Set the preferred option for an investment.
31
31
  * @summary Set the preferred option for an investment
32
32
  * @param {string} investmentId UUID of the investment
33
- * @param {FavoredOptionRequest} favoredOptionRequest
33
+ * @param {PreferredOptionRequest} preferredOptionRequest
34
34
  * @param {*} [options] Override http request option.
35
35
  * @throws {RequiredError}
36
36
  */
37
- setFavoredOption: (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
37
+ setPreferredOption: (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
38
  };
39
39
  /**
40
- * FavoredOptionApi - functional programming interface
40
+ * PreferredOptionApi - functional programming interface
41
41
  */
42
- export declare const FavoredOptionApiFp: (configuration?: Configuration) => {
42
+ export declare const PreferredOptionApiFp: (configuration?: Configuration) => {
43
43
  /**
44
44
  * Get the preferred option for an investment.
45
45
  * @summary Get the preferred option for an investment
@@ -47,21 +47,21 @@ export declare const FavoredOptionApiFp: (configuration?: Configuration) => {
47
47
  * @param {*} [options] Override http request option.
48
48
  * @throws {RequiredError}
49
49
  */
50
- getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
50
+ getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
51
51
  /**
52
52
  * Set the preferred option for an investment.
53
53
  * @summary Set the preferred option for an investment
54
54
  * @param {string} investmentId UUID of the investment
55
- * @param {FavoredOptionRequest} favoredOptionRequest
55
+ * @param {PreferredOptionRequest} preferredOptionRequest
56
56
  * @param {*} [options] Override http request option.
57
57
  * @throws {RequiredError}
58
58
  */
59
- setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
59
+ setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
60
60
  };
61
61
  /**
62
- * FavoredOptionApi - factory interface
62
+ * PreferredOptionApi - factory interface
63
63
  */
64
- export declare const FavoredOptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
64
+ export declare const PreferredOptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
65
65
  /**
66
66
  * Get the preferred option for an investment.
67
67
  * @summary Get the preferred option for an investment
@@ -69,21 +69,21 @@ export declare const FavoredOptionApiFactory: (configuration?: Configuration, ba
69
69
  * @param {*} [options] Override http request option.
70
70
  * @throws {RequiredError}
71
71
  */
72
- getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
72
+ getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
73
73
  /**
74
74
  * Set the preferred option for an investment.
75
75
  * @summary Set the preferred option for an investment
76
76
  * @param {string} investmentId UUID of the investment
77
- * @param {FavoredOptionRequest} favoredOptionRequest
77
+ * @param {PreferredOptionRequest} preferredOptionRequest
78
78
  * @param {*} [options] Override http request option.
79
79
  * @throws {RequiredError}
80
80
  */
81
- setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
81
+ setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
82
82
  };
83
83
  /**
84
- * FavoredOptionApi - object-oriented interface
84
+ * PreferredOptionApi - object-oriented interface
85
85
  */
86
- export declare class FavoredOptionApi extends BaseAPI {
86
+ export declare class PreferredOptionApi extends BaseAPI {
87
87
  /**
88
88
  * Get the preferred option for an investment.
89
89
  * @summary Get the preferred option for an investment
@@ -91,14 +91,14 @@ export declare class FavoredOptionApi extends BaseAPI {
91
91
  * @param {*} [options] Override http request option.
92
92
  * @throws {RequiredError}
93
93
  */
94
- getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
94
+ getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
95
95
  /**
96
96
  * Set the preferred option for an investment.
97
97
  * @summary Set the preferred option for an investment
98
98
  * @param {string} investmentId UUID of the investment
99
- * @param {FavoredOptionRequest} favoredOptionRequest
99
+ * @param {PreferredOptionRequest} preferredOptionRequest
100
100
  * @param {*} [options] Override http request option.
101
101
  * @throws {RequiredError}
102
102
  */
103
- setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
103
+ setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
104
104
  }
@@ -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).
@@ -27,9 +27,9 @@ import { DUMMY_BASE_URL, assertParamExists, setOAuthToObject, setSearchParams, s
27
27
  // @ts-ignore
28
28
  import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
29
29
  /**
30
- * FavoredOptionApi - axios parameter creator
30
+ * PreferredOptionApi - axios parameter creator
31
31
  */
32
- export const FavoredOptionApiAxiosParamCreator = function (configuration) {
32
+ export const PreferredOptionApiAxiosParamCreator = function (configuration) {
33
33
  return {
34
34
  /**
35
35
  * Get the preferred option for an investment.
@@ -38,10 +38,10 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration) {
38
38
  * @param {*} [options] Override http request option.
39
39
  * @throws {RequiredError}
40
40
  */
41
- getFavoredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
41
+ getPreferredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
42
42
  // verify required parameter 'investmentId' is not null or undefined
43
- assertParamExists('getFavoredOption', 'investmentId', investmentId);
44
- const localVarPath = `/investment/{investment_id}/favored_option`
43
+ assertParamExists('getPreferredOption', 'investmentId', investmentId);
44
+ const localVarPath = `/investment/{investment_id}/preferred_option`
45
45
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
46
46
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
47
47
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -68,16 +68,16 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration) {
68
68
  * Set the preferred option for an investment.
69
69
  * @summary Set the preferred option for an investment
70
70
  * @param {string} investmentId UUID of the investment
71
- * @param {FavoredOptionRequest} favoredOptionRequest
71
+ * @param {PreferredOptionRequest} preferredOptionRequest
72
72
  * @param {*} [options] Override http request option.
73
73
  * @throws {RequiredError}
74
74
  */
75
- setFavoredOption: (investmentId_1, favoredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, favoredOptionRequest_1, ...args_1], void 0, function* (investmentId, favoredOptionRequest, options = {}) {
75
+ setPreferredOption: (investmentId_1, preferredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, preferredOptionRequest_1, ...args_1], void 0, function* (investmentId, preferredOptionRequest, options = {}) {
76
76
  // verify required parameter 'investmentId' is not null or undefined
77
- assertParamExists('setFavoredOption', 'investmentId', investmentId);
78
- // verify required parameter 'favoredOptionRequest' is not null or undefined
79
- assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest);
80
- const localVarPath = `/investment/{investment_id}/favored_option`
77
+ assertParamExists('setPreferredOption', 'investmentId', investmentId);
78
+ // verify required parameter 'preferredOptionRequest' is not null or undefined
79
+ assertParamExists('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest);
80
+ const localVarPath = `/investment/{investment_id}/preferred_option`
81
81
  .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
82
82
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
83
83
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -96,7 +96,7 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration) {
96
96
  setSearchParams(localVarUrlObj, localVarQueryParameter);
97
97
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
98
98
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
99
- localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration);
99
+ localVarRequestOptions.data = serializeDataIfNeeded(preferredOptionRequest, localVarRequestOptions, configuration);
100
100
  return {
101
101
  url: toPathString(localVarUrlObj),
102
102
  options: localVarRequestOptions,
@@ -105,10 +105,10 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration) {
105
105
  };
106
106
  };
107
107
  /**
108
- * FavoredOptionApi - functional programming interface
108
+ * PreferredOptionApi - functional programming interface
109
109
  */
110
- export const FavoredOptionApiFp = function (configuration) {
111
- const localVarAxiosParamCreator = FavoredOptionApiAxiosParamCreator(configuration);
110
+ export const PreferredOptionApiFp = function (configuration) {
111
+ const localVarAxiosParamCreator = PreferredOptionApiAxiosParamCreator(configuration);
112
112
  return {
113
113
  /**
114
114
  * Get the preferred option for an investment.
@@ -117,12 +117,12 @@ export const FavoredOptionApiFp = function (configuration) {
117
117
  * @param {*} [options] Override http request option.
118
118
  * @throws {RequiredError}
119
119
  */
120
- getFavoredOption(investmentId, options) {
120
+ getPreferredOption(investmentId, options) {
121
121
  return __awaiter(this, void 0, void 0, function* () {
122
122
  var _a, _b, _c;
123
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getFavoredOption(investmentId, options);
123
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPreferredOption(investmentId, options);
124
124
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
125
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FavoredOptionApi.getFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
125
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PreferredOptionApi.getPreferredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
126
126
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
127
127
  });
128
128
  },
@@ -130,26 +130,26 @@ export const FavoredOptionApiFp = function (configuration) {
130
130
  * Set the preferred option for an investment.
131
131
  * @summary Set the preferred option for an investment
132
132
  * @param {string} investmentId UUID of the investment
133
- * @param {FavoredOptionRequest} favoredOptionRequest
133
+ * @param {PreferredOptionRequest} preferredOptionRequest
134
134
  * @param {*} [options] Override http request option.
135
135
  * @throws {RequiredError}
136
136
  */
137
- setFavoredOption(investmentId, favoredOptionRequest, options) {
137
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
138
138
  return __awaiter(this, void 0, void 0, function* () {
139
139
  var _a, _b, _c;
140
- const localVarAxiosArgs = yield localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
140
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
141
141
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
142
- const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FavoredOptionApi.setFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
142
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PreferredOptionApi.setPreferredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
143
143
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
144
144
  });
145
145
  },
146
146
  };
147
147
  };
148
148
  /**
149
- * FavoredOptionApi - factory interface
149
+ * PreferredOptionApi - factory interface
150
150
  */
151
- export const FavoredOptionApiFactory = function (configuration, basePath, axios) {
152
- const localVarFp = FavoredOptionApiFp(configuration);
151
+ export const PreferredOptionApiFactory = function (configuration, basePath, axios) {
152
+ const localVarFp = PreferredOptionApiFp(configuration);
153
153
  return {
154
154
  /**
155
155
  * Get the preferred option for an investment.
@@ -158,26 +158,26 @@ export const FavoredOptionApiFactory = function (configuration, basePath, axios)
158
158
  * @param {*} [options] Override http request option.
159
159
  * @throws {RequiredError}
160
160
  */
161
- getFavoredOption(investmentId, options) {
162
- return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
161
+ getPreferredOption(investmentId, options) {
162
+ return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
163
163
  },
164
164
  /**
165
165
  * Set the preferred option for an investment.
166
166
  * @summary Set the preferred option for an investment
167
167
  * @param {string} investmentId UUID of the investment
168
- * @param {FavoredOptionRequest} favoredOptionRequest
168
+ * @param {PreferredOptionRequest} preferredOptionRequest
169
169
  * @param {*} [options] Override http request option.
170
170
  * @throws {RequiredError}
171
171
  */
172
- setFavoredOption(investmentId, favoredOptionRequest, options) {
173
- return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
172
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
173
+ return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
174
174
  },
175
175
  };
176
176
  };
177
177
  /**
178
- * FavoredOptionApi - object-oriented interface
178
+ * PreferredOptionApi - object-oriented interface
179
179
  */
180
- export class FavoredOptionApi extends BaseAPI {
180
+ export class PreferredOptionApi extends BaseAPI {
181
181
  /**
182
182
  * Get the preferred option for an investment.
183
183
  * @summary Get the preferred option for an investment
@@ -185,18 +185,18 @@ export class FavoredOptionApi extends BaseAPI {
185
185
  * @param {*} [options] Override http request option.
186
186
  * @throws {RequiredError}
187
187
  */
188
- getFavoredOption(investmentId, options) {
189
- return FavoredOptionApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
188
+ getPreferredOption(investmentId, options) {
189
+ return PreferredOptionApiFp(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
190
190
  }
191
191
  /**
192
192
  * Set the preferred option for an investment.
193
193
  * @summary Set the preferred option for an investment
194
194
  * @param {string} investmentId UUID of the investment
195
- * @param {FavoredOptionRequest} favoredOptionRequest
195
+ * @param {PreferredOptionRequest} preferredOptionRequest
196
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
199
- setFavoredOption(investmentId, favoredOptionRequest, options) {
200
- return FavoredOptionApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
199
+ setPreferredOption(investmentId, preferredOptionRequest, options) {
200
+ return PreferredOptionApiFp(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
201
201
  }
202
202
  }
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * 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).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * 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).
@@ -2,7 +2,7 @@
2
2
  * Asset Investment Planning
3
3
  * API for Asset Investment Planning
4
4
  *
5
- * The version of the OpenAPI document: 0.2.0-dev3
5
+ * The version of the OpenAPI document: 0.2.0-dev6
6
6
  *
7
7
  *
8
8
  * 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).