@cosmotech/aip-client 0.3.0-dev3 → 0.4.0-dev2

package/docs/PortfolioKPIApi.md

@@ -0,0 +1,508 @@
+# PortfolioKPIApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCapexDistribution**](#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution | CAPEX year-by-year distribution|
+|[**getInvestmentsDistribution**](#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution | Investment count year-by-year distribution|
+|[**getKpiOverrunDistribution**](#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution | Budget overrun year-by-year distribution|
+|[**getNpvDistribution**](#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution | NPV year-by-year distribution|
+|[**getPortfolioBudgetExpenditure**](#getportfoliobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure|
+|[**getPortfolioBudgetUsage**](#getportfoliobudgetusage) | **GET** /portfolio/{portfolio_id}/budget-usage | Budget usage summary|
+|[**getPortfolioKpis**](#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id} | Get portfolio KPIs|
+|[**getPortfolioMetricPerformance**](#getportfoliometricperformance) | **GET** /portfolio/{portfolio_id}/metric-performance/{metric_id} | Metric performance over time|
+|[**getPortfolioMonetizedImpact**](#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact/{value_framework_id} | Portfolio monetized impact over time|
+
+# **getCapexDistribution**
+> PortfolioKPIDistributionResponse getCapexDistribution()
+
+Total cost of preferred options starting each year.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getCapexDistribution(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**PortfolioKPIDistributionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Year-by-year CAPEX breakdown |  -  |
+|**404** | Portfolio 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)
+
+# **getInvestmentsDistribution**
+> PortfolioKPIDistributionResponse getInvestmentsDistribution()
+
+Count of investments with a preferred option starting each year.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getInvestmentsDistribution(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**PortfolioKPIDistributionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Year-by-year investment count |  -  |
+|**404** | Portfolio 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)
+
+# **getKpiOverrunDistribution**
+> PortfolioKPIOverrunDistributionResponse getKpiOverrunDistribution()
+
+Break down budget overruns by year across all preferred options in the portfolio.  For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getKpiOverrunDistribution(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**PortfolioKPIOverrunDistributionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Year-by-year budget overrun breakdown |  -  |
+|**404** | Portfolio 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)
+
+# **getNpvDistribution**
+> PortfolioKPIDistributionResponse getNpvDistribution()
+
+Sum of final NPV of preferred options starting each year.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getNpvDistribution(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**PortfolioKPIDistributionResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Year-by-year NPV breakdown |  -  |
+|**404** | Portfolio 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)
+
+# **getPortfolioBudgetExpenditure**
+> PortfolioBudgetExpenditureResponse getPortfolioBudgetExpenditure()
+
+Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let budgetId: string; //UUID of the budget (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioBudgetExpenditure(
+    portfolioId,
+    budgetId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+
+
+### Return type
+
+**PortfolioBudgetExpenditureResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Budget expenditure over time |  -  |
+|**404** | Portfolio or budget 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)
+
+# **getPortfolioBudgetUsage**
+> Array<PortfolioBudgetUsageItem> getPortfolioBudgetUsage()
+
+For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioBudgetUsage(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**Array<PortfolioBudgetUsageItem>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Budget usage items |  -  |
+|**404** | Portfolio 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)
+
+# **getPortfolioKpis**
+> PortfolioKPIResponse getPortfolioKpis()
+
+Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioKpis(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**PortfolioKPIResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | KPIs for the portfolio |  -  |
+|**404** | Portfolio 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)
+
+# **getPortfolioMetricPerformance**
+> MetricPerformanceResponse getPortfolioMetricPerformance()
+
+Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let metricId: string; //UUID of the metric (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioMetricPerformance(
+    portfolioId,
+    metricId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
+
+
+### Return type
+
+**MetricPerformanceResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Metric performance data |  -  |
+|**404** | Portfolio or metric 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)
+
+# **getPortfolioMonetizedImpact**
+> MonetizedImpactResponse getPortfolioMonetizedImpact()
+
+Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
+
+### Example
+
+```typescript
+import {
+    PortfolioKPIApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PortfolioKPIApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
+    portfolioId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**MonetizedImpactResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Monetized impact data |  -  |
+|**404** | Portfolio 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)
+

package/docs/PortfolioKPIDistributionBudgetItem.md

@@ -0,0 +1,25 @@
+# PortfolioKPIDistributionBudgetItem
+
+Per-budget overrun flag for one year (True = budget exceeded, False = within capacity).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [default to undefined]
+**budgetName** | **string** |  | [default to undefined]
+**overrun** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioKPIDistributionBudgetItem } from '@cosmotech/aip-client';
+
+const instance: PortfolioKPIDistributionBudgetItem = {
+    budgetId,
+    budgetName,
+    overrun,
+};
+```
+
+[[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/PortfolioKPIDistributionResponse.md

@@ -0,0 +1,25 @@
+# PortfolioKPIDistributionResponse
+
+Response for the KPI distribution endpoint (investments / capex / npv).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<PortfolioKPIDistributionYearValue>**](PortfolioKPIDistributionYearValue.md) |  | [default to undefined]
+**kpi** | **string** |  | [default to undefined]
+**unit** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioKPIDistributionResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioKPIDistributionResponse = {
+    data,
+    kpi,
+    unit,
+};
+```
+
+[[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/PortfolioKPIDistributionYearOverrun.md

@@ -0,0 +1,23 @@
+# PortfolioKPIDistributionYearOverrun
+
+Year + per-budget breakdown for the budget_overrun distribution.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgets** | [**Array<PortfolioKPIDistributionBudgetItem>**](PortfolioKPIDistributionBudgetItem.md) |  | [default to undefined]
+**year** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioKPIDistributionYearOverrun } from '@cosmotech/aip-client';
+
+const instance: PortfolioKPIDistributionYearOverrun = {
+    budgets,
+    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/PortfolioKPIDistributionYearValue.md

@@ -0,0 +1,23 @@
+# PortfolioKPIDistributionYearValue
+
+Year + scalar value for investments / capex / npv distributions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **number** |  | [default to undefined]
+**year** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioKPIDistributionYearValue } from '@cosmotech/aip-client';
+
+const instance: PortfolioKPIDistributionYearValue = {
+    value,
+    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/PortfolioKPIOverrunDistributionResponse.md

@@ -0,0 +1,23 @@
+# PortfolioKPIOverrunDistributionResponse
+
+Response for the budget_overrun KPI distribution endpoint.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<PortfolioKPIDistributionYearOverrun>**](PortfolioKPIDistributionYearOverrun.md) |  | [default to undefined]
+**kpi** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioKPIOverrunDistributionResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioKPIOverrunDistributionResponse = {
+    data,
+    kpi,
+};
+```
+
+[[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/PortfolioKPIResponse.md

@@ -0,0 +1,31 @@
+# PortfolioKPIResponse
+
+Computed KPI values for one portfolio (framework-independent fields only when no VF given).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetOverrun** | **number** | Count of budget-overrun years across all budgets in this portfolio | [default to undefined]
+**earliestStartDate** | **string** |  | [optional] [default to undefined]
+**latestStartDate** | **string** |  | [optional] [default to undefined]
+**nbInvestments** | **number** | Number of investments in the portfolio | [default to undefined]
+**npv** | **number** |  | [optional] [default to undefined]
+**totalCost** | **number** | Sum of preferred options\' costs (CAPEX) | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioKPIResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioKPIResponse = {
+    budgetOverrun,
+    earliestStartDate,
+    latestStartDate,
+    nbInvestments,
+    npv,
+    totalCost,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)