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

package/docs/PortfolioApi.md

@@ -0,0 +1,395 @@
+# PortfolioApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**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|
+|[**getPortfolios**](#getportfolios) | **GET** /portfolio/ | List portfolios|
+|[**patchPortfolio**](#patchportfolio) | **PATCH** /portfolio/{portfolio_id} | Partially update a portfolio|
+|[**postPortfolio**](#postportfolio) | **POST** /portfolio/ | Create a portfolio|
+
+# **bulkDeletePortfolios**
+> bulkDeletePortfolios(portfolioBulkDeleteRequest)
+
+Delete multiple portfolios 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 portfolios are deleted. Associated portfolio-investment links are also deleted via cascade.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration,
+    PortfolioBulkDeleteRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioApi(configuration);
+
+let portfolioBulkDeleteRequest: PortfolioBulkDeleteRequest; //
+
+const { status, data } = await apiInstance.bulkDeletePortfolios(
+    portfolioBulkDeleteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioBulkDeleteRequest** | **PortfolioBulkDeleteRequest**|  | |
+
+
+### 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 portfolios successfully deleted |  -  |
+|**404** | One or more portfolio 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)
+
+# **deletePortfolio**
+> deletePortfolio()
+
+Delete an existing portfolio by its ID. Associated portfolio-investment links are also deleted via cascade.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.deletePortfolio(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Portfolio successfully deleted |  -  |
+|**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)
+
+# **getPortfolioById**
+> PortfolioResponse getPortfolioById()
+
+Retrieve a single portfolio by its ID.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioById(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PortfolioResponse**
+
+### 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 |  -  |
+|**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)
+
+# **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.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+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)
+
+const { status, data } = await apiInstance.getPortfolioOverview(
+    valueFrameworkId,
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|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|
+
+
+### Return type
+
+**Array<PortfolioOverviewItemResponse>**
+
+### 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 portfolios with KPIs |  -  |
+|**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)
+
+# **getPortfolios**
+> Array<PortfolioResponse> getPortfolios()
+
+Retrieve a paginated list of all portfolios.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioApi(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.getPortfolios(
+    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<PortfolioResponse>**
+
+### 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 portfolios |  -  |
+
+[[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)
+
+# **patchPortfolio**
+> PortfolioResponse patchPortfolio(portfolioUpdate)
+
+Update one or more fields of an existing portfolio. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration,
+    PortfolioUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let portfolioUpdate: PortfolioUpdate; //
+
+const { status, data } = await apiInstance.patchPortfolio(
+    portfolioId,
+    portfolioUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioUpdate** | **PortfolioUpdate**|  | |
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PortfolioResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Portfolio updated successfully |  -  |
+|**400** | Validation or constraint error |  -  |
+|**404** | Portfolio not found |  -  |
+|**409** | Portfolio with this name already exists |  -  |
+
+[[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)
+
+# **postPortfolio**
+> PortfolioResponse postPortfolio(portfolioCreate)
+
+Create a new portfolio.
+
+### Example
+
+```typescript
+import {
+    PortfolioApi,
+    Configuration,
+    PortfolioCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioApi(configuration);
+
+let portfolioCreate: PortfolioCreate; //
+
+const { status, data } = await apiInstance.postPortfolio(
+    portfolioCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioCreate** | **PortfolioCreate**|  | |
+
+
+### Return type
+
+**PortfolioResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Portfolio created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+|**409** | Portfolio with this name already exists |  -  |
+
+[[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/PortfolioBudgetExpenditureResponse.md

@@ -0,0 +1,27 @@
+# PortfolioBudgetExpenditureResponse
+
+Response for the budget expenditure over time endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [default to undefined]
+**budgetName** | **string** |  | [default to undefined]
+**expenditure** | [**Array<PortfolioBudgetExpenditureYear>**](PortfolioBudgetExpenditureYear.md) |  | [default to undefined]
+**maxCapacity** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioBudgetExpenditureResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioBudgetExpenditureResponse = {
+    budgetId,
+    budgetName,
+    expenditure,
+    maxCapacity,
+};
+```
+
+[[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/PortfolioBudgetExpenditureYear.md

@@ -0,0 +1,23 @@
+# PortfolioBudgetExpenditureYear
+
+Expenditure amount for one year.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** |  | [default to undefined]
+**year** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioBudgetExpenditureYear } from '@cosmotech/aip-client';
+
+const instance: PortfolioBudgetExpenditureYear = {
+    amount,
+    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/PortfolioBudgetUsageItem.md

@@ -0,0 +1,31 @@
+# PortfolioBudgetUsageItem
+
+One row in the portfolio Budget Usage table.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [default to undefined]
+**budgetName** | **string** |  | [default to undefined]
+**firstOverrunYear** | **number** |  | [optional] [default to undefined]
+**nbOptions** | **number** | Number of preferred options in the portfolio linked to this budget | [default to undefined]
+**nbOverruns** | **number** |  | [default to undefined]
+**status** | **string** | \'Within\' or \'Exceeded\' | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioBudgetUsageItem } from '@cosmotech/aip-client';
+
+const instance: PortfolioBudgetUsageItem = {
+    budgetId,
+    budgetName,
+    firstOverrunYear,
+    nbOptions,
+    nbOverruns,
+    status,
+};
+```
+
+[[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/PortfolioBulkDeleteRequest.md

@@ -0,0 +1,21 @@
+# PortfolioBulkDeleteRequest
+
+Request body for bulk-deleting portfolios by their IDs.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | List of portfolio IDs to delete (must be non-empty) | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioBulkDeleteRequest } from '@cosmotech/aip-client';
+
+const instance: PortfolioBulkDeleteRequest = {
+    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/PortfolioCreate.md

@@ -0,0 +1,23 @@
+# PortfolioCreate
+
+Schema for creating a new Portfolio (excludes auto-generated fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** | Name of the portfolio | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioCreate } from '@cosmotech/aip-client';
+
+const instance: PortfolioCreate = {
+    description,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)