Metadata-Version: 2.4
Name: cosmotech.aip_client
Version: 1.0.0
Summary: Asset Investment Planning
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Asset Investment Planning
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: lazy-imports<2,>=1
Dynamic: author

# cosmotech-asset-investment-planning-client
API for Asset Investment Planning

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import cosmotech.aip_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import cosmotech.aip_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import cosmotech.aip_client
from cosmotech.aip_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech.aip_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with cosmotech.aip_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech.aip_client.BudgetApi(api_client)
    budget_bulk_delete_request = cosmotech.aip_client.BudgetBulkDeleteRequest() # BudgetBulkDeleteRequest | 

    try:
        # Bulk delete budgets
        api_instance.bulk_delete_budgets(budget_bulk_delete_request)
    except ApiException as e:
        print("Exception when calling BudgetApi->bulk_delete_budgets: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BudgetApi* | [**bulk_delete_budgets**](docs/BudgetApi.md#bulk_delete_budgets) | **POST** /budget/bulk-delete | Bulk delete budgets
*BudgetApi* | [**delete_budget**](docs/BudgetApi.md#delete_budget) | **DELETE** /budget/{budget_id} | Delete a budget
*BudgetApi* | [**get_budget_by_id**](docs/BudgetApi.md#get_budget_by_id) | **GET** /budget/{budget_id} | Get a budget by ID
*BudgetApi* | [**get_budget_investments**](docs/BudgetApi.md#get_budget_investments) | **GET** /budget/{budget_id}/investments | List investments linked to this budget via options
*BudgetApi* | [**get_budget_options**](docs/BudgetApi.md#get_budget_options) | **GET** /budget/{budget_id}/options | List options linked to this budget
*BudgetApi* | [**get_budget_overview**](docs/BudgetApi.md#get_budget_overview) | **GET** /budget/{budget_id}/overview | Get budget overview
*BudgetApi* | [**get_budgets**](docs/BudgetApi.md#get_budgets) | **GET** /budget/ | List all budgets
*BudgetApi* | [**link_options_to_budget**](docs/BudgetApi.md#link_options_to_budget) | **POST** /budget/{budget_id}/link-options | Bulk-link options to this budget
*BudgetApi* | [**list_available_options**](docs/BudgetApi.md#list_available_options) | **GET** /budget/list-available-options | List all options available to be added to a budget
*BudgetApi* | [**patch_budget**](docs/BudgetApi.md#patch_budget) | **PATCH** /budget/{budget_id} | Partially update a budget
*BudgetApi* | [**post_budget**](docs/BudgetApi.md#post_budget) | **POST** /budget/ | Create a budget
*ImpactApi* | [**bulk_upsert_impacts_for_option**](docs/ImpactApi.md#bulk_upsert_impacts_for_option) | **PUT** /investment/{investment_id}/option/{option_id}/impact/ | Bulk upsert impacts for this option
*ImpactApi* | [**create_impact_for_option**](docs/ImpactApi.md#create_impact_for_option) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
*ImpactApi* | [**delete_impact_for_option**](docs/ImpactApi.md#delete_impact_for_option) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
*ImpactApi* | [**get_impact_for_option**](docs/ImpactApi.md#get_impact_for_option) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
*ImpactApi* | [**get_impacts_for_option**](docs/ImpactApi.md#get_impacts_for_option) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
*ImpactApi* | [**patch_impact_for_option**](docs/ImpactApi.md#patch_impact_for_option) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
*InvestmentApi* | [**bulk_delete_investments**](docs/InvestmentApi.md#bulk_delete_investments) | **POST** /investment/bulk-delete | Bulk delete investments
*InvestmentApi* | [**delete_investment**](docs/InvestmentApi.md#delete_investment) | **DELETE** /investment/{investment_id} | Delete an investment
*InvestmentApi* | [**get_investment_by_id**](docs/InvestmentApi.md#get_investment_by_id) | **GET** /investment/{investment_id} | Get an investment by ID
*InvestmentApi* | [**get_investments**](docs/InvestmentApi.md#get_investments) | **GET** /investment/ | List investments
*InvestmentApi* | [**get_investments_overview**](docs/InvestmentApi.md#get_investments_overview) | **GET** /investment/overview | Investment overview table
*InvestmentApi* | [**patch_investment**](docs/InvestmentApi.md#patch_investment) | **PATCH** /investment/{investment_id} | Partially update an investment
*InvestmentApi* | [**post_investment**](docs/InvestmentApi.md#post_investment) | **POST** /investment/ | Create an investment
*MetricApi* | [**create_metric_for_objective**](docs/MetricApi.md#create_metric_for_objective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
*MetricApi* | [**delete_metric_for_objective**](docs/MetricApi.md#delete_metric_for_objective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
*MetricApi* | [**get_metric_for_objective**](docs/MetricApi.md#get_metric_for_objective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
*MetricApi* | [**get_metrics_for_objective**](docs/MetricApi.md#get_metrics_for_objective) | **GET** /objective/{objective_id}/metric/ | List metrics for this objective
*MetricApi* | [**patch_metric_for_objective**](docs/MetricApi.md#patch_metric_for_objective) | **PATCH** /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective
*MetricCostsApi* | [**get_costs_for_metric**](docs/MetricCostsApi.md#get_costs_for_metric) | **GET** /metric/{metric_id}/costs/ | List all metric costs for a metric
*MetricCostsPerYearApi* | [**create_metric_cost_for_framework**](docs/MetricCostsPerYearApi.md#create_metric_cost_for_framework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework
*MetricCostsPerYearApi* | [**delete_metric_cost_for_framework**](docs/MetricCostsPerYearApi.md#delete_metric_cost_for_framework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework
*MetricCostsPerYearApi* | [**get_metric_cost_for_framework**](docs/MetricCostsPerYearApi.md#get_metric_cost_for_framework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework
*MetricCostsPerYearApi* | [**get_metric_costs_for_framework**](docs/MetricCostsPerYearApi.md#get_metric_costs_for_framework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework
*MetricCostsPerYearApi* | [**patch_metric_cost_for_framework**](docs/MetricCostsPerYearApi.md#patch_metric_cost_for_framework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework
*ObjectiveApi* | [**delete_objective**](docs/ObjectiveApi.md#delete_objective) | **DELETE** /objective/{objective_id} | Delete an objective
*ObjectiveApi* | [**get_objective_by_id**](docs/ObjectiveApi.md#get_objective_by_id) | **GET** /objective/{objective_id} | Get an objective by ID
*ObjectiveApi* | [**get_objectives**](docs/ObjectiveApi.md#get_objectives) | **GET** /objective/ | List objectives
*ObjectiveApi* | [**patch_objective**](docs/ObjectiveApi.md#patch_objective) | **PATCH** /objective/{objective_id} | Partially update an objective
*ObjectiveApi* | [**post_objective**](docs/ObjectiveApi.md#post_objective) | **POST** /objective/ | Create an objective
*ObjectiveWeightApi* | [**create_objective_weight_for_framework**](docs/ObjectiveWeightApi.md#create_objective_weight_for_framework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework
*ObjectiveWeightApi* | [**delete_objective_weight_for_framework**](docs/ObjectiveWeightApi.md#delete_objective_weight_for_framework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework
*ObjectiveWeightApi* | [**get_objective_weight_for_framework**](docs/ObjectiveWeightApi.md#get_objective_weight_for_framework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework
*ObjectiveWeightApi* | [**get_objective_weights_for_framework**](docs/ObjectiveWeightApi.md#get_objective_weights_for_framework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework
*ObjectiveWeightApi* | [**patch_objective_weight_for_framework**](docs/ObjectiveWeightApi.md#patch_objective_weight_for_framework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework
*ObjectiveWeightsApi* | [**get_weights_for_objective**](docs/ObjectiveWeightsApi.md#get_weights_for_objective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective
*OptionApi* | [**create_option_for_investment**](docs/OptionApi.md#create_option_for_investment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment
*OptionApi* | [**delete_option_for_investment**](docs/OptionApi.md#delete_option_for_investment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
*OptionApi* | [**get_option_for_investment**](docs/OptionApi.md#get_option_for_investment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
*OptionApi* | [**get_option_kpis**](docs/OptionApi.md#get_option_kpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis | Get the kpis for a given option inside a value framework
*OptionApi* | [**get_options_for_investment**](docs/OptionApi.md#get_options_for_investment) | **GET** /investment/{investment_id}/option/ | List options for this investment
*OptionApi* | [**get_options_overview**](docs/OptionApi.md#get_options_overview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment
*OptionApi* | [**patch_option_for_investment**](docs/OptionApi.md#patch_option_for_investment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
*PortfolioApi* | [**bulk_delete_portfolios**](docs/PortfolioApi.md#bulk_delete_portfolios) | **POST** /portfolio/bulk-delete | Bulk delete portfolios
*PortfolioApi* | [**delete_portfolio**](docs/PortfolioApi.md#delete_portfolio) | **DELETE** /portfolio/{portfolio_id} | Delete a portfolio
*PortfolioApi* | [**get_portfolio_by_id**](docs/PortfolioApi.md#get_portfolio_by_id) | **GET** /portfolio/{portfolio_id} | Get a portfolio by ID
*PortfolioApi* | [**get_portfolio_overview**](docs/PortfolioApi.md#get_portfolio_overview) | **GET** /portfolio/overview | Portfolio overview with KPIs
*PortfolioApi* | [**get_portfolios**](docs/PortfolioApi.md#get_portfolios) | **GET** /portfolio/ | List portfolios
*PortfolioApi* | [**patch_portfolio**](docs/PortfolioApi.md#patch_portfolio) | **PATCH** /portfolio/{portfolio_id} | Partially update a portfolio
*PortfolioApi* | [**post_portfolio**](docs/PortfolioApi.md#post_portfolio) | **POST** /portfolio/ | Create a portfolio
*PortfolioInvestmentApi* | [**add_investment_to_portfolio**](docs/PortfolioInvestmentApi.md#add_investment_to_portfolio) | **POST** /portfolio/{portfolio_id}/investment/{investment_id} | Add an investment to this portfolio
*PortfolioInvestmentApi* | [**bulk_add_investments_to_portfolio**](docs/PortfolioInvestmentApi.md#bulk_add_investments_to_portfolio) | **POST** /portfolio/{portfolio_id}/investment/bulk | Bulk add investments to this portfolio
*PortfolioInvestmentApi* | [**bulk_remove_investments_from_portfolio**](docs/PortfolioInvestmentApi.md#bulk_remove_investments_from_portfolio) | **POST** /portfolio/{portfolio_id}/investment/bulk-delete | Bulk remove investments from this portfolio
*PortfolioInvestmentApi* | [**get_investment_for_portfolio**](docs/PortfolioInvestmentApi.md#get_investment_for_portfolio) | **GET** /portfolio/{portfolio_id}/investment/{investment_id} | Get an investment link in this portfolio
*PortfolioInvestmentApi* | [**get_investments_for_portfolio**](docs/PortfolioInvestmentApi.md#get_investments_for_portfolio) | **GET** /portfolio/{portfolio_id}/investment/ | List investments in this portfolio
*PortfolioInvestmentApi* | [**get_portfolio_investments_overview**](docs/PortfolioInvestmentApi.md#get_portfolio_investments_overview) | **GET** /portfolio/{portfolio_id}/investment/overview | Investment overview table for this portfolio
*PortfolioInvestmentApi* | [**remove_investment_from_portfolio**](docs/PortfolioInvestmentApi.md#remove_investment_from_portfolio) | **DELETE** /portfolio/{portfolio_id}/investment/{investment_id} | Remove an investment from this portfolio
*PortfolioKPIApi* | [**get_capex_distribution**](docs/PortfolioKPIApi.md#get_capex_distribution) | **GET** /portfolio/{portfolio_id}/kpis/capex-distribution | CAPEX year-by-year distribution
*PortfolioKPIApi* | [**get_investments_distribution**](docs/PortfolioKPIApi.md#get_investments_distribution) | **GET** /portfolio/{portfolio_id}/kpis/investments-distribution | Investment count year-by-year distribution
*PortfolioKPIApi* | [**get_kpi_overrun_distribution**](docs/PortfolioKPIApi.md#get_kpi_overrun_distribution) | **GET** /portfolio/{portfolio_id}/kpis/overrun-distribution | Budget overrun year-by-year distribution
*PortfolioKPIApi* | [**get_npv_distribution**](docs/PortfolioKPIApi.md#get_npv_distribution) | **GET** /portfolio/{portfolio_id}/kpis/npv-distribution | NPV year-by-year distribution
*PortfolioKPIApi* | [**get_portfolio_budget_expenditure**](docs/PortfolioKPIApi.md#get_portfolio_budget_expenditure) | **GET** /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure
*PortfolioKPIApi* | [**get_portfolio_budget_expenditure_all**](docs/PortfolioKPIApi.md#get_portfolio_budget_expenditure_all) | **GET** /portfolio/{portfolio_id}/budget-expenditure-all | Budget year-by-year expenditure for all budgets
*PortfolioKPIApi* | [**get_portfolio_budget_expenditure_no_budget**](docs/PortfolioKPIApi.md#get_portfolio_budget_expenditure_no_budget) | **GET** /portfolio/{portfolio_id}/budget-expenditure-no-budget | Year-by-year expenditure for options with no budget
*PortfolioKPIApi* | [**get_portfolio_budget_usage**](docs/PortfolioKPIApi.md#get_portfolio_budget_usage) | **GET** /portfolio/{portfolio_id}/budget-usage | Budget usage summary
*PortfolioKPIApi* | [**get_portfolio_kpis**](docs/PortfolioKPIApi.md#get_portfolio_kpis) | **GET** /portfolio/{portfolio_id}/kpis | Get portfolio KPIs
*PortfolioKPIApi* | [**get_portfolio_metric_performance**](docs/PortfolioKPIApi.md#get_portfolio_metric_performance) | **GET** /portfolio/{portfolio_id}/metric-performance/{metric_id} | Metric performance over time
*PortfolioKPIApi* | [**get_portfolio_monetized_impact**](docs/PortfolioKPIApi.md#get_portfolio_monetized_impact) | **GET** /portfolio/{portfolio_id}/monetized-impact | Portfolio monetized impact over time
*PortfolioKPIApi* | [**get_portfolio_monetized_impact_detailed**](docs/PortfolioKPIApi.md#get_portfolio_monetized_impact_detailed) | **GET** /portfolio/{portfolio_id}/monetized-impact/detailed | Portfolio monetized impact over time (split by metric)
*PreferredOptionApi* | [**get_preferred_option**](docs/PreferredOptionApi.md#get_preferred_option) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment
*PreferredOptionApi* | [**set_preferred_option**](docs/PreferredOptionApi.md#set_preferred_option) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment
*PrioritizationApi* | [**abort_scenario**](docs/PrioritizationApi.md#abort_scenario) | **POST** /portfolio/{portfolio_id}/scenario/abort | Abort a running prioritization
*PrioritizationApi* | [**delete_scenario**](docs/PrioritizationApi.md#delete_scenario) | **DELETE** /portfolio/{portfolio_id}/scenario/ | Delete the prioritization scenario
*PrioritizationApi* | [**get_scenario**](docs/PrioritizationApi.md#get_scenario) | **GET** /portfolio/{portfolio_id}/scenario/ | Get the prioritization scenario
*PrioritizationApi* | [**get_scenario_budget_expenditure**](docs/PrioritizationApi.md#get_scenario_budget_expenditure) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure/{budget_id} | Per-year expenditure for one budget (performed investments)
*PrioritizationApi* | [**get_scenario_budget_expenditure_all**](docs/PrioritizationApi.md#get_scenario_budget_expenditure_all) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure-all | Per-budget expenditure for performed investments
*PrioritizationApi* | [**get_scenario_budget_expenditure_no_budget**](docs/PrioritizationApi.md#get_scenario_budget_expenditure_no_budget) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure-no-budget | Per-year expenditure for performed investments with no budget
*PrioritizationApi* | [**get_scenario_budget_usage**](docs/PrioritizationApi.md#get_scenario_budget_usage) | **GET** /portfolio/{portfolio_id}/scenario/budget-usage | Budget usage for performed investments
*PrioritizationApi* | [**get_scenario_capex_distribution**](docs/PrioritizationApi.md#get_scenario_capex_distribution) | **GET** /portfolio/{portfolio_id}/scenario/capex-distribution | CAPEX year-by-year distribution for performed investments
*PrioritizationApi* | [**get_scenario_metric_performance**](docs/PrioritizationApi.md#get_scenario_metric_performance) | **GET** /portfolio/{portfolio_id}/scenario/metric-performance/{metric_id} | Metric performance over time for performed investments
*PrioritizationApi* | [**get_scenario_overview**](docs/PrioritizationApi.md#get_scenario_overview) | **GET** /portfolio/{portfolio_id}/scenario/overview | Run vs portfolio comparison KPIs
*PrioritizationApi* | [**get_scenario_results**](docs/PrioritizationApi.md#get_scenario_results) | **GET** /portfolio/{portfolio_id}/scenario/results | Get prioritization results
*PrioritizationApi* | [**get_scenario_status**](docs/PrioritizationApi.md#get_scenario_status) | **GET** /portfolio/{portfolio_id}/scenario/status | Get prioritization run status
*PrioritizationApi* | [**get_scenario_value_framework_impact**](docs/PrioritizationApi.md#get_scenario_value_framework_impact) | **GET** /portfolio/{portfolio_id}/scenario/value-framework-impact | Monetized impact filtered to performed investments
*PrioritizationApi* | [**get_scenario_value_framework_impact_detailed**](docs/PrioritizationApi.md#get_scenario_value_framework_impact_detailed) | **GET** /portfolio/{portfolio_id}/scenario/value-framework-impact/detailed | Monetized impact (split by metric) filtered to performed investments
*PrioritizationApi* | [**run_scenario**](docs/PrioritizationApi.md#run_scenario) | **POST** /portfolio/{portfolio_id}/scenario/run | Create/update and run a prioritization scenario
*ValueFrameworkApi* | [**delete_value_framework**](docs/ValueFrameworkApi.md#delete_value_framework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework
*ValueFrameworkApi* | [**get_value_framework_by_id**](docs/ValueFrameworkApi.md#get_value_framework_by_id) | **GET** /value_framework/{value_framework_id} | Get a value framework by ID
*ValueFrameworkApi* | [**get_value_frameworks**](docs/ValueFrameworkApi.md#get_value_frameworks) | **GET** /value_framework/ | List value frameworks
*ValueFrameworkApi* | [**patch_value_framework**](docs/ValueFrameworkApi.md#patch_value_framework) | **PATCH** /value_framework/{value_framework_id} | Partially update a value framework
*ValueFrameworkApi* | [**post_value_framework**](docs/ValueFrameworkApi.md#post_value_framework) | **POST** /value_framework/ | Create a value framework
*ValueFrameworkCostsApi* | [**get_costs_for_value_framework**](docs/ValueFrameworkCostsApi.md#get_costs_for_value_framework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework
*ValueFrameworkCostsApi* | [**get_costs_for_value_framework_by_metric**](docs/ValueFrameworkCostsApi.md#get_costs_for_value_framework_by_metric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric
*ValueFrameworkWeightsApi* | [**get_weights_for_value_framework**](docs/ValueFrameworkWeightsApi.md#get_weights_for_value_framework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework
*DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root


## Documentation For Models

 - [BudgetBulkDeleteRequest](docs/BudgetBulkDeleteRequest.md)
 - [BudgetCreate](docs/BudgetCreate.md)
 - [BudgetInvestmentResponse](docs/BudgetInvestmentResponse.md)
 - [BudgetLinkOptionsRequest](docs/BudgetLinkOptionsRequest.md)
 - [BudgetOptionResponse](docs/BudgetOptionResponse.md)
 - [BudgetOverviewResponse](docs/BudgetOverviewResponse.md)
 - [BudgetResponse](docs/BudgetResponse.md)
 - [BudgetUpdate](docs/BudgetUpdate.md)
 - [BulkDeleteRequest](docs/BulkDeleteRequest.md)
 - [EvolutionType](docs/EvolutionType.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [ImpactAPIResponse](docs/ImpactAPIResponse.md)
 - [ImpactBulkItem](docs/ImpactBulkItem.md)
 - [ImpactCreate](docs/ImpactCreate.md)
 - [ImpactUpdate](docs/ImpactUpdate.md)
 - [InvestmentCreate](docs/InvestmentCreate.md)
 - [InvestmentOverviewResponse](docs/InvestmentOverviewResponse.md)
 - [InvestmentResponse](docs/InvestmentResponse.md)
 - [InvestmentUpdate](docs/InvestmentUpdate.md)
 - [LocationInner](docs/LocationInner.md)
 - [MeasurementType](docs/MeasurementType.md)
 - [MetricCostsPerYearCreate](docs/MetricCostsPerYearCreate.md)
 - [MetricCostsPerYearResponse](docs/MetricCostsPerYearResponse.md)
 - [MetricCostsPerYearUpdate](docs/MetricCostsPerYearUpdate.md)
 - [MetricCreate](docs/MetricCreate.md)
 - [MetricPerformanceResponse](docs/MetricPerformanceResponse.md)
 - [MetricPerformanceYear](docs/MetricPerformanceYear.md)
 - [MetricResponse](docs/MetricResponse.md)
 - [MetricType](docs/MetricType.md)
 - [MetricUpdate](docs/MetricUpdate.md)
 - [MonetizedImpactDetailedResponse](docs/MonetizedImpactDetailedResponse.md)
 - [MonetizedImpactDetailedYear](docs/MonetizedImpactDetailedYear.md)
 - [MonetizedImpactMetricValue](docs/MonetizedImpactMetricValue.md)
 - [MonetizedImpactResponse](docs/MonetizedImpactResponse.md)
 - [MonetizedImpactYear](docs/MonetizedImpactYear.md)
 - [ObjectiveCreate](docs/ObjectiveCreate.md)
 - [ObjectiveResponse](docs/ObjectiveResponse.md)
 - [ObjectiveUpdate](docs/ObjectiveUpdate.md)
 - [ObjectiveWeightCreate](docs/ObjectiveWeightCreate.md)
 - [ObjectiveWeightResponse](docs/ObjectiveWeightResponse.md)
 - [ObjectiveWeightUpdate](docs/ObjectiveWeightUpdate.md)
 - [OptionChartKPI](docs/OptionChartKPI.md)
 - [OptionChartKPIsYearly](docs/OptionChartKPIsYearly.md)
 - [OptionCreate](docs/OptionCreate.md)
 - [OptionOverviewResponse](docs/OptionOverviewResponse.md)
 - [OptionResponse](docs/OptionResponse.md)
 - [OptionUpdate](docs/OptionUpdate.md)
 - [PortfolioBudgetExpenditureResponse](docs/PortfolioBudgetExpenditureResponse.md)
 - [PortfolioBudgetExpenditureYear](docs/PortfolioBudgetExpenditureYear.md)
 - [PortfolioBudgetUsageItem](docs/PortfolioBudgetUsageItem.md)
 - [PortfolioBulkDeleteRequest](docs/PortfolioBulkDeleteRequest.md)
 - [PortfolioCreate](docs/PortfolioCreate.md)
 - [PortfolioInvestmentBulkAddRequest](docs/PortfolioInvestmentBulkAddRequest.md)
 - [PortfolioInvestmentBulkAddResponse](docs/PortfolioInvestmentBulkAddResponse.md)
 - [PortfolioInvestmentBulkDeleteRequest](docs/PortfolioInvestmentBulkDeleteRequest.md)
 - [PortfolioInvestmentOverviewResponse](docs/PortfolioInvestmentOverviewResponse.md)
 - [PortfolioInvestmentResponse](docs/PortfolioInvestmentResponse.md)
 - [PortfolioKPIDistributionBudgetItem](docs/PortfolioKPIDistributionBudgetItem.md)
 - [PortfolioKPIDistributionResponse](docs/PortfolioKPIDistributionResponse.md)
 - [PortfolioKPIDistributionYearOverrun](docs/PortfolioKPIDistributionYearOverrun.md)
 - [PortfolioKPIDistributionYearValue](docs/PortfolioKPIDistributionYearValue.md)
 - [PortfolioKPIOverrunDistributionResponse](docs/PortfolioKPIOverrunDistributionResponse.md)
 - [PortfolioKPIResponse](docs/PortfolioKPIResponse.md)
 - [PortfolioOverviewItemResponse](docs/PortfolioOverviewItemResponse.md)
 - [PortfolioResponse](docs/PortfolioResponse.md)
 - [PortfolioUpdate](docs/PortfolioUpdate.md)
 - [PreferredOptionRequest](docs/PreferredOptionRequest.md)
 - [PreferredOptionResponse](docs/PreferredOptionResponse.md)
 - [PrioritizationOverviewResponse](docs/PrioritizationOverviewResponse.md)
 - [PrioritizationResultResponse](docs/PrioritizationResultResponse.md)
 - [PrioritizationResultsResponse](docs/PrioritizationResultsResponse.md)
 - [PrioritizationScenarioResponse](docs/PrioritizationScenarioResponse.md)
 - [PrioritizationScenarioRunRequest](docs/PrioritizationScenarioRunRequest.md)
 - [PrioritizationScenarioStatusResponse](docs/PrioritizationScenarioStatusResponse.md)
 - [ScenarioStatus](docs/ScenarioStatus.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValueFrameworkCreate](docs/ValueFrameworkCreate.md)
 - [ValueFrameworkResponse](docs/ValueFrameworkResponse.md)
 - [ValueFrameworkUpdate](docs/ValueFrameworkUpdate.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="OAuth2AuthorizationCodeBearer"></a>
### OAuth2AuthorizationCodeBearer

- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: None/protocol/openid-connect/auth
- **Scopes**: N/A


## Author




