@cosmotech/aip-client 0.2.0-dev6 → 0.2.0-dev7

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/OptionOverviewResponse.md

@@ -0,0 +1,31 @@
+# OptionOverviewResponse
+
+Schema for the option overview table — one row per option within an investment.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 = {
+    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/models/index.ts

@@ -4,6 +4,7 @@ export * from './impact-apiresponse';
 export * from './impact-create';
 export * from './impact-update';
 export * from './investment-create';
+export * from './investment-overview-response';
 export * from './investment-response';
 export * from './investment-update';
 export * from './location-inner';
@@ -24,6 +25,7 @@ export * from './objective-weight-update';
 export * from './option-chart-kpi';
 export * from './option-chart-kpis-yearly';
 export * from './option-create';
+export * from './option-overview-response';
 export * from './option-response';
 export * from './option-update';
 export * from './preferred-option-request';

package/models/investment-overview-response.ts

@@ -0,0 +1,35 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ * 
+ *
+ * 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 investment overview table — one row per investment.
+ */
+export interface InvestmentOverviewResponse {
+    /**
+     * ID of the investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the investment
+     */
+    'investment_name': string;
+    'preferred_option_cost'?: number | null;
+    'preferred_option_duration'?: number | null;
+    'preferred_option_name'?: string | null;
+    'preferred_option_npv'?: number | null;
+    'preferred_option_start_date'?: string | null;
+}
+

package/models/option-overview-response.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ * 
+ *
+ * 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 option overview table — one row per option within an investment.
+ */
+export interface OptionOverviewResponse {
+    /**
+     * Cost of the option
+     */
+    'cost': number;
+    /**
+     * Duration of the option in weeks
+     */
+    'duration': number;
+    'npv'?: number | 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmotech/aip-client",
-  "version": "0.2.0-dev6",
+  "version": "0.2.0-dev7",
   "description": "OpenAPI client for @cosmotech/aip-client",
   "author": "OpenAPI-Generator Contributors",
   "repository": {