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

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.2.0-dev4
+## @cosmotech/aip-client@v0.2.0-dev5
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cosmotech/aip-client@0.2.0-dev4 --save
+npm install @cosmotech/aip-client@v0.2.0-dev5 --save
 ```
 
 _unPublished (not recommended):_
@@ -70,6 +70,7 @@ Class | Method | HTTP request | Description
 *InvestmentApi* | [**getInvestmentById**](docs/InvestmentApi.md#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID
 *InvestmentApi* | [**getInvestments**](docs/InvestmentApi.md#getinvestments) | **GET** /investment/ | List investments
 *InvestmentApi* | [**getOptionForInvestment**](docs/InvestmentApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
+*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
 *InvestmentApi* | [**getOptionsForInvestment**](docs/InvestmentApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
 *InvestmentApi* | [**patchImpactForOption**](docs/InvestmentApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
 *InvestmentApi* | [**patchInvestment**](docs/InvestmentApi.md#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment
@@ -111,6 +112,7 @@ Class | Method | HTTP request | Description
 *OptionApi* | [**getImpactForOption**](docs/OptionApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
 *OptionApi* | [**getImpactsForOption**](docs/OptionApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
 *OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
+*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
 *OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
 *OptionApi* | [**patchImpactForOption**](docs/OptionApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
 *OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
@@ -164,6 +166,8 @@ Class | Method | HTTP request | Description
  - [ObjectiveWeightCreate](docs/ObjectiveWeightCreate.md)
  - [ObjectiveWeightResponse](docs/ObjectiveWeightResponse.md)
  - [ObjectiveWeightUpdate](docs/ObjectiveWeightUpdate.md)
+ - [OptionChartKPI](docs/OptionChartKPI.md)
+ - [OptionChartKPIsYearly](docs/OptionChartKPIsYearly.md)
  - [OptionCreate](docs/OptionCreate.md)
  - [OptionResponse](docs/OptionResponse.md)
  - [OptionUpdate](docs/OptionUpdate.md)

package/api/investment-api.ts

@@ -38,6 +38,8 @@ import type { InvestmentResponse } from '../models';
 // @ts-ignore
 import type { InvestmentUpdate } from '../models';
 // @ts-ignore
+import type { OptionChartKPIsYearly } from '../models';
+// @ts-ignore
 import type { OptionCreate } from '../models';
 // @ts-ignore
 import type { OptionResponse } from '../models';
@@ -521,6 +523,52 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis: async (investmentId: string, optionId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getOptionKpis', 'investmentId', investmentId)
+            // verify required parameter 'optionId' is not null or undefined
+            assertParamExists('getOptionKpis', 'optionId', optionId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
+                .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -957,6 +1005,21 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionForInvestment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -1176,6 +1239,18 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
         getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse> {
             return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
+            return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -1386,6 +1461,19 @@ export class InvestmentApi extends BaseAPI {
         return InvestmentApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return InvestmentApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment

package/api/option-api.ts

@@ -28,6 +28,8 @@ import type { ImpactCreate } from '../models';
 // @ts-ignore
 import type { ImpactUpdate } from '../models';
 // @ts-ignore
+import type { OptionChartKPIsYearly } from '../models';
+// @ts-ignore
 import type { OptionCreate } from '../models';
 // @ts-ignore
 import type { OptionResponse } from '../models';
@@ -354,6 +356,52 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis: async (investmentId: string, optionId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getOptionKpis', 'investmentId', investmentId)
+            // verify required parameter 'optionId' is not null or undefined
+            assertParamExists('getOptionKpis', 'optionId', optionId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
+                .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -612,6 +660,21 @@ export const OptionApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionForInvestment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -749,6 +812,18 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
         getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse> {
             return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
+            return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -882,6 +957,19 @@ export class OptionApi extends BaseAPI {
         return OptionApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return OptionApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment

package/dist/api/investment-api.d.ts

@@ -20,6 +20,7 @@ import type { ImpactUpdate } from '../models';
 import type { InvestmentCreate } from '../models';
 import type { InvestmentResponse } from '../models';
 import type { InvestmentUpdate } from '../models';
+import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } from '../models';
 import type { OptionResponse } from '../models';
 import type { OptionUpdate } from '../models';
@@ -128,6 +129,16 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -291,6 +302,16 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -454,6 +475,16 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -617,6 +648,16 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment

package/dist/api/investment-api.js

@@ -448,6 +448,47 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis: (investmentId_1, optionId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, optionId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, optionId, valueFrameworkId, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            (0, common_1.assertParamExists)('getOptionKpis', 'investmentId', investmentId);
+            // verify required parameter 'optionId' is not null or undefined
+            (0, common_1.assertParamExists)('getOptionKpis', 'optionId', optionId);
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            (0, common_1.assertParamExists)('getOptionKpis', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
+                .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -885,6 +926,24 @@ const InvestmentApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.getOptionKpis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -1122,6 +1181,18 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
         getOptionForInvestment(optionId, investmentId, options) {
             return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * @summary Get the kpis for a given option inside a value framework
+         * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
+            return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -1321,6 +1392,18 @@ class InvestmentApi extends base_1.BaseAPI {
     getOptionForInvestment(optionId, investmentId, options) {
         return (0, exports.InvestmentApiFp)(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
+        return (0, exports.InvestmentApiFp)(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment

package/dist/api/option-api.d.ts

@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
 import type { ImpactAPIResponse } from '../models';
 import type { ImpactCreate } from '../models';
 import type { ImpactUpdate } from '../models';
+import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } from '../models';
 import type { OptionResponse } from '../models';
 import type { OptionUpdate } from '../models';
@@ -90,6 +91,16 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -194,6 +205,16 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -298,6 +319,16 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -402,6 +433,16 @@ export declare class OptionApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
+    /**
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * @summary Get the kpis for a given option inside a value framework
+     * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment