@cosmotech/aip-client 0.3.0-dev1 → 0.3.0-dev3

package/docs/InvestmentApi.md

@@ -4,31 +4,18 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**createImpactForOption**](#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option|
-|[**createOptionForInvestment**](#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment|
-|[**deleteImpactForOption**](#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option|
+|[**bulkDeleteInvestments**](#bulkdeleteinvestments) | **POST** /investment/bulk-delete | Bulk delete investments|
 |[**deleteInvestment**](#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment|
-|[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
-|[**getImpactForOption**](#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option|
-|[**getImpactsForOption**](#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option|
 |[**getInvestmentById**](#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID|
 |[**getInvestments**](#getinvestments) | **GET** /investment/ | List investments|
 |[**getInvestmentsOverview**](#getinvestmentsoverview) | **GET** /investment/overview | Investment overview table|
-|[**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|
-|[**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|
-|[**getPreferredOption**](#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment|
-|[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
 |[**patchInvestment**](#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment|
-|[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
 |[**postInvestment**](#postinvestment) | **POST** /investment/ | Create an investment|
-|[**setPreferredOption**](#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment|
 
-# **createImpactForOption**
-> ImpactAPIResponse createImpactForOption(impactCreate)
+# **bulkDeleteInvestments**
+> bulkDeleteInvestments(bulkDeleteRequest)
 
-Create a new impact under this option.
+Delete multiple investments by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no investments are deleted. Associated options are also deleted via cascade.
 
 ### Example
 
@@ -36,522 +23,16 @@ Create a new impact under this option.
 import {
     InvestmentApi,
     Configuration,
-    ImpactCreate
+    BulkDeleteRequest
 } from '@cosmotech/aip-client';
 
 const configuration = new Configuration();
 const apiInstance = new InvestmentApi(configuration);
 
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (default to undefined)
-let impactCreate: ImpactCreate; //
-
-const { status, data } = await apiInstance.createImpactForOption(
-    optionId,
-    investmentId,
-    impactCreate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **impactCreate** | **ImpactCreate**|  | |
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**ImpactAPIResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Impact created successfully |  -  |
-|**400** | Invalid input or constraint violation |  -  |
-|**404** | Investment or option 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)
-
-# **createOptionForInvestment**
-> OptionResponse createOptionForInvestment(optionCreate)
-
-Create a new option under this investment.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration,
-    OptionCreate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let investmentId: string; //UUID of the investment (default to undefined)
-let optionCreate: OptionCreate; //
-
-const { status, data } = await apiInstance.createOptionForInvestment(
-    investmentId,
-    optionCreate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **optionCreate** | **OptionCreate**|  | |
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**OptionResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Option created successfully |  -  |
-|**400** | Invalid input or constraint violation |  -  |
-|**404** | Investment 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)
-
-# **deleteImpactForOption**
-> deleteImpactForOption()
-
-Delete an existing impact by its ID.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let impactId: string; //UUID of the impact (default to undefined)
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (default to undefined)
-
-const { status, data } = await apiInstance.deleteImpactForOption(
-    impactId,
-    optionId,
-    investmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **impactId** | [**string**] | UUID of the impact | defaults to undefined|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | Impact successfully deleted |  -  |
-|**404** | Investment, option, or impact 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)
-
-# **deleteInvestment**
-> deleteInvestment()
-
-Delete an existing investment by its ID. Associated options are also deleted via cascade.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let investmentId: string; //UUID of the investment (default to undefined)
-
-const { status, data } = await apiInstance.deleteInvestment(
-    investmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | Investment successfully deleted |  -  |
-|**404** | Investment 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)
-
-# **deleteOptionForInvestment**
-> deleteOptionForInvestment()
-
-Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (default to undefined)
-
-const { status, data } = await apiInstance.deleteOptionForInvestment(
-    optionId,
-    investmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | Option successfully deleted |  -  |
-|**404** | Investment or option 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)
-
-# **getImpactForOption**
-> ImpactAPIResponse getImpactForOption()
-
-Retrieve a specific impact for the option.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let impactId: string; //UUID of the impact (default to undefined)
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (default to undefined)
-
-const { status, data } = await apiInstance.getImpactForOption(
-    impactId,
-    optionId,
-    investmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **impactId** | [**string**] | UUID of the impact | defaults to undefined|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**ImpactAPIResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | The requested impact |  -  |
-|**404** | Investment, option, or impact 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)
-
-# **getImpactsForOption**
-> Array<ImpactAPIResponse> getImpactsForOption()
-
-Retrieve a paginated list of all impacts for a specific option.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (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)
-
-const { status, data } = await apiInstance.getImpactsForOption(
-    optionId,
-    investmentId,
-    offset,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | 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|
-
-
-### Return type
-
-**Array<ImpactAPIResponse>**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | List of impacts for the option |  -  |
-|**404** | Investment or option 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)
-
-# **getInvestmentById**
-> InvestmentResponse getInvestmentById()
-
-Retrieve a single investment by its ID.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let investmentId: string; //UUID of the investment (default to undefined)
-
-const { status, data } = await apiInstance.getInvestmentById(
-    investmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**InvestmentResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | The requested investment |  -  |
-|**404** | Investment 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)
-
-# **getInvestments**
-> Array<InvestmentResponse> getInvestments()
-
-Retrieve a paginated list of all investments.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-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)
-
-const { status, data } = await apiInstance.getInvestments(
-    offset,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
-| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
-
-
-### Return type
-
-**Array<InvestmentResponse>**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | List of investments |  -  |
-
-[[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)
-
-# **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.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
+let bulkDeleteRequest: BulkDeleteRequest; //
 
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
-
-const { status, data } = await apiInstance.getInvestmentsOverview(
-    valueFrameworkId
+const { status, data } = await apiInstance.bulkDeleteInvestments(
+    bulkDeleteRequest
 );
 ```
 
@@ -559,12 +40,12 @@ const { status, data } = await apiInstance.getInvestmentsOverview(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **bulkDeleteRequest** | **BulkDeleteRequest**|  | |
 
 
 ### Return type
 
-**Array<InvestmentOverviewResponse>**
+void (empty response body)
 
 ### Authorization
 
@@ -572,22 +53,22 @@ const { status, data } = await apiInstance.getInvestmentsOverview(
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Overview list of all investments |  -  |
-|**404** | Value framework not found |  -  |
+|**204** | All investments successfully deleted |  -  |
+|**404** | One or more investment IDs 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)
 
-# **getOptionForInvestment**
-> OptionResponse getOptionForInvestment()
+# **deleteInvestment**
+> deleteInvestment()
 
-Retrieve a specific option for the investment.
+Delete an existing investment by its ID. Associated options are also deleted via cascade.
 
 ### Example
 
@@ -600,11 +81,9 @@ import {
 const configuration = new Configuration();
 const apiInstance = new InvestmentApi(configuration);
 
-let optionId: string; //UUID of the option (default to undefined)
 let investmentId: string; //UUID of the investment (default to undefined)
 
-const { status, data } = await apiInstance.getOptionForInvestment(
-    optionId,
+const { status, data } = await apiInstance.deleteInvestment(
     investmentId
 );
 ```
@@ -613,13 +92,12 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
 | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
 
 
 ### Return type
 
-**OptionResponse**
+void (empty response body)
 
 ### Authorization
 
@@ -628,21 +106,21 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | The requested option |  -  |
-|**404** | Investment or option not found |  -  |
+|**204** | Investment successfully deleted |  -  |
+|**404** | Investment 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)
 
-# **getOptionKpis**
-> Array<OptionChartKPIsYearly> getOptionKpis()
+# **getInvestmentById**
+> InvestmentResponse getInvestmentById()
 
-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.
+Retrieve a single investment by its ID.
 
 ### Example
 
@@ -656,13 +134,9 @@ const configuration = new Configuration();
 const apiInstance = new InvestmentApi(configuration);
 
 let investmentId: string; //UUID of the investment (default to undefined)
-let optionId: string; //UUID of the option (default to undefined)
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
 
-const { status, data } = await apiInstance.getOptionKpis(
-    investmentId,
-    optionId,
-    valueFrameworkId
+const { status, data } = await apiInstance.getInvestmentById(
+    investmentId
 );
 ```
 
@@ -671,13 +145,11 @@ const { status, data } = await apiInstance.getOptionKpis(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
 
 
 ### Return type
 
-**Array<OptionChartKPIsYearly>**
+**InvestmentResponse**
 
 ### Authorization
 
@@ -692,15 +164,15 @@ const { status, data } = await apiInstance.getOptionKpis(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | The requested KPIs |  -  |
-|**404** | Investment, option, value framework, or phase not found |  -  |
+|**200** | The requested investment |  -  |
+|**404** | Investment 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)
 
-# **getOptionsForInvestment**
-> Array<OptionResponse> getOptionsForInvestment()
+# **getInvestments**
+> Array<InvestmentResponse> getInvestments()
 
-Retrieve a paginated list of all options for a specific investment.
+Retrieve a paginated list of all investments.
 
 ### Example
 
@@ -713,12 +185,10 @@ import {
 const configuration = new Configuration();
 const apiInstance = new InvestmentApi(configuration);
 
-let investmentId: string; //UUID of the investment (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)
 
-const { status, data } = await apiInstance.getOptionsForInvestment(
-    investmentId,
+const { status, data } = await apiInstance.getInvestments(
     offset,
     limit
 );
@@ -728,14 +198,13 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **investmentId** | [**string**] | UUID of the investment | 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|
 
 
 ### Return type
 
-**Array<OptionResponse>**
+**Array<InvestmentResponse>**
 
 ### Authorization
 
@@ -750,15 +219,14 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | List of options for the investment |  -  |
-|**404** | Investment not found |  -  |
+|**200** | List of investments |  -  |
 
 [[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)
 
-# **getOptionsOverview**
-> Array<OptionOverviewResponse> getOptionsOverview()
+# **getInvestmentsOverview**
+> Array<InvestmentOverviewResponse> getInvestmentsOverview()
 
-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.
+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.
 
 ### Example
 
@@ -771,11 +239,9 @@ import {
 const configuration = new Configuration();
 const apiInstance = new InvestmentApi(configuration);
 
-let investmentId: string; //UUID of the investment (default to undefined)
 let valueFrameworkId: string; //UUID of the value framework (default to undefined)
 
-const { status, data } = await apiInstance.getOptionsOverview(
-    investmentId,
+const { status, data } = await apiInstance.getInvestmentsOverview(
     valueFrameworkId
 );
 ```
@@ -784,65 +250,12 @@ const { status, data } = await apiInstance.getOptionsOverview(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
 | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
 
 
 ### Return type
 
-**Array<OptionOverviewResponse>**
-
-### 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 all options for the investment |  -  |
-|**404** | Investment 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)
-
-# **getPreferredOption**
-> PreferredOptionResponse getPreferredOption()
-
-Get the preferred option for an investment.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let investmentId: string; //UUID of the investment (default to undefined)
-
-const { status, data } = await apiInstance.getPreferredOption(
-    investmentId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**PreferredOptionResponse**
+**Array<InvestmentOverviewResponse>**
 
 ### Authorization
 
@@ -857,72 +270,8 @@ const { status, data } = await apiInstance.getPreferredOption(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Preferred option exists |  -  |
-|**204** | Investment exists but no options are associated |  -  |
-|**404** | Investment 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)
-
-# **patchImpactForOption**
-> ImpactAPIResponse patchImpactForOption(impactUpdate)
-
-Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration,
-    ImpactUpdate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let impactId: string; //UUID of the impact (default to undefined)
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (default to undefined)
-let impactUpdate: ImpactUpdate; //
-
-const { status, data } = await apiInstance.patchImpactForOption(
-    impactId,
-    optionId,
-    investmentId,
-    impactUpdate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **impactUpdate** | **ImpactUpdate**|  | |
-| **impactId** | [**string**] | UUID of the impact | defaults to undefined|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**ImpactAPIResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Impact updated successfully |  -  |
-|**400** | Validation or constraint error |  -  |
-|**404** | Investment, option, or impact not found |  -  |
+|**200** | Overview list of all investments |  -  |
+|**404** | 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)
 
@@ -983,66 +332,6 @@ const { status, data } = await apiInstance.patchInvestment(
 
 [[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)
 
-# **patchOptionForInvestment**
-> OptionResponse patchOptionForInvestment(optionUpdate)
-
-Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration,
-    OptionUpdate
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let optionId: string; //UUID of the option (default to undefined)
-let investmentId: string; //UUID of the investment (default to undefined)
-let optionUpdate: OptionUpdate; //
-
-const { status, data } = await apiInstance.patchOptionForInvestment(
-    optionId,
-    investmentId,
-    optionUpdate
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **optionUpdate** | **OptionUpdate**|  | |
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**OptionResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Option updated successfully |  -  |
-|**400** | Validation or constraint error |  -  |
-|**404** | Investment or option 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)
-
 # **postInvestment**
 > InvestmentResponse postInvestment(investmentCreate)
 
@@ -1096,60 +385,3 @@ const { status, data } = await apiInstance.postInvestment(
 
 [[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)
 
-# **setPreferredOption**
-> PreferredOptionResponse setPreferredOption(preferredOptionRequest)
-
-Set the preferred option for an investment.
-
-### Example
-
-```typescript
-import {
-    InvestmentApi,
-    Configuration,
-    PreferredOptionRequest
-} from '@cosmotech/aip-client';
-
-const configuration = new Configuration();
-const apiInstance = new InvestmentApi(configuration);
-
-let investmentId: string; //UUID of the investment (default to undefined)
-let preferredOptionRequest: PreferredOptionRequest; //
-
-const { status, data } = await apiInstance.setPreferredOption(
-    investmentId,
-    preferredOptionRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **preferredOptionRequest** | **PreferredOptionRequest**|  | |
-| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
-
-
-### Return type
-
-**PreferredOptionResponse**
-
-### Authorization
-
-[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Preferred option updated successfully |  -  |
-|**400** | Option does not belong to this investment |  -  |
-|**404** | Investment or option 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)
-