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

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 (70) hide show
  1. package/README.md +12 -2
  2. package/api/favored-option-api.ts +210 -0
  3. package/api/investment-api.ts +244 -0
  4. package/api/option-api.ts +88 -0
  5. package/api.ts +1 -0
  6. package/dist/api/favored-option-api.d.ts +104 -0
  7. package/dist/api/favored-option-api.js +209 -0
  8. package/dist/api/investment-api.d.ts +111 -0
  9. package/dist/api/investment-api.js +229 -0
  10. package/dist/api/option-api.d.ts +41 -0
  11. package/dist/api/option-api.js +83 -0
  12. package/dist/api.d.ts +1 -0
  13. package/dist/api.js +1 -0
  14. package/dist/esm/api/favored-option-api.d.ts +104 -0
  15. package/dist/esm/api/favored-option-api.js +202 -0
  16. package/dist/esm/api/investment-api.d.ts +111 -0
  17. package/dist/esm/api/investment-api.js +229 -0
  18. package/dist/esm/api/option-api.d.ts +41 -0
  19. package/dist/esm/api/option-api.js +83 -0
  20. package/dist/esm/api.d.ts +1 -0
  21. package/dist/esm/api.js +1 -0
  22. package/dist/esm/models/favored-option-request.d.ts +20 -0
  23. package/dist/esm/models/favored-option-request.js +14 -0
  24. package/dist/esm/models/favored-option-response.d.ts +20 -0
  25. package/dist/esm/models/favored-option-response.js +14 -0
  26. package/dist/esm/models/index.d.ts +4 -0
  27. package/dist/esm/models/index.js +4 -0
  28. package/dist/esm/models/investment-response.d.ts +1 -0
  29. package/dist/esm/models/option-chart-kpi.d.ts +29 -0
  30. package/dist/esm/models/option-chart-kpi.js +14 -0
  31. package/dist/esm/models/option-chart-kpis-yearly.d.ts +29 -0
  32. package/dist/esm/models/option-chart-kpis-yearly.js +14 -0
  33. package/dist/esm/models/option-create.d.ts +1 -1
  34. package/dist/esm/models/option-response.d.ts +2 -1
  35. package/dist/esm/models/option-update.d.ts +2 -0
  36. package/dist/models/favored-option-request.d.ts +20 -0
  37. package/dist/models/favored-option-request.js +15 -0
  38. package/dist/models/favored-option-response.d.ts +20 -0
  39. package/dist/models/favored-option-response.js +15 -0
  40. package/dist/models/index.d.ts +4 -0
  41. package/dist/models/index.js +4 -0
  42. package/dist/models/investment-response.d.ts +1 -0
  43. package/dist/models/option-chart-kpi.d.ts +29 -0
  44. package/dist/models/option-chart-kpi.js +15 -0
  45. package/dist/models/option-chart-kpis-yearly.d.ts +29 -0
  46. package/dist/models/option-chart-kpis-yearly.js +15 -0
  47. package/dist/models/option-create.d.ts +1 -1
  48. package/dist/models/option-response.d.ts +2 -1
  49. package/dist/models/option-update.d.ts +2 -0
  50. package/docs/FavoredOptionApi.md +119 -0
  51. package/docs/FavoredOptionRequest.md +21 -0
  52. package/docs/FavoredOptionResponse.md +21 -0
  53. package/docs/InvestmentApi.md +171 -0
  54. package/docs/InvestmentResponse.md +2 -0
  55. package/docs/OptionApi.md +59 -0
  56. package/docs/OptionChartKPI.md +27 -0
  57. package/docs/OptionChartKPIsYearly.md +25 -0
  58. package/docs/OptionCreate.md +1 -1
  59. package/docs/OptionResponse.md +4 -2
  60. package/docs/OptionUpdate.md +4 -0
  61. package/models/favored-option-request.ts +26 -0
  62. package/models/favored-option-response.ts +26 -0
  63. package/models/index.ts +4 -0
  64. package/models/investment-response.ts +1 -0
  65. package/models/option-chart-kpi.ts +35 -0
  66. package/models/option-chart-kpis-yearly.ts +37 -0
  67. package/models/option-create.ts +1 -1
  68. package/models/option-response.ts +2 -1
  69. package/models/option-update.ts +2 -0
  70. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @cosmotech/aip-client@0.2.0-dev3
