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

package/dist/api/investment-api.js

@@ -222,6 +222,39 @@ 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
+            (0, common_1.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, 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 specific impact for the option.
          * @summary Get an impact for this option
@@ -415,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
@@ -616,6 +690,44 @@ 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
+            (0, common_1.assertParamExists)('setFavoredOption', 'investmentId', investmentId);
+            // verify required parameter 'favoredOptionRequest' is not null or undefined
+            (0, common_1.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, common_1.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 (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            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);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(favoredOptionRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 exports.InvestmentApiAxiosParamCreator = InvestmentApiAxiosParamCreator;
@@ -711,6 +823,22 @@ const InvestmentApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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 = base_1.operationServerMap['InvestmentApi.getFavoredOption']) === 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 specific impact for the option.
          * @summary Get an impact for this option
@@ -798,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
@@ -886,6 +1032,23 @@ const InvestmentApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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 = base_1.operationServerMap['InvestmentApi.setFavoredOption']) === 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);
+            });
+        },
     };
 };
 exports.InvestmentApiFp = InvestmentApiFp;
@@ -951,6 +1114,16 @@ 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
@@ -1008,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
@@ -1066,6 +1251,17 @@ 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));
+        },
     };
 };
 exports.InvestmentApiFactory = InvestmentApiFactory;
@@ -1129,6 +1325,16 @@ class InvestmentApi extends base_1.BaseAPI {
     deleteOptionForInvestment(optionId, investmentId, options) {
         return (0, exports.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 (0, exports.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
@@ -1186,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
@@ -1244,5 +1462,16 @@ class InvestmentApi extends base_1.BaseAPI {
     postInvestment(investmentCreate, options) {
         return (0, exports.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 (0, exports.InvestmentApiFp)(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.InvestmentApi = InvestmentApi;

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

package/dist/api/option-api.js

@@ -313,6 +313,47 @@ 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
+            (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
@@ -575,6 +616,24 @@ const OptionApiFp = 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['OptionApi.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
@@ -721,6 +780,18 @@ 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
@@ -847,6 +918,18 @@ class OptionApi extends base_1.BaseAPI {
     getOptionForInvestment(optionId, investmentId, options) {
         return (0, exports.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 (0, exports.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.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/api.js

@@ -28,6 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api/default-api"), exports);
+__exportStar(require("./api/favored-option-api"), exports);
 __exportStar(require("./api/impact-api"), exports);
 __exportStar(require("./api/investment-api"), exports);
 __exportStar(require("./api/metric-api"), exports);

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

@@ -0,0 +1,104 @@
+/**
+ * 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.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { FavoredOptionRequest } from '../models';
+import type { FavoredOptionResponse } from '../models';
+/**
+ * FavoredOptionApi - axios parameter creator
+ */
+export declare const FavoredOptionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FavoredOptionApi - functional programming interface
+ */
+export declare const FavoredOptionApiFp: (configuration?: Configuration) => {
+    /**
+     * 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: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
+    /**
+     * 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: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
+};
+/**
+ * FavoredOptionApi - factory interface
+ */
+export declare const FavoredOptionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
+    /**
+     * 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: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
+};
+/**
+ * FavoredOptionApi - object-oriented interface
+ */
+export declare class FavoredOptionApi extends BaseAPI {
+    /**
+     * 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: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
+    /**
+     * 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: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
+}