@cosmotech/aip-client 0.2.0-dev6 → 0.3.0-dev1

package/docs/BudgetOverviewResponse.md

@@ -0,0 +1,25 @@
+# BudgetOverviewResponse
+
+Schema for the budget overview — aggregated counts and capacity.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annualBudgetCapacity** | **number** |  | [optional] [default to undefined]
+**numInvestments** | **number** | Number of investments that have at least one option linked to this budget. | [default to undefined]
+**numOptions** | **number** | Number of options linked to this budget. | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: BudgetOverviewResponse = {
+    annualBudgetCapacity,
+    numInvestments,
+    numOptions,
+};
+```
+
+[[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/BudgetResponse.md

@@ -0,0 +1,33 @@
+# BudgetResponse
+
+Schema for Budget responses (includes all fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annualBudgetCapacity** | **number** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** | Name of the budget | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetResponse } from '@cosmotech/aip-client';
+
+const instance: BudgetResponse = {
+    annualBudgetCapacity,
+    createdAt,
+    description,
+    id,
+    name,
+    ownerName,
+    updatedAt,
+};
+```
+
+[[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/BudgetUpdate.md

@@ -0,0 +1,25 @@
+# BudgetUpdate
+
+Schema for partially updating a Budget. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annualBudgetCapacity** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetUpdate } from '@cosmotech/aip-client';
+
+const instance: BudgetUpdate = {
+    annualBudgetCapacity,
+    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)

package/docs/InvestmentApi.md

@@ -13,9 +13,11 @@ All URIs are relative to *http://localhost*
 |[**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|
+|[**getInvestmentsOverview**](#getinvestmentsoverview) | **GET** /investment/overview | Investment overview table|
 |[**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|
 |[**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|
 |[**getPreferredOption**](#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an 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|
@@ -530,6 +532,58 @@ const { status, data } = await apiInstance.getInvestments(
 
 [[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)
 
+# **getInvestmentsOverview**
+> Array<InvestmentOverviewResponse> getInvestmentsOverview()
+
+Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getInvestmentsOverview(
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<InvestmentOverviewResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Overview list of all investments |  -  |
+|**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)
+
 # **getOptionForInvestment**
 > OptionResponse getOptionForInvestment()
 
@@ -588,7 +642,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
+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.
 
 ### Example
 
@@ -639,7 +693,7 @@ const { status, data } = await apiInstance.getOptionKpis(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | The requested KPIs |  -  |
-|**404** | Investment, option or value framework not found |  -  |
+|**404** | Investment, option, value framework, or phase 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)
 
@@ -701,6 +755,61 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
 
 [[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)
 
+# **getOptionsOverview**
+> Array<OptionOverviewResponse> getOptionsOverview()
+
+Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+
+### 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 valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getOptionsOverview(
+    investmentId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<OptionOverviewResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Overview list of all options for the investment |  -  |
+|**404** | Investment or 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)
+
 # **getPreferredOption**
 > PreferredOptionResponse getPreferredOption()
 

package/docs/InvestmentOverviewResponse.md

@@ -0,0 +1,33 @@
+# InvestmentOverviewResponse
+
+Schema for the investment overview table — one row per investment.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**investmentId** | **string** | ID of the investment | [default to undefined]
+**investmentName** | **string** | Name of the investment | [default to undefined]
+**preferredOptionCost** | **number** |  | [optional] [default to undefined]
+**preferredOptionDuration** | **number** |  | [optional] [default to undefined]
+**preferredOptionName** | **string** |  | [optional] [default to undefined]
+**preferredOptionNpv** | **number** |  | [optional] [default to undefined]
+**preferredOptionStartDate** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvestmentOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: InvestmentOverviewResponse = {
+    investmentId,
+    investmentName,
+    preferredOptionCost,
+    preferredOptionDuration,
+    preferredOptionName,
+    preferredOptionNpv,
+    preferredOptionStartDate,
+};
+```
+
+[[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

@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost*
 |[**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|
 |[**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|
 |[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
 |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
 
@@ -423,7 +424,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
+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.
 
 ### Example
 
@@ -474,7 +475,7 @@ const { status, data } = await apiInstance.getOptionKpis(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | The requested KPIs |  -  |
-|**404** | Investment, option or value framework not found |  -  |
+|**404** | Investment, option, value framework, or phase 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)
 
@@ -536,6 +537,61 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
 
 [[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)
 
+# **getOptionsOverview**
+> Array<OptionOverviewResponse> getOptionsOverview()
+
+Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+
+### Example
+
+```typescript
+import {
+    OptionApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new OptionApi(configuration);
+
+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.getOptionsOverview(
+    investmentId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<OptionOverviewResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Overview list of all options for the investment |  -  |
+|**404** | Investment or 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)
+
 # **patchImpactForOption**
 > ImpactAPIResponse patchImpactForOption(impactUpdate)
 

package/docs/OptionCreate.md

@@ -6,6 +6,7 @@ Schema for creating a new Option (excludes auto-generated fields)
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** | Cost of the option | [optional] [default to 0.0]
 **description** | **string** |  | [optional] [default to undefined]
 **duration** | **number** | Duration of the option in weeks | [optional] [default to 1]
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
 import { OptionCreate } from '@cosmotech/aip-client';
 
 const instance: OptionCreate = {
+    budgetId,
     cost,
     description,
     duration,

package/docs/OptionOverviewResponse.md

@@ -0,0 +1,33 @@
+# OptionOverviewResponse
+
+Schema for the option overview table — one row per option within an investment.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetName** | **string** |  | [optional] [default to undefined]
+**cost** | **number** | Cost of the option | [default to undefined]
+**duration** | **number** | Duration of the option in weeks | [default to undefined]
+**npv** | **number** |  | [optional] [default to undefined]
+**optionId** | **string** | ID of the option | [default to undefined]
+**optionName** | **string** | Name of the option | [default to undefined]
+**startDate** | **string** | Expected start date of the option (ISO 8601) | [default to undefined]
+
+## Example
+
+```typescript
+import { OptionOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: OptionOverviewResponse = {
+    budgetName,
+    cost,
+    duration,
+    npv,
+    optionId,
+    optionName,
+    startDate,
+};
+```
+
+[[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/OptionResponse.md

@@ -6,6 +6,7 @@ Schema for Option responses (includes all fields)
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
@@ -23,6 +24,7 @@ Name | Type | Description | Notes
 import { OptionResponse } from '@cosmotech/aip-client';
 
 const instance: OptionResponse = {
+    budgetId,
     cost,
     createdAt,
     description,

package/docs/OptionUpdate.md

@@ -6,6 +6,7 @@ Schema for partially updating an Option. Only provided fields will be updated.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **duration** | **number** |  | [optional] [default to undefined]
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
 import { OptionUpdate } from '@cosmotech/aip-client';
 
 const instance: OptionUpdate = {
+    budgetId,
     cost,
     description,
     duration,

package/index.ts

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

package/models/budget-bulk-delete-request.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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.
+ */
+
+
+
+/**
+ * Request body for bulk-deleting budgets.
+ */
+export interface BudgetBulkDeleteRequest {
+    /**
+     * List of budget IDs to delete
+     */
+    'budget_ids': Array<string>;
+}
+

package/models/budget-create.ts

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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.
+ */
+
+
+
+/**
+ * Schema for creating a new Budget (excludes auto-generated fields)
+ */
+export interface BudgetCreate {
+    'annual_budget_capacity'?: number | null;
+    'description'?: string | null;
+    /**
+     * Name of the budget
+     */
+    'name': string;
+}
+

package/models/budget-investment-response.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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.
+ */
+
+
+
+/**
+ * Schema for one row in the \'Investments with options using budget\' tab.
+ */
+export interface BudgetInvestmentResponse {
+    'cost'?: number | null;
+    'duration'?: number | null;
+    'investment_description'?: string | null;
+    /**
+     * ID of the investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the investment
+     */
+    'investment_name': string;
+    'npv'?: number | null;
+    /**
+     * True if the preferred option is the one linked to this budget. False triggers a warning: preferred option is NOT the budget-linked one.
+     */
+    'preferred_option_linked_to_budget': boolean;
+    'preferred_option_name'?: string | null;
+    'start_date'?: string | null;
+}
+

package/models/budget-link-options-request.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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.
+ */
+
+
+
+/**
+ * Request body for bulk-linking options to a budget.
+ */
+export interface BudgetLinkOptionsRequest {
+    /**
+     * List of option IDs to link to this budget
+     */
+    'option_ids': Array<string>;
+}
+

package/models/budget-option-response.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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.
+ */
+
+
+
+/**
+ * Schema for one row in the \'Options using budget\' tab on the budget detail page.
+ */
+export interface BudgetOptionResponse {
+    /**
+     * Total investment cost of the option
+     */
+    'cost': number;
+    /**
+     * Total duration of the option in weeks
+     */
+    'duration': number;
+    /**
+     * ID of the parent investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the parent investment
+     */
+    'investment_name': string;
+    /**
+     * True if this option is the preferred option of its investment
+     */
+    'is_preferred': boolean;
+    'npv'?: number | null;
+    'option_description'?: string | null;
+    /**
+     * ID of the option
+     */
+    'option_id': string;
+    /**
+     * Name of the option
+     */
+    'option_name': string;
+    /**
+     * Expected start date of the option (ISO 8601)
+     */
+    'start_date': string;
+}
+

package/models/budget-overview-response.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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.
+ */
+
+
+
+/**
+ * Schema for the budget overview — aggregated counts and capacity.
+ */
+export interface BudgetOverviewResponse {
+    'annual_budget_capacity'?: number | null;
+    /**
+     * Number of investments that have at least one option linked to this budget.
+     */
+    'num_investments': number;
+    /**
+     * Number of options linked to this budget.
+     */
+    'num_options': number;
+}
+