1
+ ## @cosmotech/aip-client@v0.2.0-dev5
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-dev3 --save
39
+ npm install @cosmotech/aip-client@v0.2.0-dev5 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -52,6 +52,8 @@ 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
55
57
  *ImpactApi* | [**createImpactForOption**](docs/ImpactApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
56
58
  *ImpactApi* | [**deleteImpactForOption**](docs/ImpactApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
57
59
  *ImpactApi* | [**getImpactForOption**](docs/ImpactApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
@@ -62,16 +64,19 @@ Class | Method | HTTP request | Description
62
64
  *InvestmentApi* | [**deleteImpactForOption**](docs/InvestmentApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
63
65
  *InvestmentApi* | [**deleteInvestment**](docs/InvestmentApi.md#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment
64
66
  *InvestmentApi* | [**deleteOptionForInvestment**](docs/InvestmentApi.md#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
67
+ *InvestmentApi* | [**getFavoredOption**](docs/InvestmentApi.md#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment
65
68
  *InvestmentApi* | [**getImpactForOption**](docs/InvestmentApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
66
69
  *InvestmentApi* | [**getImpactsForOption**](docs/InvestmentApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
67
70
  *InvestmentApi* | [**getInvestmentById**](docs/InvestmentApi.md#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID
68
71
  *InvestmentApi* | [**getInvestments**](docs/InvestmentApi.md#getinvestments) | **GET** /investment/ | List investments
69
72
  *InvestmentApi* | [**getOptionForInvestment**](docs/InvestmentApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
73
+ *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
70
74
  *InvestmentApi* | [**getOptionsForInvestment**](docs/InvestmentApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
71
75
  *InvestmentApi* | [**patchImpactForOption**](docs/InvestmentApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
72
76
  *InvestmentApi* | [**patchInvestment**](docs/InvestmentApi.md#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment
73
77
  *InvestmentApi* | [**patchOptionForInvestment**](docs/InvestmentApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
74
78
  *InvestmentApi* | [**postInvestment**](docs/InvestmentApi.md#postinvestment) | **POST** /investment/ | Create an investment
79
+ *InvestmentApi* | [**setFavoredOption**](docs/InvestmentApi.md#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment
75
80
  *MetricApi* | [**createMetricForObjective**](docs/MetricApi.md#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
76
81
  *MetricApi* | [**deleteMetricForObjective**](docs/MetricApi.md#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
77
82
  *MetricApi* | [**getMetricForObjective**](docs/MetricApi.md#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
@@ -107,6 +112,7 @@ Class | Method | HTTP request | Description
107
112
  *OptionApi* | [**getImpactForOption**](docs/OptionApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
108
113
  *OptionApi* | [**getImpactsForOption**](docs/OptionApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
109
114
  *OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
115
+ *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
110
116
  *OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
111
117
  *OptionApi* | [**patchImpactForOption**](docs/OptionApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
112
118
  *OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
@@ -136,6 +142,8 @@ Class | Method | HTTP request | Description
136
142
  ### Documentation For Models
137
143
 
138
144
  - [EvolutionType](docs/EvolutionType.md)
145
+ - [FavoredOptionRequest](docs/FavoredOptionRequest.md)
146
+ - [FavoredOptionResponse](docs/FavoredOptionResponse.md)
139
147
  - [HTTPValidationError](docs/HTTPValidationError.md)
140
148
  - [ImpactAPIResponse](docs/ImpactAPIResponse.md)
141
149
  - [ImpactCreate](docs/ImpactCreate.md)
@@ -158,6 +166,8 @@ Class | Method | HTTP request | Description
158
166
  - [ObjectiveWeightCreate](docs/ObjectiveWeightCreate.md)
159
167
  - [ObjectiveWeightResponse](docs/ObjectiveWeightResponse.md)
160
168
  - [ObjectiveWeightUpdate](docs/ObjectiveWeightUpdate.md)
169
+ - [OptionChartKPI](docs/OptionChartKPI.md)
170
+ - [OptionChartKPIsYearly](docs/OptionChartKPIsYearly.md)
161
171
  - [OptionCreate](docs/OptionCreate.md)
162
172
  - [OptionResponse](docs/OptionResponse.md)
163
173
  - [OptionUpdate](docs/OptionUpdate.md)
@@ -0,0 +1,210 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Asset Investment Planning
5
+ * API for Asset Investment Planning
6
+ *
7
+ * The version of the OpenAPI document: 0.2.0-dev3
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { FavoredOptionRequest } from '../models';
26
+ // @ts-ignore
27
+ import type { FavoredOptionResponse } from '../models';
28
+ /**
29
+ * FavoredOptionApi - axios parameter creator
30
+ */
31
+ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * Get the preferred option for an investment.
35
+ * @summary Get the preferred option for an investment
36
+ * @param {string} investmentId UUID of the investment
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
41
+ // verify required parameter 'investmentId' is not null or undefined
42
+ assertParamExists('getFavoredOption', 'investmentId', investmentId)
43
+ const localVarPath = `/investment/{investment_id}/favored_option`
44
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+
52
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
53
+ const localVarHeaderParameter = {} as any;
54
+ const localVarQueryParameter = {} as any;
55
+
56
+ // authentication OAuth2AuthorizationCodeBearer required
57
+ // oauth required
58
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
59
+
60
+ localVarHeaderParameter['Accept'] = 'application/json';
61
+
62
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
63
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
64
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
65
+
66
+ return {
67
+ url: toPathString(localVarUrlObj),
68
+ options: localVarRequestOptions,
69
+ };
70
+ },
71
+ /**
72
+ * Set the preferred option for an investment.
73
+ * @summary Set the preferred option for an investment
74
+ * @param {string} investmentId UUID of the investment
75
+ * @param {FavoredOptionRequest} favoredOptionRequest
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ setFavoredOption: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
80
+ // verify required parameter 'investmentId' is not null or undefined
81
+ assertParamExists('setFavoredOption', 'investmentId', investmentId)
82
+ // verify required parameter 'favoredOptionRequest' is not null or undefined
83
+ assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest)
84
+ const localVarPath = `/investment/{investment_id}/favored_option`
85
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
86
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
87
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
88
+ let baseOptions;
89
+ if (configuration) {
90
+ baseOptions = configuration.baseOptions;
91
+ }
92
+
93
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
94
+ const localVarHeaderParameter = {} as any;
95
+ const localVarQueryParameter = {} as any;
96
+
97
+ // authentication OAuth2AuthorizationCodeBearer required
98
+ // oauth required
99
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
100
+
101
+ localVarHeaderParameter['Content-Type'] = 'application/json';
102
+ localVarHeaderParameter['Accept'] = 'application/json';
103
+
104
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
105
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
107
+ localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
108
+
109
+ return {
110
+ url: toPathString(localVarUrlObj),
111
+ options: localVarRequestOptions,
112
+ };
113
+ },
114
+ }
115
+ };
116
+
117
+ /**
118
+ * FavoredOptionApi - functional programming interface
119
+ */
120
+ export const FavoredOptionApiFp = function(configuration?: Configuration) {
121
+ const localVarAxiosParamCreator = FavoredOptionApiAxiosParamCreator(configuration)
122
+ return {
123
+ /**
124
+ * Get the preferred option for an investment.
125
+ * @summary Get the preferred option for an investment
126
+ * @param {string} investmentId UUID of the investment
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
131
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
132
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
133
+ const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.getFavoredOption']?.[localVarOperationServerIndex]?.url;
134
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
135
+ },
136
+ /**
137
+ * Set the preferred option for an investment.
138
+ * @summary Set the preferred option for an investment
139
+ * @param {string} investmentId UUID of the investment
140
+ * @param {FavoredOptionRequest} favoredOptionRequest
141
+ * @param {*} [options] Override http request option.
142
+ * @throws {RequiredError}
143
+ */
144
+ async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
145
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
146
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
147
+ const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
148
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
149
+ },
150
+ }
151
+ };
152
+
153
+ /**
154
+ * FavoredOptionApi - factory interface
155
+ */
156
+ export const FavoredOptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
157
+ const localVarFp = FavoredOptionApiFp(configuration)
158
+ return {
159
+ /**
160
+ * Get the preferred option for an investment.
161
+ * @summary Get the preferred option for an investment
162
+ * @param {string} investmentId UUID of the investment
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
167
+ return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
168
+ },
169
+ /**
170
+ * Set the preferred option for an investment.
171
+ * @summary Set the preferred option for an investment
172
+ * @param {string} investmentId UUID of the investment
173
+ * @param {FavoredOptionRequest} favoredOptionRequest
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
178
+ return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
179
+ },
180
+ };
181
+ };
182
+
183
+ /**
184
+ * FavoredOptionApi - object-oriented interface
185
+ */
186
+ export class FavoredOptionApi extends BaseAPI {
187
+ /**
188
+ * Get the preferred option for an investment.
189
+ * @summary Get the preferred option for an investment
190
+ * @param {string} investmentId UUID of the investment
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
195
+ return FavoredOptionApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
196
+ }
197
+
198
+ /**
199
+ * Set the preferred option for an investment.
200
+ * @summary Set the preferred option for an investment
201
+ * @param {string} investmentId UUID of the investment
202
+ * @param {FavoredOptionRequest} favoredOptionRequest
203
+ * @param {*} [options] Override http request option.
204
+ * @throws {RequiredError}
205
+ */
206
+ public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
207
+ return FavoredOptionApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
208
+ }
209
+ }
210
+
@@ -22,6 +22,10 @@ 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
25
29
  import type { ImpactAPIResponse } from '../models';
26
30
  // @ts-ignore
27
31
  import type { ImpactCreate } from '../models';
@@ -34,6 +38,8 @@ import type { InvestmentResponse } from '../models';
34
38
  // @ts-ignore
35
39
  import type { InvestmentUpdate } from '../models';
36
40
  // @ts-ignore
41
+ import type { OptionChartKPIsYearly } from '../models';
42
+ // @ts-ignore
37
43
  import type { OptionCreate } from '../models';
38
44
  // @ts-ignore
39
45
  import type { OptionResponse } from '../models';
@@ -248,6 +254,44 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
248
254
  await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
249
255
 
250
256
 
257
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
258
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
259
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
260
+
261
+ return {
262
+ url: toPathString(localVarUrlObj),
263
+ options: localVarRequestOptions,
264
+ };
265
+ },
266
+ /**
267
+ * Get the preferred option for an investment.
268
+ * @summary Get the preferred option for an investment
269
+ * @param {string} investmentId UUID of the investment
270
+ * @param {*} [options] Override http request option.
271
+ * @throws {RequiredError}
272
+ */
273
+ getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
274
+ // verify required parameter 'investmentId' is not null or undefined
275
+ assertParamExists('getFavoredOption', 'investmentId', investmentId)
276
+ const localVarPath = `/investment/{investment_id}/favored_option`
277
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
278
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
279
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
280
+ let baseOptions;
281
+ if (configuration) {
282
+ baseOptions = configuration.baseOptions;
283
+ }
284
+
285
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
286
+ const localVarHeaderParameter = {} as any;
287
+ const localVarQueryParameter = {} as any;
288
+
289
+ // authentication OAuth2AuthorizationCodeBearer required
290
+ // oauth required
291
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
292
+
293
+ localVarHeaderParameter['Accept'] = 'application/json';
294
+
251
295
  setSearchParams(localVarUrlObj, localVarQueryParameter);
252
296
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
253
297
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -479,6 +523,52 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
479
523
  options: localVarRequestOptions,
480
524
  };
481
525
  },
526
+ /**
527
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
528
+ * @summary Get the kpis for a given option inside a value framework
529
+ * @param {string} investmentId UUID of the investment
530
+ * @param {string} optionId UUID of the option
531
+ * @param {string} valueFrameworkId UUID of the value framework
532
+ * @param {*} [options] Override http request option.
533
+ * @throws {RequiredError}
534
+ */
535
+ getOptionKpis: async (investmentId: string, optionId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
536
+ // verify required parameter 'investmentId' is not null or undefined
537
+ assertParamExists('getOptionKpis', 'investmentId', investmentId)
538
+ // verify required parameter 'optionId' is not null or undefined
539
+ assertParamExists('getOptionKpis', 'optionId', optionId)
540
+ // verify required parameter 'valueFrameworkId' is not null or undefined
541
+ assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId)
542
+ const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
543
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
544
+ .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
545
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
546
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
547
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
548
+ let baseOptions;
549
+ if (configuration) {
550
+ baseOptions = configuration.baseOptions;
551
+ }
552
+
553
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
554
+ const localVarHeaderParameter = {} as any;
555
+ const localVarQueryParameter = {} as any;
556
+
557
+ // authentication OAuth2AuthorizationCodeBearer required
558
+ // oauth required
559
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
560
+
561
+ localVarHeaderParameter['Accept'] = 'application/json';
562
+
563
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
564
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
565
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
566
+
567
+ return {
568
+ url: toPathString(localVarUrlObj),
569
+ options: localVarRequestOptions,
570
+ };
571
+ },
482
572
  /**
483
573
  * Retrieve a paginated list of all options for a specific investment.
484
574
  * @summary List options for this investment
@@ -702,6 +792,49 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
702
792
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
703
793
  localVarRequestOptions.data = serializeDataIfNeeded(investmentCreate, localVarRequestOptions, configuration)
704
794
 
795
+ return {
796
+ url: toPathString(localVarUrlObj),
797
+ options: localVarRequestOptions,
798
+ };
799
+ },
800
+ /**
801
+ * Set the preferred option for an investment.
802
+ * @summary Set the preferred option for an investment
803
+ * @param {string} investmentId UUID of the investment
804
+ * @param {FavoredOptionRequest} favoredOptionRequest
805
+ * @param {*} [options] Override http request option.
806
+ * @throws {RequiredError}
807
+ */
808
+ setFavoredOption: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
809
+ // verify required parameter 'investmentId' is not null or undefined
810
+ assertParamExists('setFavoredOption', 'investmentId', investmentId)
811
+ // verify required parameter 'favoredOptionRequest' is not null or undefined
812
+ assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest)
813
+ const localVarPath = `/investment/{investment_id}/favored_option`
814
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
815
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
816
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
817
+ let baseOptions;
818
+ if (configuration) {
819
+ baseOptions = configuration.baseOptions;
820
+ }
821
+
822
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
823
+ const localVarHeaderParameter = {} as any;
824
+ const localVarQueryParameter = {} as any;
825
+
826
+ // authentication OAuth2AuthorizationCodeBearer required
827
+ // oauth required
828
+ await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
829
+
830
+ localVarHeaderParameter['Content-Type'] = 'application/json';
831
+ localVarHeaderParameter['Accept'] = 'application/json';
832
+
833
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
834
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
835
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
836
+ localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
837
+
705
838
  return {
706
839
  url: toPathString(localVarUrlObj),
707
840
  options: localVarRequestOptions,
@@ -787,6 +920,19 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
787
920
  const localVarOperationServerBasePath = operationServerMap['InvestmentApi.deleteOptionForInvestment']?.[localVarOperationServerIndex]?.url;
788
921
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
789
922
  },
923
+ /**
924
+ * Get the preferred option for an investment.
925
+ * @summary Get the preferred option for an investment
926
+ * @param {string} investmentId UUID of the investment
927
+ * @param {*} [options] Override http request option.
928
+ * @throws {RequiredError}
929
+ */
930
+ async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
931
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
932
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
933
+ const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getFavoredOption']?.[localVarOperationServerIndex]?.url;
934
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
935
+ },
790
936
  /**
791
937
  * Retrieve a specific impact for the option.
792
938
  * @summary Get an impact for this option
@@ -859,6 +1005,21 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
859
1005
  const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionForInvestment']?.[localVarOperationServerIndex]?.url;
860
1006
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
861
1007
  },
1008
+ /**
1009
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1010
+ * @summary Get the kpis for a given option inside a value framework
1011
+ * @param {string} investmentId UUID of the investment
1012
+ * @param {string} optionId UUID of the option
1013
+ * @param {string} valueFrameworkId UUID of the value framework
1014
+ * @param {*} [options] Override http request option.
1015
+ * @throws {RequiredError}
1016
+ */
1017
+ async getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
1018
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
1019
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1020
+ const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
1021
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1022
+ },
862
1023
  /**
863
1024
  * Retrieve a paginated list of all options for a specific investment.
864
1025
  * @summary List options for this investment
@@ -932,6 +1093,20 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
932
1093
  const localVarOperationServerBasePath = operationServerMap['InvestmentApi.postInvestment']?.[localVarOperationServerIndex]?.url;
933
1094
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
934
1095
  },
1096
+ /**
1097
+ * Set the preferred option for an investment.
1098
+ * @summary Set the preferred option for an investment
1099
+ * @param {string} investmentId UUID of the investment
1100
+ * @param {FavoredOptionRequest} favoredOptionRequest
1101
+ * @param {*} [options] Override http request option.
1102
+ * @throws {RequiredError}
1103
+ */
1104
+ async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
1105
+ const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
1106
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1107
+ const localVarOperationServerBasePath = operationServerMap['InvestmentApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
1108
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1109
+ },
935
1110
  }
936
1111
  };
937
1112
 
@@ -997,6 +1172,16 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
997
1172
  deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
998
1173
  return localVarFp.deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
999
1174
  },
1175
+ /**
1176
+ * Get the preferred option for an investment.
1177
+ * @summary Get the preferred option for an investment
1178
+ * @param {string} investmentId UUID of the investment
1179
+ * @param {*} [options] Override http request option.
1180
+ * @throws {RequiredError}
1181
+ */
1182
+ getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
1183
+ return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
1184
+ },
1000
1185
  /**
1001
1186
  * Retrieve a specific impact for the option.
1002
1187
  * @summary Get an impact for this option
@@ -1054,6 +1239,18 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
1054
1239
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse> {
1055
1240
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1056
1241
  },
1242
+ /**
1243
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1244
+ * @summary Get the kpis for a given option inside a value framework
1245
+ * @param {string} investmentId UUID of the investment
1246
+ * @param {string} optionId UUID of the option
1247
+ * @param {string} valueFrameworkId UUID of the value framework
1248
+ * @param {*} [options] Override http request option.
1249
+ * @throws {RequiredError}
1250
+ */
1251
+ getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
1252
+ return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
1253
+ },
1057
1254
  /**
1058
1255
  * Retrieve a paginated list of all options for a specific investment.
1059
1256
  * @summary List options for this investment
@@ -1112,6 +1309,17 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
1112
1309
  postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse> {
1113
1310
  return localVarFp.postInvestment(investmentCreate, options).then((request) => request(axios, basePath));
1114
1311
  },
1312
+ /**
1313
+ * Set the preferred option for an investment.
1314
+ * @summary Set the preferred option for an investment
1315
+ * @param {string} investmentId UUID of the investment
1316
+ * @param {FavoredOptionRequest} favoredOptionRequest
1317
+ * @param {*} [options] Override http request option.
1318
+ * @throws {RequiredError}
1319
+ */
1320
+ setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
1321
+ return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
1322
+ },
1115
1323
  };
1116
1324
  };
1117
1325
 
@@ -1180,6 +1388,17 @@ export class InvestmentApi extends BaseAPI {
1180
1388
  return InvestmentApiFp(this.configuration).deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1181
1389
  }
1182
1390
 
1391
+ /**
1392
+ * Get the preferred option for an investment.
1393
+ * @summary Get the preferred option for an investment
1394
+ * @param {string} investmentId UUID of the investment
1395
+ * @param {*} [options] Override http request option.
1396
+ * @throws {RequiredError}
1397
+ */
1398
+ public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
1399
+ return InvestmentApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
1400
+ }
1401
+
1183
1402
  /**
1184
1403
  * Retrieve a specific impact for the option.
1185
1404
  * @summary Get an impact for this option
@@ -1242,6 +1461,19 @@ export class InvestmentApi extends BaseAPI {
1242
1461
  return InvestmentApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1243
1462
  }
1244
1463
 
1464
+ /**
1465
+ * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1466
+ * @summary Get the kpis for a given option inside a value framework
1467
+ * @param {string} investmentId UUID of the investment
1468
+ * @param {string} optionId UUID of the option
1469
+ * @param {string} valueFrameworkId UUID of the value framework
1470
+ * @param {*} [options] Override http request option.
1471
+ * @throws {RequiredError}
1472
+ */
1473
+ public getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
1474
+ return InvestmentApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1475
+ }
1476
+
1245
1477
  /**
1246
1478
  * Retrieve a paginated list of all options for a specific investment.
1247
1479
  * @summary List options for this investment
@@ -1304,5 +1536,17 @@ export class InvestmentApi extends BaseAPI {
1304
1536
  public postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig) {
1305
1537
  return InvestmentApiFp(this.configuration).postInvestment(investmentCreate, options).then((request) => request(this.axios, this.basePath));
1306
1538
  }
1539
+
1540
+ /**
1541
+ * Set the preferred option for an investment.
1542
+ * @summary Set the preferred option for an investment
1543
+ * @param {string} investmentId UUID of the investment
1544
+ * @param {FavoredOptionRequest} favoredOptionRequest
1545
+ * @param {*} [options] Override http request option.
1546
+ * @throws {RequiredError}
1547
+ */
1548
+ public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
1549
+ return InvestmentApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
1550
+ }
1307
1551
  }
1308
1552