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

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.2.0-dev6
+## @cosmotech/aip-client@0.2.0-dev7
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cosmotech/aip-client@0.2.0-dev6 --save
+npm install @cosmotech/aip-client@0.2.0-dev7 --save
 ```
 
 _unPublished (not recommended):_
@@ -66,9 +66,11 @@ Class | Method | HTTP request | Description
 *InvestmentApi* | [**getImpactsForOption**](docs/InvestmentApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
 *InvestmentApi* | [**getInvestmentById**](docs/InvestmentApi.md#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID
 *InvestmentApi* | [**getInvestments**](docs/InvestmentApi.md#getinvestments) | **GET** /investment/ | List investments
+*InvestmentApi* | [**getInvestmentsOverview**](docs/InvestmentApi.md#getinvestmentsoverview) | **GET** /investment/overview | Investment overview table
 *InvestmentApi* | [**getOptionForInvestment**](docs/InvestmentApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
 *InvestmentApi* | [**getOptionKpis**](docs/InvestmentApi.md#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework
 *InvestmentApi* | [**getOptionsForInvestment**](docs/InvestmentApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
+*InvestmentApi* | [**getOptionsOverview**](docs/InvestmentApi.md#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment
 *InvestmentApi* | [**getPreferredOption**](docs/InvestmentApi.md#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment
 *InvestmentApi* | [**patchImpactForOption**](docs/InvestmentApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
 *InvestmentApi* | [**patchInvestment**](docs/InvestmentApi.md#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment
@@ -112,6 +114,7 @@ Class | Method | HTTP request | Description
 *OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
 *OptionApi* | [**getOptionKpis**](docs/OptionApi.md#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework
 *OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
+*OptionApi* | [**getOptionsOverview**](docs/OptionApi.md#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment
 *OptionApi* | [**patchImpactForOption**](docs/OptionApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
 *OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
 *PreferredOptionApi* | [**getPreferredOption**](docs/PreferredOptionApi.md#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment
@@ -147,6 +150,7 @@ Class | Method | HTTP request | Description
  - [ImpactCreate](docs/ImpactCreate.md)
  - [ImpactUpdate](docs/ImpactUpdate.md)
  - [InvestmentCreate](docs/InvestmentCreate.md)
+ - [InvestmentOverviewResponse](docs/InvestmentOverviewResponse.md)
  - [InvestmentResponse](docs/InvestmentResponse.md)
  - [InvestmentUpdate](docs/InvestmentUpdate.md)
  - [LocationInner](docs/LocationInner.md)
@@ -167,6 +171,7 @@ Class | Method | HTTP request | Description
  - [OptionChartKPI](docs/OptionChartKPI.md)
  - [OptionChartKPIsYearly](docs/OptionChartKPIsYearly.md)
  - [OptionCreate](docs/OptionCreate.md)
+ - [OptionOverviewResponse](docs/OptionOverviewResponse.md)
  - [OptionResponse](docs/OptionResponse.md)
  - [OptionUpdate](docs/OptionUpdate.md)
  - [PreferredOptionRequest](docs/PreferredOptionRequest.md)

package/api/investment-api.ts

@@ -30,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';
@@ -38,6 +40,8 @@ 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';
@@ -443,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
@@ -486,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
@@ -579,6 +624,51 @@ 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
@@ -978,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
@@ -993,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
@@ -1022,6 +1125,20 @@ 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
@@ -1218,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
@@ -1230,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
@@ -1253,6 +1380,17 @@ 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
@@ -1438,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
@@ -1451,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
@@ -1476,6 +1625,18 @@ 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

package/api/option-api.ts

@@ -32,6 +32,8 @@ 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';
@@ -357,7 +359,7 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
             };
         },
         /**
-         * 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
@@ -450,6 +452,51 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
                 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,
+            };
+        },
         /**
          * 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
@@ -661,7 +708,7 @@ export const OptionApiFp = 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
@@ -690,6 +737,20 @@ export const OptionApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OptionApi.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['OptionApi.getOptionsOverview']?.[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
@@ -813,7 +874,7 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
             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
@@ -836,6 +897,17 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
         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));
+        },
         /**
          * 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
@@ -958,7 +1030,7 @@ export class OptionApi 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
@@ -983,6 +1055,18 @@ export class OptionApi extends BaseAPI {
         return OptionApiFp(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 OptionApiFp(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, 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

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

@@ -16,10 +16,12 @@ import type { ImpactAPIResponse } from '../models';
 import type { ImpactCreate } from '../models';
 import type { ImpactUpdate } from '../models';
 import type { InvestmentCreate } from '../models';
+import type { InvestmentOverviewResponse } from '../models';
 import type { InvestmentResponse } from '../models';
 import type { InvestmentUpdate } from '../models';
 import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } from '../models';
+import type { OptionOverviewResponse } from '../models';
 import type { OptionResponse } from '../models';
 import type { OptionUpdate } from '../models';
 import type { PreferredOptionRequest } from '../models';
@@ -112,6 +114,14 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getInvestments: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -122,7 +132,7 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      */
     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
+     * 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
@@ -141,6 +151,15 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
     /**
      * Get the preferred option for an investment.
      * @summary Get the preferred option for an investment
@@ -285,6 +304,14 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentResponse>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -295,7 +322,7 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      */
     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
+     * 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
@@ -314,6 +341,15 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
     /**
      * Get the preferred option for an investment.
      * @summary Get the preferred option for an investment
@@ -458,6 +494,14 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentResponse>>;
+    /**
+     * 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>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -468,7 +512,7 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      */
     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
+     * 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
@@ -487,6 +531,15 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
+    /**
+     * 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>>;
     /**
      * Get the preferred option for an investment.
      * @summary Get the preferred option for an investment
@@ -631,6 +684,14 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse[], any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<InvestmentOverviewResponse[], any, {}>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -641,7 +702,7 @@ export declare class InvestmentApi extends BaseAPI {
      */
     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
+     * 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
@@ -660,6 +721,15 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
     /**
      * Get the preferred option for an investment.
      * @summary Get the preferred option for an investment