cosmotech-asset-investment-planning-client

API for Asset Investment Planning

This Python package is automatically generated by the OpenAPI Generator 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:

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:

import cosmotech.aip_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import cosmotech.aip_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2AuthorizationCodeBearer

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

Author