@cosmotech/aip-client 0.4.0-dev5 → 1.0.0-dev2

package/docs/PrioritizationApi.md

@@ -0,0 +1,705 @@
+# PrioritizationApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**abortScenario**](#abortscenario) | **POST** /portfolio/{portfolio_id}/scenario/abort | Abort a running prioritization|
+|[**deleteScenario**](#deletescenario) | **DELETE** /portfolio/{portfolio_id}/scenario/ | Delete the prioritization scenario|
+|[**getScenario**](#getscenario) | **GET** /portfolio/{portfolio_id}/scenario/ | Get the prioritization scenario|
+|[**getScenarioBudgetExpenditure**](#getscenariobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure/{budget_id} | Per-year expenditure for one budget (performed investments)|
+|[**getScenarioBudgetExpenditureAll**](#getscenariobudgetexpenditureall) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure-all | Per-budget expenditure for performed investments|
+|[**getScenarioBudgetExpenditureNoBudget**](#getscenariobudgetexpenditurenobudget) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure-no-budget | Per-year expenditure for performed investments with no budget|
+|[**getScenarioBudgetUsage**](#getscenariobudgetusage) | **GET** /portfolio/{portfolio_id}/scenario/budget-usage | Budget usage for performed investments|
+|[**getScenarioOverview**](#getscenariooverview) | **GET** /portfolio/{portfolio_id}/scenario/overview | Run vs portfolio comparison KPIs|
+|[**getScenarioResults**](#getscenarioresults) | **GET** /portfolio/{portfolio_id}/scenario/results | Get prioritization results|
+|[**getScenarioStatus**](#getscenariostatus) | **GET** /portfolio/{portfolio_id}/scenario/status | Get prioritization run status|
+|[**getScenarioValueFrameworkImpact**](#getscenariovalueframeworkimpact) | **GET** /portfolio/{portfolio_id}/scenario/value-framework-impact | Monetized impact filtered to performed investments|
+|[**getScenarioValueFrameworkImpactDetailed**](#getscenariovalueframeworkimpactdetailed) | **GET** /portfolio/{portfolio_id}/scenario/value-framework-impact/detailed | Monetized impact (split by metric) filtered to performed investments|
+|[**runScenario**](#runscenario) | **POST** /portfolio/{portfolio_id}/scenario/run | Create/update and run a prioritization scenario|
+
+# **abortScenario**
+> PrioritizationScenarioResponse abortScenario()
+
+Abort the currently running prioritization for this portfolio.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.abortScenario(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PrioritizationScenarioResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prioritization aborted |  -  |
+|**404** | No scenario found for this portfolio |  -  |
+|**409** | No prioritization is currently running |  -  |
+
+[[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)
+
+# **deleteScenario**
+> deleteScenario()
+
+Delete the scenario and all its results for this portfolio.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.deleteScenario(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Scenario and results deleted |  -  |
+|**404** | No scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenario**
+> PrioritizationScenarioResponse getScenario()
+
+Get the current prioritization scenario for this portfolio, including config and status.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenario(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PrioritizationScenarioResponse**
+
+### 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 scenario |  -  |
+|**404** | No scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioBudgetExpenditure**
+> PortfolioBudgetExpenditureResponse getScenarioBudgetExpenditure()
+
+Year-by-year expenditure of performed investments linked to a specific budget within this scenario.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(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.getScenarioBudgetExpenditure(
+    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** | No completed scenario 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)
+
+# **getScenarioBudgetExpenditureAll**
+> Array<PortfolioBudgetExpenditureResponse> getScenarioBudgetExpenditureAll()
+
+Year-by-year expenditure for every budget referenced by a performed investment in the run.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioBudgetExpenditureAll(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**Array<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, performed investments only |  -  |
+|**404** | No completed scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioBudgetExpenditureNoBudget**
+> PortfolioBudgetExpenditureResponse getScenarioBudgetExpenditureNoBudget()
+
+Year-by-year expenditure of performed investments that have no budget assigned within this scenario.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioBudgetExpenditureNoBudget(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | 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** | Expenditure over time for unbudgeted performed investments |  -  |
+|**404** | No completed scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioBudgetUsage**
+> Array<PortfolioBudgetUsageItem> getScenarioBudgetUsage()
+
+Budget usage statistics restricted to the investments performed in the scenario run. For each budget referenced by a performed investment, returns usage and overrun statistics.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioBudgetUsage(
+    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 for performed investments |  -  |
+|**404** | No completed scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioOverview**
+> PrioritizationOverviewResponse getScenarioOverview()
+
+Aggregate KPIs comparing the prioritization run against the full portfolio (Overview tab of the scenario results).
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioOverview(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PrioritizationOverviewResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Comparison KPIs for the scenario run |  -  |
+|**404** | No completed scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioResults**
+> PrioritizationResultsResponse getScenarioResults()
+
+Get the results of the last successful prioritization run. Returns the list of investments with their rank and performed/unperformed status.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioResults(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PrioritizationResultsResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prioritization results (may be empty if no results exist) |  -  |
+|**404** | No scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioStatus**
+> PrioritizationScenarioStatusResponse getScenarioStatus()
+
+Lightweight polling endpoint to check the status of a prioritization run.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioStatus(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PrioritizationScenarioStatusResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Current run status |  -  |
+|**404** | No scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioValueFrameworkImpact**
+> MonetizedImpactResponse getScenarioValueFrameworkImpact()
+
+Year-by-year monetized impact (sum of all metric monetary values) and CAPEX, restricted to the investments performed in the scenario run. Uses the scenario\'s value framework.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioValueFrameworkImpact(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | 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 for performed investments |  -  |
+|**404** | No completed scenario found for this portfolio |  -  |
+
+[[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)
+
+# **getScenarioValueFrameworkImpactDetailed**
+> MonetizedImpactDetailedResponse getScenarioValueFrameworkImpactDetailed()
+
+Year-by-year monetized impact split by individual metric and CAPEX, restricted to the investments performed in the scenario run. Uses the scenario\'s value framework.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+
+const { status, data } = await apiInstance.getScenarioValueFrameworkImpactDetailed(
+    portfolioId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**MonetizedImpactDetailedResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Detailed monetized impact for performed investments |  -  |
+|**404** | No completed scenario found for this portfolio |  -  |
+
+[[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)
+
+# **runScenario**
+> PrioritizationScenarioResponse runScenario(prioritizationScenarioRunRequest)
+
+Create a new prioritization scenario for this portfolio (or update the existing one) with the given value framework and metric, then immediately trigger the prioritization algorithm. Returns 202 Accepted — poll GET /status for progress.
+
+### Example
+
+```typescript
+import {
+    PrioritizationApi,
+    Configuration,
+    PrioritizationScenarioRunRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new PrioritizationApi(configuration);
+
+let portfolioId: string; //UUID of the portfolio (default to undefined)
+let prioritizationScenarioRunRequest: PrioritizationScenarioRunRequest; //
+
+const { status, data } = await apiInstance.runScenario(
+    portfolioId,
+    prioritizationScenarioRunRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **prioritizationScenarioRunRequest** | **PrioritizationScenarioRunRequest**|  | |
+| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
+
+
+### Return type
+
+**PrioritizationScenarioResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Scenario created/updated and run started |  -  |
+|**404** | Portfolio, value framework, or metric not found |  -  |
+|**409** | A prioritization run is already in progress |  -  |
+
+[[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)
+