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

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/{FavoredOptionApi.md → PreferredOptionApi.md}

@@ -1,14 +1,14 @@
-# FavoredOptionApi
+# PreferredOptionApi
 
 All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getFavoredOption**](#getfavoredoption) | **GET** /investment/{investment_id}/favored_option | Get the preferred option for an investment|
-|[**setFavoredOption**](#setfavoredoption) | **POST** /investment/{investment_id}/favored_option | Set the preferred option for an investment|
+|[**getPreferredOption**](#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment|
+|[**setPreferredOption**](#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment|
 
-# **getFavoredOption**
-> FavoredOptionResponse getFavoredOption()
+# **getPreferredOption**
+> PreferredOptionResponse getPreferredOption()
 
 Get the preferred option for an investment.
 
@@ -16,16 +16,16 @@ Get the preferred option for an investment.
 
 ```typescript
 import {
-    FavoredOptionApi,
+    PreferredOptionApi,
     Configuration
 } from '@cosmotech/aip-client';
 
 const configuration = new Configuration();
-const apiInstance = new FavoredOptionApi(configuration);
+const apiInstance = new PreferredOptionApi(configuration);
 
 let investmentId: string; //UUID of the investment (default to undefined)
 
-const { status, data } = await apiInstance.getFavoredOption(
+const { status, data } = await apiInstance.getPreferredOption(
     investmentId
 );
 ```
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.getFavoredOption(
 
 ### Return type
 
-**FavoredOptionResponse**
+**PreferredOptionResponse**
 
 ### Authorization
 
@@ -60,8 +60,8 @@ const { status, data } = await apiInstance.getFavoredOption(
 
 [[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)
+# **setPreferredOption**
+> PreferredOptionResponse setPreferredOption(preferredOptionRequest)
 
 Set the preferred option for an investment.
 
@@ -69,20 +69,20 @@ Set the preferred option for an investment.
 
 ```typescript
 import {
-    FavoredOptionApi,
+    PreferredOptionApi,
     Configuration,
-    FavoredOptionRequest
+    PreferredOptionRequest
 } from '@cosmotech/aip-client';
 
 const configuration = new Configuration();
-const apiInstance = new FavoredOptionApi(configuration);
+const apiInstance = new PreferredOptionApi(configuration);
 
 let investmentId: string; //UUID of the investment (default to undefined)
-let favoredOptionRequest: FavoredOptionRequest; //
+let preferredOptionRequest: PreferredOptionRequest; //
 
-const { status, data } = await apiInstance.setFavoredOption(
+const { status, data } = await apiInstance.setPreferredOption(
     investmentId,
-    favoredOptionRequest
+    preferredOptionRequest
 );
 ```
 
@@ -90,13 +90,13 @@ const { status, data } = await apiInstance.setFavoredOption(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **favoredOptionRequest** | **FavoredOptionRequest**|  | |
+| **preferredOptionRequest** | **PreferredOptionRequest**|  | |
 | **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
 
 
 ### Return type
 
-**FavoredOptionResponse**
+**PreferredOptionResponse**
 
 ### Authorization
 

package/docs/{FavoredOptionRequest.md → PreferredOptionRequest.md}

@@ -1,4 +1,4 @@
-# FavoredOptionRequest
+# PreferredOptionRequest
 
 Request body for setting the preferred option.
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { FavoredOptionRequest } from '@cosmotech/aip-client';
+import { PreferredOptionRequest } from '@cosmotech/aip-client';
 
-const instance: FavoredOptionRequest = {
+const instance: PreferredOptionRequest = {
     optionId,
 };
 ```

package/docs/{FavoredOptionResponse.md → PreferredOptionResponse.md}

@@ -1,6 +1,6 @@
-# FavoredOptionResponse
+# PreferredOptionResponse
 
-Response for favored option endpoints.
+Response for preferred option endpoints.
 
 ## Properties
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { FavoredOptionResponse } from '@cosmotech/aip-client';
+import { PreferredOptionResponse } from '@cosmotech/aip-client';
 
-const instance: FavoredOptionResponse = {
+const instance: PreferredOptionResponse = {
     optionId,
 };
 ```

package/index.ts

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

package/models/evolution-type.ts

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

package/models/httpvalidation-error.ts

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

package/models/impact-apiresponse.ts

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

package/models/impact-create.ts

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

package/models/impact-update.ts

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

package/models/index.ts

@@ -1,6 +1,4 @@
 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';
@@ -23,9 +21,13 @@ 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';
+export * from './preferred-option-request';
+export * from './preferred-option-response';
 export * from './validation-error';
 export * from './value-framework-create';
 export * from './value-framework-response';

package/models/investment-create.ts

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

package/models/investment-response.ts

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

package/models/investment-update.ts

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

package/models/location-inner.ts

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

package/models/measurement-type.ts

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

package/models/metric-costs-per-year-create.ts

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

package/models/metric-costs-per-year-response.ts

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

package/models/metric-costs-per-year-update.ts

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

package/models/metric-create.ts

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

package/models/metric-response.ts

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

package/models/metric-type.ts

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

package/models/metric-update.ts

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

package/models/objective-create.ts

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

package/models/objective-response.ts

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

package/models/objective-update.ts

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

package/models/objective-weight-create.ts

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

package/models/objective-weight-response.ts

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

package/models/objective-weight-update.ts

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

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-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 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-dev6
+ * 
+ *
+ * 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

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

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

package/models/option-update.ts

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