@cosmotech/aip-client 0.2.0-dev3 → 0.2.0-dev5

package/docs/InvestmentApi.md

@@ -9,16 +9,19 @@ All URIs are relative to *http://localhost*
 |[**deleteImpactForOption**](#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option|
 |[**deleteInvestment**](#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment|
 |[**deleteOptionForInvestment**](#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment|
+|[**getFavoredOption**](#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment|
 |[**getImpactForOption**](#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option|
 |[**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|
 |[**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|
 |[**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|
 |[**patchOptionForInvestment**](#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment|
 |[**postInvestment**](#postinvestment) | **POST** /investment/ | Create an investment|
+|[**setFavoredOption**](#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment|
 
 # **createImpactForOption**
 > ImpactAPIResponse createImpactForOption(impactCreate)
@@ -302,6 +305,59 @@ void (empty response body)
 
 [[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)
 
+# **getFavoredOption**
+> FavoredOptionResponse getFavoredOption()
+
+Get the preferred option for an investment.
+
+### 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)
+
+const { status, data } = await apiInstance.getFavoredOption(
+    investmentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**FavoredOptionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Preferred option exists |  -  |
+|**204** | Investment exists but no options are associated |  -  |
+|**404** | Investment 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)
+
 # **getImpactForOption**
 > ImpactAPIResponse getImpactForOption()
 
@@ -582,6 +638,64 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 
 [[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)
 
+# **getOptionKpis**
+> Array<OptionChartKPIsYearly> getOptionKpis()
+
+Return a KPI object containing all the data necessary to display graphs about the option inside a 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 optionId: string; //UUID of the option (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getOptionKpis(
+    investmentId,
+    optionId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<OptionChartKPIsYearly>**
+
+### 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 KPIs |  -  |
+|**404** | Investment, option 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)
+
 # **getOptionsForInvestment**
 > Array<OptionResponse> getOptionsForInvestment()
 
@@ -873,3 +987,60 @@ const { status, data } = await apiInstance.postInvestment(
 
 [[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)
 
+# **setFavoredOption**
+> FavoredOptionResponse setFavoredOption(favoredOptionRequest)
+
+Set the preferred option for an investment.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration,
+    FavoredOptionRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let investmentId: string; //UUID of the investment (default to undefined)
+let favoredOptionRequest: FavoredOptionRequest; //
+
+const { status, data } = await apiInstance.setFavoredOption(
+    investmentId,
+    favoredOptionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **favoredOptionRequest** | **FavoredOptionRequest**|  | |
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+
+
+### Return type
+
+**FavoredOptionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Preferred option updated successfully |  -  |
+|**400** | Option does not belong to this investment |  -  |
+|**404** | Investment or option 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)
+

package/docs/InvestmentResponse.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **id** | **string** |  | [default to undefined]
 **name** | **string** | Name of the investment | [default to undefined]
 **ownerName** | **string** |  | [optional] [default to undefined]
+**preferredOptionId** | **string** |  | [optional] [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 
 ## Example
@@ -24,6 +25,7 @@ const instance: InvestmentResponse = {
     id,
     name,
     ownerName,
+    preferredOptionId,
     updatedAt,
 };
 ```

package/docs/OptionApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost*
 |[**getImpactForOption**](#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option|
 |[**getImpactsForOption**](#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option|
 |[**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|
 |[**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|
@@ -419,6 +420,64 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 
 [[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)
 
+# **getOptionKpis**
+> Array<OptionChartKPIsYearly> getOptionKpis()
+
+Return a KPI object containing all the data necessary to display graphs about the option inside a 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 optionId: string; //UUID of the option (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getOptionKpis(
+    investmentId,
+    optionId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **optionId** | [**string**] | UUID of the option | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<OptionChartKPIsYearly>**
+
+### 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 KPIs |  -  |
+|**404** | Investment, option 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)
+
 # **getOptionsForInvestment**
 > Array<OptionResponse> getOptionsForInvestment()
 

package/docs/OptionChartKPI.md

@@ -0,0 +1,27 @@
+# OptionChartKPI
+
+Schema of a KPI value for a given time step, contain both the monetary and objective value
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metricValue** | **number** | Metric value of the KPI | [optional] [default to 0.0]
+**monetaryValue** | **number** | Monetary value of the KPI | [optional] [default to 0.0]
+**name** | **string** |  | [optional] [default to undefined]
+**symbol** | **string** | Symbol of the KPI | [optional] [default to '$']
+
+## Example
+
+```typescript
+import { OptionChartKPI } from '@cosmotech/aip-client';
+
+const instance: OptionChartKPI = {
+    metricValue,
+    monetaryValue,
+    name,
+    symbol,
+};
+```
+
+[[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/OptionChartKPIsYearly.md

@@ -0,0 +1,25 @@
+# OptionChartKPIsYearly
+
+Schema of a combined list of KPI values for a given time step, contain both the monetary and objective value
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**kpis** | [**Array<OptionChartKPI>**](OptionChartKPI.md) | List of KPI values for this time step | [optional] [default to undefined]
+**netPerceivedValue** | **number** | Net perceived value for the KPI | [optional] [default to 0.0]
+**year** | **number** | Year used for the KPIs | [optional] [default to 2025]
+
+## Example
+
+```typescript
+import { OptionChartKPIsYearly } from '@cosmotech/aip-client';
+
+const instance: OptionChartKPIsYearly = {
+    kpis,
+    netPerceivedValue,
+    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/OptionCreate.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cost** | **number** | Cost of the option | [optional] [default to 0.0]
 **description** | **string** |  | [optional] [default to undefined]
-**duration** | **number** | Duration of the option in years | [optional] [default to 1]
+**duration** | **number** | Duration of the option in weeks | [optional] [default to 1]
 **expectedStartDate** | **string** | Expected start date of the option | [optional] [default to 2027-01-01]
 **name** | **string** | Name of the option | [default to undefined]
 

package/docs/OptionResponse.md

@@ -6,14 +6,15 @@ Schema for Option responses (includes all fields)
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**cost** | **number** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
+**duration** | **number** |  | [default to undefined]
 **expectedStartDate** | **string** |  | [default to undefined]
 **id** | **string** |  | [default to undefined]
 **investmentId** | **string** | ID of the associated investment | [default to undefined]
 **name** | **string** | Name of the option | [default to undefined]
 **ownerName** | **string** |  | [optional] [default to undefined]
-**preferred** | **boolean** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 
 ## Example
@@ -22,14 +23,15 @@ Name | Type | Description | Notes
 import { OptionResponse } from '@cosmotech/aip-client';
 
 const instance: OptionResponse = {
+    cost,
     createdAt,
     description,
+    duration,
     expectedStartDate,
     id,
     investmentId,
     name,
     ownerName,
-    preferred,
     updatedAt,
 };
 ```

package/docs/OptionUpdate.md

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

package/models/favored-option-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.2.0-dev3
+ * 
+ *
+ * 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 setting the preferred option.
+ */
+export interface FavoredOptionRequest {
+    /**
+     * ID of the option to set as preferred
+     */
+    'option_id': string;
+}
+

package/models/favored-option-response.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Response for favored option endpoints.
+ */
+export interface FavoredOptionResponse {
+    /**
+     * ID of the preferred option
+     */
+    'option_id': string;
+}
+

package/models/index.ts

@@ -1,4 +1,6 @@
 export * from './evolution-type';
+export * from './favored-option-request';
+export * from './favored-option-response';
 export * from './httpvalidation-error';
 export * from './impact-apiresponse';
 export * from './impact-create';
@@ -21,6 +23,8 @@ export * from './objective-update';
 export * from './objective-weight-create';
 export * from './objective-weight-response';
 export * from './objective-weight-update';
+export * from './option-chart-kpi';
+export * from './option-chart-kpis-yearly';
 export * from './option-create';
 export * from './option-response';
 export * from './option-update';

package/models/investment-response.ts

@@ -26,6 +26,7 @@ export interface InvestmentResponse {
      */
     'name': string;
     'owner_name'?: string | null;
+    'preferred_option_id'?: string | null;
     'updated_at': string;
 }
 

package/models/option-chart-kpi.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-dev3
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Schema of a KPI value for a given time step, contain both the monetary and objective value
+ */
+export interface OptionChartKPI {
+    /**
+     * Metric value of the KPI
+     */
+    'metric_value'?: number;
+    /**
+     * Monetary value of the KPI
+     */
+    'monetary_value'?: number;
+    'name'?: string | null;
+    /**
+     * Symbol of the KPI
+     */
+    'symbol'?: string;
+}
+

package/models/option-chart-kpis-yearly.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev3
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OptionChartKPI } from './option-chart-kpi';
+
+/**
+ * Schema of a combined list of KPI values for a given time step, contain both the monetary and objective value
+ */
+export interface OptionChartKPIsYearly {
+    /**
+     * List of KPI values for this time step
+     */
+    'kpis'?: Array<OptionChartKPI>;
+    /**
+     * Net perceived value for the KPI
+     */
+    'net_perceived_value'?: number;
+    /**
+     * Year used for the KPIs
+     */
+    'year'?: number;
+}
+

package/models/option-create.ts

@@ -24,7 +24,7 @@ export interface OptionCreate {
     'cost'?: number;
     'description'?: string | null;
     /**
-     * Duration of the option in years
+     * Duration of the option in weeks
      */
     'duration'?: number;
     /**

package/models/option-response.ts

@@ -18,8 +18,10 @@
  * Schema for Option responses (includes all fields)
  */
 export interface OptionResponse {
+    'cost': number;
     'created_at': string;
     'description'?: string | null;
+    'duration': number;
     'expected_start_date': string;
     'id': string;
     /**
@@ -31,7 +33,6 @@ export interface OptionResponse {
      */
     'name': string;
     'owner_name'?: string | null;
-    'preferred': boolean;
     'updated_at': string;
 }
 

package/models/option-update.ts

@@ -18,7 +18,9 @@
  * Schema for partially updating an Option. Only provided fields will be updated.
  */
 export interface OptionUpdate {
+    'cost'?: number | null;
     'description'?: string | null;
+    'duration'?: number | null;
     'expected_start_date'?: string | null;
     'name'?: string | null;
 }

package/package.json

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