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

package/dist/api/investment-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -222,39 +222,6 @@ 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
@@ -411,6 +378,41 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * @summary Investment overview table
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvestmentsOverview: (valueFrameworkId_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, ...args_1], void 0, function* (valueFrameworkId, options = {}) {
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            (0, common_1.assertParamExists)('getInvestmentsOverview', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/investment/overview`;
+            // 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);
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+            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 option for the investment.
          * @summary Get an option for this investment
@@ -449,7 +451,7 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
          * @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
@@ -530,6 +532,78 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+         * @summary Option overview table for this investment
+         * @param {string} investmentId UUID of the investment
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionsOverview: (investmentId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, valueFrameworkId, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            (0, common_1.assertParamExists)('getOptionsOverview', 'investmentId', investmentId);
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            (0, common_1.assertParamExists)('getOptionsOverview', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/investment/{investment_id}/option/overview`
+                .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);
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+            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,
+            };
+        }),
+        /**
+         * 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}
+         */
+        getPreferredOption: (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)('getPreferredOption', 'investmentId', investmentId);
+            const localVarPath = `/investment/{investment_id}/preferred_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,
+            };
+        }),
         /**
          * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
          * @summary Partially update an impact for this option
@@ -694,16 +768,16 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
          * 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 {PreferredOptionRequest} preferredOptionRequest
          * @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 = {}) {
+        setPreferredOption: (investmentId_1, preferredOptionRequest_1, ...args_1) => __awaiter(this, [investmentId_1, preferredOptionRequest_1, ...args_1], void 0, function* (investmentId, preferredOptionRequest, 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`
+            (0, common_1.assertParamExists)('setPreferredOption', 'investmentId', investmentId);
+            // verify required parameter 'preferredOptionRequest' is not null or undefined
+            (0, common_1.assertParamExists)('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest);
+            const localVarPath = `/investment/{investment_id}/preferred_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);
@@ -722,7 +796,7 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
             (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);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(preferredOptionRequest, localVarRequestOptions, configuration);
             return {
                 url: (0, common_1.toPathString)(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -823,22 +897,6 @@ 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
@@ -909,6 +967,22 @@ 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 flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * @summary Investment overview table
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvestmentsOverview(valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getInvestmentsOverview(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.getInvestmentsOverview']) === 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 option for the investment.
          * @summary Get an option for this investment
@@ -927,7 +1001,7 @@ const InvestmentApiFp = function (configuration) {
             });
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
          * @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
@@ -962,6 +1036,39 @@ 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 flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+         * @summary Option overview table for this investment
+         * @param {string} investmentId UUID of the investment
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionsOverview(investmentId, valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionsOverview(investmentId, 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.getOptionsOverview']) === 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);
+            });
+        },
+        /**
+         * 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}
+         */
+        getPreferredOption(investmentId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPreferredOption(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.getPreferredOption']) === 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);
+            });
+        },
         /**
          * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
          * @summary Partially update an impact for this option
@@ -1036,16 +1143,16 @@ const InvestmentApiFp = function (configuration) {
          * 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 {PreferredOptionRequest} preferredOptionRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        setFavoredOption(investmentId, favoredOptionRequest, options) {
+        setPreferredOption(investmentId, preferredOptionRequest, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, 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;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.setPreferredOption']) === 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);
             });
         },
@@ -1114,16 +1221,6 @@ 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
@@ -1170,6 +1267,16 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
         getInvestments(offset, limit, options) {
             return localVarFp.getInvestments(offset, limit, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * @summary Investment overview table
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvestmentsOverview(valueFrameworkId, options) {
+            return localVarFp.getInvestmentsOverview(valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a specific option for the investment.
          * @summary Get an option for this investment
@@ -1182,7 +1289,7 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
             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
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
          * @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
@@ -1205,6 +1312,27 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
         getOptionsForInvestment(investmentId, offset, limit, options) {
             return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+         * @summary Option overview table for this investment
+         * @param {string} investmentId UUID of the investment
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionsOverview(investmentId, valueFrameworkId, options) {
+            return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, 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}
+         */
+        getPreferredOption(investmentId, options) {
+            return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
          * @summary Partially update an impact for this option
@@ -1255,12 +1383,12 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
          * 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 {PreferredOptionRequest} preferredOptionRequest
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        setFavoredOption(investmentId, favoredOptionRequest, options) {
-            return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
+        setPreferredOption(investmentId, preferredOptionRequest, options) {
+            return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -1325,16 +1453,6 @@ 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
@@ -1381,6 +1499,16 @@ class InvestmentApi extends base_1.BaseAPI {
     getInvestments(offset, limit, options) {
         return (0, exports.InvestmentApiFp)(this.configuration).getInvestments(offset, limit, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * @summary Investment overview table
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentsOverview(valueFrameworkId, options) {
+        return (0, exports.InvestmentApiFp)(this.configuration).getInvestmentsOverview(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -1393,7 +1521,7 @@ class InvestmentApi extends base_1.BaseAPI {
         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
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
      * @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
@@ -1416,6 +1544,27 @@ class InvestmentApi extends base_1.BaseAPI {
     getOptionsForInvestment(investmentId, offset, limit, options) {
         return (0, exports.InvestmentApiFp)(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+     * @summary Option overview table for this investment
+     * @param {string} investmentId UUID of the investment
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionsOverview(investmentId, valueFrameworkId, options) {
+        return (0, exports.InvestmentApiFp)(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, 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}
+     */
+    getPreferredOption(investmentId, options) {
+        return (0, exports.InvestmentApiFp)(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an impact for this option
@@ -1466,12 +1615,12 @@ class InvestmentApi extends base_1.BaseAPI {
      * 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 {PreferredOptionRequest} preferredOptionRequest
      * @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));
+    setPreferredOption(investmentId, preferredOptionRequest, options) {
+        return (0, exports.InvestmentApiFp)(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.InvestmentApi = InvestmentApi;

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

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-per-year-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/metric-costs-per-year-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weight-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weight-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weights-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/api/objective-weights-api.js

@@ -5,7 +5,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).