@cosmotech/aip-client 0.4.0-dev2 → 0.4.0-dev5

package/dist/models/portfolio-kpiresponse.d.ts

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

package/dist/models/portfolio-kpiresponse.js

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

package/dist/models/portfolio-overview-item-response.d.ts

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

package/dist/models/portfolio-overview-item-response.js

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

package/dist/models/portfolio-response.d.ts

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

package/dist/models/portfolio-response.js

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

package/dist/models/portfolio-update.d.ts

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

package/dist/models/portfolio-update.js

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

package/dist/models/preferred-option-request.d.ts

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

package/dist/models/preferred-option-request.js

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

package/dist/models/preferred-option-response.d.ts

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

package/dist/models/preferred-option-response.js

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

package/dist/models/validation-error.d.ts

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

package/dist/models/validation-error.js

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

package/dist/models/value-framework-create.d.ts

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

package/dist/models/value-framework-create.js

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

package/dist/models/value-framework-response.d.ts

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

package/dist/models/value-framework-response.js

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

package/dist/models/value-framework-update.d.ts

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

package/dist/models/value-framework-update.js

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

package/docs/BudgetApi.md

@@ -7,12 +7,12 @@ All URIs are relative to *http://localhost*
 |[**bulkDeleteBudgets**](#bulkdeletebudgets) | **POST** /budget/bulk-delete | Bulk delete budgets|
 |[**deleteBudget**](#deletebudget) | **DELETE** /budget/{budget_id} | Delete a budget|
 |[**getBudgetById**](#getbudgetbyid) | **GET** /budget/{budget_id} | Get a budget by ID|
-|[**getBudgetInvestments**](#getbudgetinvestments) | **GET** /budget/{budget_id}/investments/{value_framework_id} | List investments linked to this budget via options|
-|[**getBudgetOptions**](#getbudgetoptions) | **GET** /budget/{budget_id}/options/{value_framework_id} | List options linked to this budget|
+|[**getBudgetInvestments**](#getbudgetinvestments) | **GET** /budget/{budget_id}/investments | List investments linked to this budget via options|
+|[**getBudgetOptions**](#getbudgetoptions) | **GET** /budget/{budget_id}/options | List options linked to this budget|
 |[**getBudgetOverview**](#getbudgetoverview) | **GET** /budget/{budget_id}/overview | Get budget overview|
 |[**getBudgets**](#getbudgets) | **GET** /budget/ | List all budgets|
 |[**linkOptionsToBudget**](#linkoptionstobudget) | **POST** /budget/{budget_id}/link-options | Bulk-link options to this budget|
-|[**listAvailableOptions**](#listavailableoptions) | **GET** /budget/list-available-options/{value_framework_id} | List all options available to be added to a budget|
+|[**listAvailableOptions**](#listavailableoptions) | **GET** /budget/list-available-options | List all options available to be added to a budget|
 |[**patchBudget**](#patchbudget) | **PATCH** /budget/{budget_id} | Partially update a budget|
 |[**postBudget**](#postbudget) | **POST** /budget/ | Create a budget|
 
@@ -190,7 +190,7 @@ const configuration = new Configuration();
 const apiInstance = new BudgetApi(configuration);
 
 let budgetId: string; //UUID of the budget (default to undefined)
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getBudgetInvestments(
     budgetId,
@@ -203,7 +203,7 @@ const { status, data } = await apiInstance.getBudgetInvestments(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -224,7 +224,7 @@ const { status, data } = await apiInstance.getBudgetInvestments(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Investments linked to this budget |  -  |
-|**404** | Budget or value framework not found |  -  |
+|**404** | Budget not found, or value framework not found (when value_framework_id is provided but invalid) |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -245,7 +245,7 @@ const configuration = new Configuration();
 const apiInstance = new BudgetApi(configuration);
 
 let budgetId: string; //UUID of the budget (default to undefined)
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getBudgetOptions(
     budgetId,
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.getBudgetOptions(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -279,7 +279,7 @@ const { status, data } = await apiInstance.getBudgetOptions(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Options linked to this budget |  -  |
-|**404** | Budget or value framework not found |  -  |
+|**404** | Budget not found, or value framework not found (when value_framework_id is provided but invalid) |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -390,9 +390,9 @@ const { status, data } = await apiInstance.getBudgets(
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **linkOptionsToBudget**
-> Array<string> linkOptionsToBudget(budgetLinkOptionsRequest)
+> Array<string | null> linkOptionsToBudget(budgetLinkOptionsRequest)
 
-Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Also any previous option linked to this budget will be overwritten. Returns the list of option IDs that were successfully linked.
 
 ### Example
 
@@ -425,7 +425,7 @@ const { status, data } = await apiInstance.linkOptionsToBudget(
 
 ### Return type
 
-**Array<string>**
+**Array<string | null>**
 
 ### Authorization
 
@@ -449,7 +449,7 @@ const { status, data } = await apiInstance.linkOptionsToBudget(
 # **listAvailableOptions**
 > Array<BudgetOptionResponse> listAvailableOptions()
 
-Returns a list of all options, with their investment context and NPV.
+Returns a list of all options, with their investment context and NPV. If value_framework_id is omitted, NPV will be null for all options.
 
 ### Example
 
@@ -462,7 +462,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BudgetApi(configuration);
 
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listAvailableOptions(
     valueFrameworkId
@@ -473,7 +473,7 @@ const { status, data } = await apiInstance.listAvailableOptions(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -494,6 +494,7 @@ const { status, data } = await apiInstance.listAvailableOptions(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | List of all option objects |  -  |
+|**404** | Value framework not found (when value_framework_id is provided but invalid) |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

package/docs/BudgetOptionResponse.md

@@ -6,6 +6,7 @@ Schema for one row in the \'Options using budget\' tab on the budget detail page
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** | Total investment cost of the option | [default to undefined]
 **duration** | **number** | Total duration of the option in weeks | [default to undefined]
 **investmentId** | **string** | ID of the parent investment | [default to undefined]
@@ -23,6 +24,7 @@ Name | Type | Description | Notes
 import { BudgetOptionResponse } from '@cosmotech/aip-client';
 
 const instance: BudgetOptionResponse = {
+    budgetId,
     cost,
     duration,
     investmentId,

package/docs/InvestmentApi.md

@@ -226,7 +226,7 @@ const { status, data } = await apiInstance.getInvestments(
 # **getInvestmentsOverview**
 > Array<InvestmentOverviewResponse> getInvestmentsOverview()
 
-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.
+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. When no value_framework_id is provided, NPV is returned as null.
 
 ### Example
 
@@ -239,7 +239,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new InvestmentApi(configuration);
 
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getInvestmentsOverview(
     valueFrameworkId
@@ -250,7 +250,7 @@ const { status, data } = await apiInstance.getInvestmentsOverview(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/MonetizedImpactDetailedResponse.md

@@ -0,0 +1,21 @@
+# MonetizedImpactDetailedResponse
+
+Response for the detailed portfolio monetized impact endpoint (split by metric).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<MonetizedImpactDetailedYear>**](MonetizedImpactDetailedYear.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MonetizedImpactDetailedResponse } from '@cosmotech/aip-client';
+
+const instance: MonetizedImpactDetailedResponse = {
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MonetizedImpactDetailedYear.md

@@ -0,0 +1,25 @@
+# MonetizedImpactDetailedYear
+
+Year-level breakdown with CAPEX and per-metric monetized impact.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**investmentCost** | **number** |  | [default to undefined]
+**metrics** | [**Array<MonetizedImpactMetricValue>**](MonetizedImpactMetricValue.md) |  | [default to undefined]
+**year** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MonetizedImpactDetailedYear } from '@cosmotech/aip-client';
+
+const instance: MonetizedImpactDetailedYear = {
+    investmentCost,
+    metrics,
+    year,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MonetizedImpactMetricValue.md

@@ -0,0 +1,25 @@
+# MonetizedImpactMetricValue
+
+Monetized impact value for one metric in one year.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metricId** | **string** |  | [default to undefined]
+**metricName** | **string** |  | [default to undefined]
+**monetaryValue** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MonetizedImpactMetricValue } from '@cosmotech/aip-client';
+
+const instance: MonetizedImpactMetricValue = {
+    metricId,
+    metricName,
+    monetaryValue,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OptionApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost*
 |[**createOptionForInvestment**](#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment|
 |[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
 |[**getOptionForInvestment**](#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment|
-|[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework|
+|[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis | Get the kpis for a given option inside a value framework|
 |[**getOptionsForInvestment**](#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment|
 |[**getOptionsOverview**](#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment|
 |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
@@ -182,7 +182,7 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 # **getOptionKpis**
 > Array<OptionChartKPIsYearly> getOptionKpis()
 
-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.
+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. If no value_framework_id is provided, returns an empty list.
 
 ### Example
 
@@ -197,7 +197,7 @@ const apiInstance = new OptionApi(configuration);
 
 let optionId: string; //UUID of the option (default to undefined)
 let investmentId: string; //UUID of the investment (default to undefined)
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getOptionKpis(
     optionId,
@@ -212,7 +212,7 @@ const { status, data } = await apiInstance.getOptionKpis(
 |------------- | ------------- | ------------- | -------------|
 | **optionId** | [**string**] | UUID of the option | defaults to undefined|
 | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/PortfolioApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost*
 |[**bulkDeletePortfolios**](#bulkdeleteportfolios) | **POST** /portfolio/bulk-delete | Bulk delete portfolios|
 |[**deletePortfolio**](#deleteportfolio) | **DELETE** /portfolio/{portfolio_id} | Delete a portfolio|
 |[**getPortfolioById**](#getportfoliobyid) | **GET** /portfolio/{portfolio_id} | Get a portfolio by ID|
-|[**getPortfolioOverview**](#getportfoliooverview) | **GET** /portfolio/overview/{value_framework_id} | Portfolio overview with KPIs|
+|[**getPortfolioOverview**](#getportfoliooverview) | **GET** /portfolio/overview | Portfolio overview with KPIs|
 |[**getPortfolios**](#getportfolios) | **GET** /portfolio/ | List portfolios|
 |[**patchPortfolio**](#patchportfolio) | **PATCH** /portfolio/{portfolio_id} | Partially update a portfolio|
 |[**postPortfolio**](#postportfolio) | **POST** /portfolio/ | Create a portfolio|
@@ -172,7 +172,7 @@ const { status, data } = await apiInstance.getPortfolioById(
 # **getPortfolioOverview**
 > Array<PortfolioOverviewItemResponse> getPortfolioOverview()
 
-Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
 
 ### Example
 
@@ -185,14 +185,14 @@ import {
 const configuration = new Configuration();
 const apiInstance = new PortfolioApi(configuration);
 
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
 let offset: number; //Number of records to skip (optional) (default to 0)
 let limit: number; //Max number of records to return (optional) (default to 100)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getPortfolioOverview(
-    valueFrameworkId,
     offset,
-    limit
+    limit,
+    valueFrameworkId
 );
 ```
 
@@ -200,9 +200,9 @@ const { status, data } = await apiInstance.getPortfolioOverview(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
 | **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
 | **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -223,7 +223,7 @@ const { status, data } = await apiInstance.getPortfolioOverview(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | List of portfolios with KPIs |  -  |
-|**404** | Value framework not found |  -  |
+|**404** | Value framework not found (when provided) |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 

package/docs/PortfolioInvestmentApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *http://localhost*
 |[**bulkRemoveInvestmentsFromPortfolio**](#bulkremoveinvestmentsfromportfolio) | **POST** /portfolio/{portfolio_id}/investment/bulk-delete | Bulk remove investments from this portfolio|
 |[**getInvestmentForPortfolio**](#getinvestmentforportfolio) | **GET** /portfolio/{portfolio_id}/investment/{investment_id} | Get an investment link in this portfolio|
 |[**getInvestmentsForPortfolio**](#getinvestmentsforportfolio) | **GET** /portfolio/{portfolio_id}/investment/ | List investments in this portfolio|
+|[**getPortfolioInvestmentsOverview**](#getportfolioinvestmentsoverview) | **GET** /portfolio/{portfolio_id}/investment/overview | Investment overview table for this portfolio|
 |[**removeInvestmentFromPortfolio**](#removeinvestmentfromportfolio) | **DELETE** /portfolio/{portfolio_id}/investment/{investment_id} | Remove an investment from this portfolio|
 
 # **addInvestmentToPortfolio**
@@ -293,6 +294,61 @@ const { status, data } = await apiInstance.getInvestmentsForPortfolio(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getPortfolioInvestmentsOverview**
+> Array<PortfolioInvestmentOverviewResponse> getPortfolioInvestmentsOverview()
+
+Return a flat overview of all investments in this portfolio. For each investment the preferred option\'s name, start date, cost, duration, NPV and budget name are included. Investments without a preferred option have null values for those fields.
+
+### Example
+
+```typescript
+import {
+    PortfolioInvestmentApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioInvestmentApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioInvestmentsOverview(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<PortfolioInvestmentOverviewResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Overview list of investments in this portfolio |  -  |
+|**404** | Portfolio or value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **removeInvestmentFromPortfolio**
 > removeInvestmentFromPortfolio()
 

package/docs/PortfolioInvestmentOverviewResponse.md

@@ -0,0 +1,35 @@
+# PortfolioInvestmentOverviewResponse
+
+Schema for the portfolio investment overview table — one row per investment in the portfolio.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetName** | **string** |  | [optional] [default to undefined]
+**investmentId** | **string** | ID of the investment | [default to undefined]
+**investmentName** | **string** | Name of the investment | [default to undefined]
+**preferredOptionCost** | **number** |  | [optional] [default to undefined]
+**preferredOptionDuration** | **number** |  | [optional] [default to undefined]
+**preferredOptionName** | **string** |  | [optional] [default to undefined]
+**preferredOptionNpv** | **number** |  | [optional] [default to undefined]
+**preferredOptionStartDate** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioInvestmentOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioInvestmentOverviewResponse = {
+    budgetName,
+    investmentId,
+    investmentName,
+    preferredOptionCost,
+    preferredOptionDuration,
+    preferredOptionName,
+    preferredOptionNpv,
+    preferredOptionStartDate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)