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

package/dist/esm/api/investment-api.js

@@ -219,6 +219,39 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Get the preferred option for an investment.
+         * @summary Get the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFavoredOption: (investmentId_1, ...args_1) => __awaiter(this, [investmentId_1, ...args_1], void 0, function* (investmentId, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getFavoredOption', 'investmentId', investmentId);
+            const localVarPath = `/investment/{investment_id}/favored_option`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
+            // 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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Retrieve a specific impact for the option.
          * @summary Get an impact for this option
@@ -412,6 +445,47 @@ export 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
+            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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, 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
@@ -613,6 +687,44 @@ export const InvestmentApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Set the preferred option for an investment.
+         * @summary Set the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {FavoredOptionRequest} favoredOptionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setFavoredOption: (investmentId_1, favoredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, favoredOptionRequest_1, ...args_1], void 0, function* (investmentId, favoredOptionRequest, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('setFavoredOption', 'investmentId', investmentId);
+            // verify required parameter 'favoredOptionRequest' is not null or undefined
+            assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest);
+            const localVarPath = `/investment/{investment_id}/favored_option`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
+            // 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 = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 /**
@@ -707,6 +819,22 @@ export const InvestmentApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Get the preferred option for an investment.
+         * @summary Get the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFavoredOption(investmentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getFavoredOption(investmentId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.getFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Retrieve a specific impact for the option.
          * @summary Get an impact for this option
@@ -794,6 +922,24 @@ export const InvestmentApiFp = function (configuration) {
                 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}
+         */
+        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 = operationServerMap['InvestmentApi.getOptionKpis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.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
@@ -882,6 +1028,23 @@ export const InvestmentApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Set the preferred option for an investment.
+         * @summary Set the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {FavoredOptionRequest} favoredOptionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setFavoredOption(investmentId, favoredOptionRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['InvestmentApi.setFavoredOption']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
     };
 };
 /**
@@ -946,6 +1109,16 @@ export const InvestmentApiFactory = function (configuration, basePath, axios) {
         deleteOptionForInvestment(optionId, investmentId, options) {
             return localVarFp.deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get the preferred option for an investment.
+         * @summary Get the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getFavoredOption(investmentId, options) {
+            return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a specific impact for the option.
          * @summary Get an impact for this option
@@ -1003,6 +1176,18 @@ export 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
@@ -1061,6 +1246,17 @@ export const InvestmentApiFactory = function (configuration, basePath, axios) {
         postInvestment(investmentCreate, options) {
             return localVarFp.postInvestment(investmentCreate, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Set the preferred option for an investment.
+         * @summary Set the preferred option for an investment
+         * @param {string} investmentId UUID of the investment
+         * @param {FavoredOptionRequest} favoredOptionRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setFavoredOption(investmentId, favoredOptionRequest, options) {
+            return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -1123,6 +1319,16 @@ export class InvestmentApi extends BaseAPI {
     deleteOptionForInvestment(optionId, investmentId, options) {
         return InvestmentApiFp(this.configuration).deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFavoredOption(investmentId, options) {
+        return InvestmentApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -1180,6 +1386,18 @@ export class InvestmentApi extends BaseAPI {
     getOptionForInvestment(optionId, investmentId, options) {
         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}
+     */
+    getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
+        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
@@ -1238,4 +1456,15 @@ export class InvestmentApi extends BaseAPI {
     postInvestment(investmentCreate, options) {
         return InvestmentApiFp(this.configuration).postInvestment(investmentCreate, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Set the preferred option for an investment.
+     * @summary Set the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setFavoredOption(investmentId, favoredOptionRequest, options) {
+        return InvestmentApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }

package/dist/esm/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

package/dist/esm/api/option-api.js

@@ -310,6 +310,47 @@ export const OptionApiAxiosParamCreator = 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
+            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 = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, 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
@@ -571,6 +612,24 @@ export const OptionApiFp = function (configuration) {
                 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}
+         */
+        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 = operationServerMap['OptionApi.getOptionKpis']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.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
@@ -716,6 +775,18 @@ export const OptionApiFactory = 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
@@ -841,6 +912,18 @@ export class OptionApi extends BaseAPI {
     getOptionForInvestment(optionId, investmentId, options) {
         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}
+     */
+    getOptionKpis(investmentId, optionId, valueFrameworkId, options) {
+        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/esm/api.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 export * from './api/default-api';
+export * from './api/favored-option-api';
 export * from './api/impact-api';
 export * from './api/investment-api';
 export * from './api/metric-api';

package/dist/esm/api.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 export * from './api/default-api';
+export * from './api/favored-option-api';
 export * from './api/impact-api';
 export * from './api/investment-api';
 export * from './api/metric-api';

package/dist/esm/models/favored-option-request.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Request body for setting the preferred option.
+ */
+export interface FavoredOptionRequest {
+    /**
+     * ID of the option to set as preferred
+     */
+    'option_id': string;
+}

package/dist/esm/models/favored-option-request.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/favored-option-response.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Response for favored option endpoints.
+ */
+export interface FavoredOptionResponse {
+    /**
+     * ID of the preferred option
+     */
+    'option_id': string;
+}

package/dist/esm/models/favored-option-response.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/index.d.ts

@@ -1,4 +1,6 @@
 export * from './evolution-type';
+export * from './favored-option-request';
+export * from './favored-option-response';
 export * from './httpvalidation-error';
 export * from './impact-apiresponse';
 export * from './impact-create';
@@ -21,6 +23,8 @@ export * from './objective-update';
 export * from './objective-weight-create';
 export * from './objective-weight-response';
 export * from './objective-weight-update';
+export * from './option-chart-kpi';
+export * from './option-chart-kpis-yearly';
 export * from './option-create';
 export * from './option-response';
 export * from './option-update';

package/dist/esm/models/index.js

@@ -1,4 +1,6 @@
 export * from './evolution-type';
+export * from './favored-option-request';
+export * from './favored-option-response';
 export * from './httpvalidation-error';
 export * from './impact-apiresponse';
 export * from './impact-create';
@@ -21,6 +23,8 @@ export * from './objective-update';
 export * from './objective-weight-create';
 export * from './objective-weight-response';
 export * from './objective-weight-update';
+export * from './option-chart-kpi';
+export * from './option-chart-kpis-yearly';
 export * from './option-create';
 export * from './option-response';
 export * from './option-update';

package/dist/esm/models/investment-response.d.ts

@@ -21,5 +21,6 @@ export interface InvestmentResponse {
      */
     'name': string;
     'owner_name'?: string | null;
+    'preferred_option_id'?: string | null;
     'updated_at': string;
 }

package/dist/esm/models/option-chart-kpi.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema of a KPI value for a given time step, contain both the monetary and objective value
+ */
+export interface OptionChartKPI {
+    /**
+     * Metric value of the KPI
+     */
+    'metric_value'?: number;
+    /**
+     * Monetary value of the KPI
+     */
+    'monetary_value'?: number;
+    'name'?: string | null;
+    /**
+     * Symbol of the KPI
+     */
+    'symbol'?: string;
+}