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

package/api/investment-api.ts

@@ -4,7 +4,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).
@@ -22,10 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
-import type { FavoredOptionRequest } from '../models';
-// @ts-ignore
-import type { FavoredOptionResponse } from '../models';
-// @ts-ignore
 import type { ImpactAPIResponse } from '../models';
 // @ts-ignore
 import type { ImpactCreate } from '../models';
@@ -34,6 +30,8 @@ import type { ImpactUpdate } from '../models';
 // @ts-ignore
 import type { InvestmentCreate } from '../models';
 // @ts-ignore
+import type { InvestmentOverviewResponse } from '../models';
+// @ts-ignore
 import type { InvestmentResponse } from '../models';
 // @ts-ignore
 import type { InvestmentUpdate } from '../models';
@@ -42,9 +40,15 @@ import type { OptionChartKPIsYearly } from '../models';
 // @ts-ignore
 import type { OptionCreate } from '../models';
 // @ts-ignore
+import type { OptionOverviewResponse } from '../models';
+// @ts-ignore
 import type { OptionResponse } from '../models';
 // @ts-ignore
 import type { OptionUpdate } from '../models';
+// @ts-ignore
+import type { PreferredOptionRequest } from '../models';
+// @ts-ignore
+import type { PreferredOptionResponse } from '../models';
 /**
  * InvestmentApi - axios parameter creator
  */
@@ -254,44 +258,6 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
 
-            setSearchParams(localVarUrlObj, localVarQueryParameter);
-            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
-            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-
-            return {
-                url: 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}
-         */
-        getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // 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 = { method: 'GET', ...baseOptions, ...options};
-            const localVarHeaderParameter = {} as any;
-            const localVarQueryParameter = {} as any;
-
-            // authentication OAuth2AuthorizationCodeBearer required
-            // oauth required
-            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
-
-            localVarHeaderParameter['Accept'] = 'application/json';
-
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -481,6 +447,47 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
                 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: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            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, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieve a specific option for the investment.
          * @summary Get an option for this investment
@@ -524,7 +531,7 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
             };
         },
         /**
-         * 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
@@ -617,6 +624,89 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
                 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: async (investmentId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getOptionsOverview', 'investmentId', investmentId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            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, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'investmentId' is not null or undefined
+            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, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 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
@@ -801,16 +891,16 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
          * 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: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        setPreferredOption: async (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // 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`
+            assertParamExists('setPreferredOption', 'investmentId', investmentId)
+            // verify required parameter 'preferredOptionRequest' is not null or undefined
+            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, DUMMY_BASE_URL);
@@ -833,7 +923,7 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(preferredOptionRequest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -920,19 +1010,6 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['InvestmentApi.deleteOptionForInvestment']?.[localVarOperationServerIndex]?.url;
             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}
-         */
-        async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
-            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getFavoredOption']?.[localVarOperationServerIndex]?.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
@@ -991,6 +1068,19 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getInvestments']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, 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}
+         */
+        async getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getInvestmentsOverview(valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getInvestmentsOverview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieve a specific option for the investment.
          * @summary Get an option for this investment
@@ -1006,7 +1096,7 @@ export const InvestmentApiFp = function(configuration?: 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
+         * 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
@@ -1035,6 +1125,33 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionsForInvestment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, 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}
+         */
+        async getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getOptionsOverview']?.[localVarOperationServerIndex]?.url;
+            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}
+         */
+        async getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPreferredOption(investmentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getPreferredOption']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, 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
@@ -1097,14 +1214,14 @@ export const InvestmentApiFp = function(configuration?: 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}
          */
-        async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
+        async setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['InvestmentApi.setPreferredOption']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     }
@@ -1172,16 +1289,6 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
         deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             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: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
-            return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
-        },
         /**
          * Retrieve a specific impact for the option.
          * @summary Get an impact for this option
@@ -1228,6 +1335,16 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
         getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentResponse>> {
             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: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>> {
+            return localVarFp.getInvestmentsOverview(valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a specific option for the investment.
          * @summary Get an option for this investment
@@ -1240,7 +1357,7 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
             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
@@ -1263,6 +1380,27 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
         getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>> {
             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: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>> {
+            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: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
+            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
@@ -1313,12 +1451,12 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
          * 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: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
-            return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
+        setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
+            return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -1388,17 +1526,6 @@ export class InvestmentApi extends BaseAPI {
         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}
-     */
-    public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
-        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
@@ -1449,6 +1576,17 @@ export class InvestmentApi extends BaseAPI {
         return 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}
+     */
+    public getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return 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
@@ -1462,7 +1600,7 @@ export class InvestmentApi extends BaseAPI {
     }
 
     /**
-     * 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
@@ -1487,6 +1625,29 @@ export class InvestmentApi extends BaseAPI {
         return 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}
+     */
+    public getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return 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}
+     */
+    public getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig) {
+        return 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
@@ -1541,12 +1702,12 @@ export class InvestmentApi extends 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}
      */
-    public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
-        return InvestmentApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
+    public setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) {
+        return InvestmentApiFp(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

package/api/metric-api.ts

@@ -4,7 +4,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/api/metric-costs-api.ts

@@ -4,7 +4,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/api/metric-costs-per-year-api.ts

@@ -4,7 +4,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/api/objective-api.ts

@@ -4,7 +4,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/api/objective-weight-api.ts

@@ -4,7 +4,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/api/objective-weights-api.ts

@@ -4,7 +4,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).