@cosmotech/aip-client 0.3.0-dev3 → 0.4.0-dev2

package/docs/PortfolioInvestmentApi.md

@@ -0,0 +1,350 @@
+# PortfolioInvestmentApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addInvestmentToPortfolio**](#addinvestmenttoportfolio) | **POST** /portfolio/{portfolio_id}/investment/{investment_id} | Add an investment to this portfolio|
+|[**bulkAddInvestmentsToPortfolio**](#bulkaddinvestmentstoportfolio) | **POST** /portfolio/{portfolio_id}/investment/bulk | Bulk add investments to this portfolio|
+|[**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|
+|[**removeInvestmentFromPortfolio**](#removeinvestmentfromportfolio) | **DELETE** /portfolio/{portfolio_id}/investment/{investment_id} | Remove an investment from this portfolio|
+
+# **addInvestmentToPortfolio**
+> PortfolioInvestmentResponse addInvestmentToPortfolio()
+
+Link an investment to this portfolio.
+
+### 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 investmentId: string; //UUID of the investment (default to undefined)
+
+const { status, data } = await apiInstance.addInvestmentToPortfolio(
+    portfolioId,
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**PortfolioInvestmentResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Investment added to portfolio successfully |  -  |
+|**404** | Portfolio or investment not found |  -  |
+|**409** | Investment already linked to this portfolio |  -  |
+
+[[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)
+
+# **bulkAddInvestmentsToPortfolio**
+> PortfolioInvestmentBulkAddResponse bulkAddInvestmentsToPortfolio(portfolioInvestmentBulkAddRequest)
+
+Add multiple investments to the portfolio in one request. Already-linked investments are skipped.
+
+### Example
+
+```typescript
+import {
+    PortfolioInvestmentApi,
+    Configuration,
+    PortfolioInvestmentBulkAddRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioInvestmentApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let portfolioInvestmentBulkAddRequest: PortfolioInvestmentBulkAddRequest; //
+
+const { status, data } = await apiInstance.bulkAddInvestmentsToPortfolio(
+    portfolioId,
+    portfolioInvestmentBulkAddRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioInvestmentBulkAddRequest** | **PortfolioInvestmentBulkAddRequest**|  | |
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PortfolioInvestmentBulkAddResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Bulk add result |  -  |
+|**400** | One or more investment IDs not found |  -  |
+|**404** | Portfolio 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)
+
+# **bulkRemoveInvestmentsFromPortfolio**
+> bulkRemoveInvestmentsFromPortfolio(portfolioInvestmentBulkDeleteRequest)
+
+Remove multiple investments from the portfolio in one request. All provided IDs must be linked to this portfolio — if any ID is not found, the request fails with 404 and no links are removed.
+
+### Example
+
+```typescript
+import {
+    PortfolioInvestmentApi,
+    Configuration,
+    PortfolioInvestmentBulkDeleteRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioInvestmentApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let portfolioInvestmentBulkDeleteRequest: PortfolioInvestmentBulkDeleteRequest; //
+
+const { status, data } = await apiInstance.bulkRemoveInvestmentsFromPortfolio(
+    portfolioId,
+    portfolioInvestmentBulkDeleteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioInvestmentBulkDeleteRequest** | **PortfolioInvestmentBulkDeleteRequest**|  | |
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | All investments removed successfully |  -  |
+|**404** | Portfolio not found or one or more investment links 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)
+
+# **getInvestmentForPortfolio**
+> PortfolioInvestmentResponse getInvestmentForPortfolio()
+
+Retrieve a specific investment link within this portfolio.
+
+### 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 investmentId: string; //UUID of the investment (default to undefined)
+
+const { status, data } = await apiInstance.getInvestmentForPortfolio(
+    portfolioId,
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**PortfolioInvestmentResponse**
+
+### 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 portfolio-investment link |  -  |
+|**404** | Portfolio, investment, or link 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)
+
+# **getInvestmentsForPortfolio**
+> Array<PortfolioInvestmentResponse> getInvestmentsForPortfolio()
+
+Retrieve a paginated list of all investment links for a specific portfolio.
+
+### 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 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.getInvestmentsForPortfolio(
+    portfolioId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | 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<PortfolioInvestmentResponse>**
+
+### 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 investment links for the portfolio |  -  |
+|**404** | Portfolio 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()
+
+Remove an investment from this portfolio by deleting the link.
+
+### 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 investmentId: string; //UUID of the investment (default to undefined)
+
+const { status, data } = await apiInstance.removeInvestmentFromPortfolio(
+    portfolioId,
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | 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** | Investment removed from portfolio successfully |  -  |
+|**404** | Portfolio, investment, or link 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)
+

package/docs/PortfolioInvestmentBulkAddRequest.md

@@ -0,0 +1,21 @@
+# PortfolioInvestmentBulkAddRequest
+
+Request body for adding multiple investments to a portfolio at once.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**investmentIds** | **Array<string>** | List of investment IDs to add (must be non-empty) | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioInvestmentBulkAddRequest } from '@cosmotech/aip-client';
+
+const instance: PortfolioInvestmentBulkAddRequest = {
+    investmentIds,
+};
+```
+
+[[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/PortfolioInvestmentBulkAddResponse.md

@@ -0,0 +1,23 @@
+# PortfolioInvestmentBulkAddResponse
+
+Response for bulk-add investments: reports added vs already-present links.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**added** | **Array<string>** | Investment IDs that were newly linked to the portfolio | [default to undefined]
+**alreadyPresent** | **Array<string>** | Investment IDs that were already in the portfolio (skipped) | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioInvestmentBulkAddResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioInvestmentBulkAddResponse = {
+    added,
+    alreadyPresent,
+};
+```
+
+[[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/PortfolioInvestmentBulkDeleteRequest.md

@@ -0,0 +1,21 @@
+# PortfolioInvestmentBulkDeleteRequest
+
+Request body for removing multiple investments from a portfolio at once.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | List of investment IDs to remove (must be non-empty) | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioInvestmentBulkDeleteRequest } from '@cosmotech/aip-client';
+
+const instance: PortfolioInvestmentBulkDeleteRequest = {
+    ids,
+};
+```
+
+[[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/PortfolioInvestmentResponse.md

@@ -0,0 +1,25 @@
+# PortfolioInvestmentResponse
+
+Schema for PortfolioInvestment responses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**investmentId** | **string** | ID of the investment | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**portfolioId** | **string** | ID of the portfolio | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioInvestmentResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioInvestmentResponse = {
+    investmentId,
+    ownerName,
+    portfolioId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)