@cosmotech/aip-client 0.4.0-dev4 → 1.0.0-dev1

package/dist/models/scenario-status.js

@@ -0,0 +1,23 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 1.0.0-dev1
+ *
+ *
+ * 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 });
+exports.ScenarioStatus = void 0;
+exports.ScenarioStatus = {
+    NOT_RUN: 'not_run',
+    RUNNING: 'running',
+    COMPLETED: 'completed',
+    FAILED: 'failed',
+    ABORTED: 'aborted'
+};

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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * 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.4.0-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/BudgetApi.md

@@ -7,12 +7,12 @@ All URIs are relative to *http://localhost*
 |[**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/{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|
+|[**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|
 |[**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|
+|[**listAvailableOptions**](#listavailableoptions) | **GET** /budget/list-available-options | 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|
 
@@ -190,7 +190,7 @@ const configuration = new Configuration();
 const apiInstance = new BudgetApi(configuration);
 
 let budgetId: string; //UUID of the budget (default to undefined)
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getBudgetInvestments(
     budgetId,
@@ -203,7 +203,7 @@ const { status, data } = await apiInstance.getBudgetInvestments(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -224,7 +224,7 @@ const { status, data } = await apiInstance.getBudgetInvestments(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Investments linked to this budget |  -  |
-|**404** | Budget or value framework not found |  -  |
+|**404** | Budget not found, or value framework not found (when value_framework_id is provided but invalid) |  -  |
 
 [[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)
 
@@ -245,7 +245,7 @@ const configuration = new Configuration();
 const apiInstance = new BudgetApi(configuration);
 
 let budgetId: string; //UUID of the budget (default to undefined)
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getBudgetOptions(
     budgetId,
@@ -258,7 +258,7 @@ const { status, data } = await apiInstance.getBudgetOptions(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -279,7 +279,7 @@ const { status, data } = await apiInstance.getBudgetOptions(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Options linked to this budget |  -  |
-|**404** | Budget or value framework not found |  -  |
+|**404** | Budget not found, or value framework not found (when value_framework_id is provided but invalid) |  -  |
 
 [[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)
 
@@ -449,7 +449,7 @@ const { status, data } = await apiInstance.linkOptionsToBudget(
 # **listAvailableOptions**
 > Array<BudgetOptionResponse> listAvailableOptions()
 
-Returns a list of all options, with their investment context and NPV.
+Returns a list of all options, with their investment context and NPV. If value_framework_id is omitted, NPV will be null for all options.
 
 ### Example
 
@@ -462,7 +462,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BudgetApi(configuration);
 
-let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listAvailableOptions(
     valueFrameworkId
@@ -473,7 +473,7 @@ const { status, data } = await apiInstance.listAvailableOptions(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type
@@ -494,6 +494,7 @@ const { status, data } = await apiInstance.listAvailableOptions(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | List of all option objects |  -  |
+|**404** | Value framework not found (when value_framework_id is provided but invalid) |  -  |
 
 [[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/MonetizedImpactMetricValue.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **metricId** | **string** |  | [default to undefined]
 **metricName** | **string** |  | [default to undefined]
+**metricValue** | **number** |  | [default to undefined]
 **monetaryValue** | **number** |  | [default to undefined]
 
 ## Example
@@ -18,6 +19,7 @@ import { MonetizedImpactMetricValue } from '@cosmotech/aip-client';
 const instance: MonetizedImpactMetricValue = {
     metricId,
     metricName,
+    metricValue,
     monetaryValue,
 };
 ```

package/docs/OptionApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *http://localhost*
 |[**createOptionForInvestment**](#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment|
 |[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
 |[**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|
+|[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis | 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|
 |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
@@ -182,7 +182,7 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 # **getOptionKpis**
 > Array<OptionChartKPIsYearly> getOptionKpis()
 
-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.
+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. If no value_framework_id is provided, returns an empty list.
 
 ### Example
 
@@ -197,7 +197,7 @@ 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 valueFrameworkId: string; //UUID of the value framework (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getOptionKpis(
     optionId,
@@ -212,7 +212,7 @@ const { status, data } = await apiInstance.getOptionKpis(
 |------------- | ------------- | ------------- | -------------|
 | **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|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
 
 
 ### Return type