@cosmotech/aip-client 0.2.0-dev2 → 0.2.0-dev4

package/docs/InvestmentApi.md

@@ -0,0 +1,987 @@
+# InvestmentApi
+
+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|
+|[**deleteInvestment**](#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment|
+|[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
+|[**getFavoredOption**](#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an 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|
+|[**getOptionForInvestment**](#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment|
+|[**getOptionsForInvestment**](#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this 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|
+|[**setFavoredOption**](#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment|
+
+# **createImpactForOption**
+> ImpactAPIResponse createImpactForOption(impactCreate)
+
+Create a new impact under this option.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration,
+    ImpactCreate
+} 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)
+
+# **getFavoredOption**
+> FavoredOptionResponse getFavoredOption()
+
+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.getFavoredOption(
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**FavoredOptionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### 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)
+
+# **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)
+
+# **getOptionForInvestment**
+> OptionResponse getOptionForInvestment()
+
+Retrieve a specific option for the investment.
+
+### 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.getOptionForInvestment(
+    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
+
+**OptionResponse**
+
+### 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 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)
+
+# **getOptionsForInvestment**
+> Array<OptionResponse> getOptionsForInvestment()
+
+Retrieve a paginated list of all options for a specific 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)
+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,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|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>**
+
+### 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 options for the 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)
+
+# **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 |  -  |
+
+[[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)
+
+# **patchInvestment**
+> InvestmentResponse patchInvestment(investmentUpdate)
+
+Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration,
+    InvestmentUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let investmentId: string; //UUID of the investment (default to undefined)
+let investmentUpdate: InvestmentUpdate; //
+
+const { status, data } = await apiInstance.patchInvestment(
+    investmentId,
+    investmentUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentUpdate** | **InvestmentUpdate**|  | |
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**InvestmentResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Investment updated successfully |  -  |
+|**400** | Validation or constraint error |  -  |
+|**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)
+
+# **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)
+
+Create a new investment.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration,
+    InvestmentCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let investmentCreate: InvestmentCreate; //
+
+const { status, data } = await apiInstance.postInvestment(
+    investmentCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentCreate** | **InvestmentCreate**|  | |
+
+
+### Return type
+
+**InvestmentResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Investment created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+
+[[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)
+
+# **setFavoredOption**
+> FavoredOptionResponse setFavoredOption(favoredOptionRequest)
+
+Set the preferred option for an investment.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration,
+    FavoredOptionRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let investmentId: string; //UUID of the investment (default to undefined)
+let favoredOptionRequest: FavoredOptionRequest; //
+
+const { status, data } = await apiInstance.setFavoredOption(
+    investmentId,
+    favoredOptionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **favoredOptionRequest** | **FavoredOptionRequest**|  | |
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**FavoredOptionResponse**
+
+### 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)
+