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

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

@@ -0,0 +1,25 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for Portfolio responses (includes all fields)
+ */
+export interface PortfolioResponse {
+    'created_at': string;
+    'description'?: string | null;
+    'id': string;
+    /**
+     * Name of the portfolio
+     */
+    'name': string;
+    'owner_name'?: string | null;
+    'updated_at': string;
+}

package/dist/models/portfolio-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,18 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for partially updating a Portfolio. Only provided fields will be updated.
+ */
+export interface PortfolioUpdate {
+    'description'?: string | null;
+    'name'?: string | null;
+}

package/dist/models/portfolio-update.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

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

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

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

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

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

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

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

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

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

package/dist/models/validation-error.js

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

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

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

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

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

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

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

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

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

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

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

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

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

package/docs/BudgetApi.md

@@ -4,21 +4,22 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**bulkDeleteBudgets**](#bulkdeletebudgets) | **DELETE** /budget/bulk | Bulk delete budgets|
+|[**bulkDeleteBudgets**](#bulkdeletebudgets) | **POST** /budget/bulk-delete | Bulk delete budgets|
 |[**deleteBudget**](#deletebudget) | **DELETE** /budget/{budget_id} | Delete a budget|
 |[**getBudgetById**](#getbudgetbyid) | **GET** /budget/{budget_id} | Get a budget by ID|
-|[**getBudgetInvestments**](#getbudgetinvestments) | **GET** /budget/{budget_id}/investments | List investments linked to this budget via options|
-|[**getBudgetOptions**](#getbudgetoptions) | **GET** /budget/{budget_id}/options | List options linked to this budget|
+|[**getBudgetInvestments**](#getbudgetinvestments) | **GET** /budget/{budget_id}/investments/{value_framework_id} | List investments linked to this budget via options|
+|[**getBudgetOptions**](#getbudgetoptions) | **GET** /budget/{budget_id}/options/{value_framework_id} | List options linked to this budget|
 |[**getBudgetOverview**](#getbudgetoverview) | **GET** /budget/{budget_id}/overview | Get budget overview|
 |[**getBudgets**](#getbudgets) | **GET** /budget/ | List all budgets|
 |[**linkOptionsToBudget**](#linkoptionstobudget) | **POST** /budget/{budget_id}/link-options | Bulk-link options to this budget|
+|[**listAvailableOptions**](#listavailableoptions) | **GET** /budget/list-available-options/{value_framework_id} | List all options available to be added to a budget|
 |[**patchBudget**](#patchbudget) | **PATCH** /budget/{budget_id} | Partially update a budget|
 |[**postBudget**](#postbudget) | **POST** /budget/ | Create a budget|
 
 # **bulkDeleteBudgets**
 > bulkDeleteBudgets(budgetBulkDeleteRequest)
 
-Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+Delete multiple budgets 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 budgets are deleted. Options linked to deleted budgets will have their budget link removed (set to null).
 
 ### Example
 
@@ -63,8 +64,8 @@ void (empty response body)
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**204** | Budgets successfully deleted |  -  |
-|**400** | Invalid request body |  -  |
+|**204** | All budgets successfully deleted |  -  |
+|**404** | One or more budget 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)
 
@@ -445,6 +446,57 @@ const { status, data } = await apiInstance.linkOptionsToBudget(
 
 [[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)
 
+# **listAvailableOptions**
+> Array<BudgetOptionResponse> listAvailableOptions()
+
+Returns a list of all options, with their investment context and NPV.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.listAvailableOptions(
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<BudgetOptionResponse>**
+
+### 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 all option objects |  -  |
+
+[[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)
+
 # **patchBudget**
 > BudgetResponse patchBudget(budgetUpdate)
 

package/docs/BudgetBulkDeleteRequest.md

@@ -6,7 +6,7 @@ Request body for bulk-deleting budgets.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**budgetIds** | **Array<string>** | List of budget IDs to delete | [default to undefined]
+**ids** | **Array<string>** | List of budget IDs to delete (must be non-empty) | [default to undefined]
 
 ## Example
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 import { BudgetBulkDeleteRequest } from '@cosmotech/aip-client';
 
 const instance: BudgetBulkDeleteRequest = {
-    budgetIds,
+    ids,
 };
 ```
 

package/docs/ImpactAPIResponse.md

@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **evolutionType** | [**EvolutionType**](EvolutionType.md) |  | [default to undefined]
 **id** | **string** |  | [default to undefined]
 **metricId** | **string** | ID of the associated metric | [default to undefined]
-**name** | **string** |  | [default to undefined]
 **optionId** | **string** | ID of the associated option | [default to undefined]
 **ownerName** | **string** |  | [optional] [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
@@ -29,7 +28,6 @@ const instance: ImpactAPIResponse = {
     evolutionType,
     id,
     metricId,
-    name,
     optionId,
     ownerName,
     updatedAt,

package/docs/ImpactBulkItem.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **evolutionRate** | **number** | Rate of evolution over time | [optional] [default to 0.0]
 **evolutionType** | [**EvolutionType**](EvolutionType.md) | Type of evolution | [optional] [default to undefined]
 **metricId** | **string** | ID of the associated metric | [default to undefined]
-**name** | **string** | Name of the impact | [default to undefined]
 
 ## Example
 
@@ -22,7 +21,6 @@ const instance: ImpactBulkItem = {
     evolutionRate,
     evolutionType,
     metricId,
-    name,
 };
 ```
 

package/docs/ImpactCreate.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **evolutionRate** | **number** | Rate of evolution over time | [optional] [default to 0.0]
 **evolutionType** | [**EvolutionType**](EvolutionType.md) | Type of evolution | [optional] [default to undefined]
 **metricId** | **string** | ID of the associated metric | [default to undefined]
-**name** | **string** | Name of the impact | [default to undefined]
 
 ## Example
 
@@ -22,7 +21,6 @@ const instance: ImpactCreate = {
     evolutionRate,
     evolutionType,
     metricId,
-    name,
 };
 ```
 

package/docs/ImpactUpdate.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **evolutionRate** | **number** |  | [optional] [default to undefined]
 **evolutionType** | [**EvolutionType**](EvolutionType.md) |  | [optional] [default to undefined]
 **metricId** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -22,7 +21,6 @@ const instance: ImpactUpdate = {
     evolutionRate,
     evolutionType,
     metricId,
-    name,
 };
 ```
 

package/docs/MetricPerformanceResponse.md

@@ -0,0 +1,27 @@
+# MetricPerformanceResponse
+
+Response for the portfolio metric performance over time endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<MetricPerformanceYear>**](MetricPerformanceYear.md) |  | [default to undefined]
+**metricId** | **string** |  | [default to undefined]
+**metricName** | **string** |  | [default to undefined]
+**unit** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MetricPerformanceResponse } from '@cosmotech/aip-client';
+
+const instance: MetricPerformanceResponse = {
+    data,
+    metricId,
+    metricName,
+    unit,
+};
+```
+
+[[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/MetricPerformanceYear.md

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

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

package/docs/MonetizedImpactYear.md

@@ -0,0 +1,25 @@
+# MonetizedImpactYear
+
+Monetized impact (benefit) and investment cost for one year.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**investmentCost** | **number** |  | [default to undefined]
+**monetizedImpact** | **number** |  | [default to undefined]
+**year** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MonetizedImpactYear } from '@cosmotech/aip-client';
+
+const instance: MonetizedImpactYear = {
+    investmentCost,
+    monetizedImpact,
+    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/OptionApi.md

@@ -85,12 +85,12 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OptionApi(configuration);
 
-let optionId: string; //UUID of the option (default to undefined)
 let investmentId: string; //UUID of the investment (default to undefined)
+let optionId: string; //UUID of the option (default to undefined)
 
 const { status, data } = await apiInstance.deleteOptionForInvestment(
-    optionId,
-    investmentId
+    investmentId,
+    optionId
 );
 ```
 
@@ -98,8 +98,8 @@ const { status, data } = await apiInstance.deleteOptionForInvestment(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **optionId** | [**string**] | UUID of the option | defaults to undefined|
 | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
 
 
 ### Return type
@@ -195,13 +195,13 @@ import {
 const configuration = new Configuration();
 const apiInstance = new OptionApi(configuration);
 
-let investmentId: string; //UUID of the investment (default to undefined)
 let optionId: string; //UUID of the option (default to undefined)
+let investmentId: string; //UUID of the investment (default to undefined)
 let valueFrameworkId: string; //UUID of the value framework (default to undefined)
 
 const { status, data } = await apiInstance.getOptionKpis(
-    investmentId,
     optionId,
+    investmentId,
     valueFrameworkId
 );
 ```
@@ -210,8 +210,8 @@ 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|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
 | **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|