@cosmotech/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @cosmotech/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BudgetApi | bulkDeleteBudgets | POST /budget/bulk-delete | Bulk delete budgets BudgetApi | deleteBudget | DELETE /budget/{budget_id} | Delete a budget BudgetApi | getBudgetById | GET /budget/{budget_id} | Get a budget by ID BudgetApi | getBudgetInvestments | GET /budget/{budget_id}/investments | List investments linked to this budget via options BudgetApi | getBudgetOptions | GET /budget/{budget_id}/options | List options linked to this budget BudgetApi | getBudgetOverview | GET /budget/{budget_id}/overview | Get budget overview BudgetApi | getBudgets | GET /budget/ | List all budgets BudgetApi | linkOptionsToBudget | POST /budget/{budget_id}/link-options | Bulk-link options to this budget BudgetApi | listAvailableOptions | GET /budget/list-available-options | List all options available to be added to a budget BudgetApi | patchBudget | PATCH /budget/{budget_id} | Partially update a budget BudgetApi | postBudget | POST /budget/ | Create a budget DefaultApi | root | GET /about | Root ImpactApi | bulkUpsertImpactsForOption | PUT /investment/{investment_id}/option/{option_id}/impact/ | Bulk upsert impacts for this option ImpactApi | createImpactForOption | POST /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option ImpactApi | deleteImpactForOption | DELETE /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option ImpactApi | getImpactForOption | GET /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option ImpactApi | getImpactsForOption | GET /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option ImpactApi | patchImpactForOption | PATCH /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option InvestmentApi | bulkDeleteInvestments | POST /investment/bulk-delete | Bulk delete investments InvestmentApi | deleteInvestment | DELETE /investment/{investment_id} | Delete an investment InvestmentApi | getInvestmentById | GET /investment/{investment_id} | Get an investment by ID InvestmentApi | getInvestments | GET /investment/ | List investments InvestmentApi | getInvestmentsOverview | GET /investment/overview | Investment overview table InvestmentApi | patchInvestment | PATCH /investment/{investment_id} | Partially update an investment InvestmentApi | postInvestment | POST /investment/ | Create an investment MetricApi | createMetricForObjective | POST /objective/{objective_id}/metric/ | Create a metric for this objective MetricApi | deleteMetricForObjective | DELETE /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective MetricApi | getMetricForObjective | GET /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective MetricApi | getMetricsForObjective | GET /objective/{objective_id}/metric/ | List metrics for this objective MetricApi | patchMetricForObjective | PATCH /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective MetricCostsApi | getCostsForMetric | GET /metric/{metric_id}/costs/ | List all metric costs for a metric MetricCostsPerYearApi | createMetricCostForFramework | POST /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework MetricCostsPerYearApi | deleteMetricCostForFramework | DELETE /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework MetricCostsPerYearApi | getMetricCostForFramework | GET /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework MetricCostsPerYearApi | getMetricCostsForFramework | GET /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework MetricCostsPerYearApi | patchMetricCostForFramework | PATCH /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework ObjectiveApi | deleteObjective | DELETE /objective/{objective_id} | Delete an objective ObjectiveApi | getObjectiveById | GET /objective/{objective_id} | Get an objective by ID ObjectiveApi | getObjectives | GET /objective/ | List objectives ObjectiveApi | patchObjective | PATCH /objective/{objective_id} | Partially update an objective ObjectiveApi | postObjective | POST /objective/ | Create an objective ObjectiveWeightApi | createObjectiveWeightForFramework | POST /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework ObjectiveWeightApi | deleteObjectiveWeightForFramework | DELETE /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework ObjectiveWeightApi | getObjectiveWeightForFramework | GET /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework ObjectiveWeightApi | getObjectiveWeightsForFramework | GET /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework ObjectiveWeightApi | patchObjectiveWeightForFramework | PATCH /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework ObjectiveWeightsApi | getWeightsForObjective | GET /objective/{objective_id}/weights/ | List all objective weights for an objective OptionApi | createOptionForInvestment | POST /investment/{investment_id}/option/ | Create an option for this investment OptionApi | deleteOptionForInvestment | DELETE /investment/{investment_id}/option/{option_id} | Delete an option for this investment OptionApi | getOptionForInvestment | GET /investment/{investment_id}/option/{option_id} | Get an option for this investment OptionApi | getOptionKpis | GET /investment/{investment_id}/option/{option_id}/kpis | Get the kpis for a given option inside a value framework OptionApi | getOptionsForInvestment | GET /investment/{investment_id}/option/ | List options for this investment OptionApi | getOptionsOverview | GET /investment/{investment_id}/option/overview | Option overview table for this investment OptionApi | patchOptionForInvestment | PATCH /investment/{investment_id}/option/{option_id} | Partially update an option for this investment PortfolioApi | bulkDeletePortfolios | POST /portfolio/bulk-delete | Bulk delete portfolios PortfolioApi | deletePortfolio | DELETE /portfolio/{portfolio_id} | Delete a portfolio PortfolioApi | getPortfolioById | GET /portfolio/{portfolio_id} | Get a portfolio by ID PortfolioApi | getPortfolioOverview | GET /portfolio/overview | Portfolio overview with KPIs PortfolioApi | getPortfolios | GET /portfolio/ | List portfolios PortfolioApi | patchPortfolio | PATCH /portfolio/{portfolio_id} | Partially update a portfolio PortfolioApi | postPortfolio | POST /portfolio/ | Create a portfolio PortfolioInvestmentApi | addInvestmentToPortfolio | POST /portfolio/{portfolio_id}/investment/{investment_id} | Add an investment to this portfolio PortfolioInvestmentApi | bulkAddInvestmentsToPortfolio | POST /portfolio/{portfolio_id}/investment/bulk | Bulk add investments to this portfolio PortfolioInvestmentApi | bulkRemoveInvestmentsFromPortfolio | POST /portfolio/{portfolio_id}/investment/bulk-delete | Bulk remove investments from this portfolio PortfolioInvestmentApi | getInvestmentForPortfolio | GET /portfolio/{portfolio_id}/investment/{investment_id} | Get an investment link in this portfolio PortfolioInvestmentApi | getInvestmentsForPortfolio | GET /portfolio/{portfolio_id}/investment/ | List investments in this portfolio PortfolioInvestmentApi | getPortfolioInvestmentsOverview | GET /portfolio/{portfolio_id}/investment/overview | Investment overview table for this portfolio PortfolioInvestmentApi | removeInvestmentFromPortfolio | DELETE /portfolio/{portfolio_id}/investment/{investment_id} | Remove an investment from this portfolio PortfolioKPIApi | getCapexDistribution | GET /portfolio/{portfolio_id}/kpis/capex-distribution | CAPEX year-by-year distribution PortfolioKPIApi | getInvestmentsDistribution | GET /portfolio/{portfolio_id}/kpis/investments-distribution | Investment count year-by-year distribution PortfolioKPIApi | getKpiOverrunDistribution | GET /portfolio/{portfolio_id}/kpis/overrun-distribution | Budget overrun year-by-year distribution PortfolioKPIApi | getNpvDistribution | GET /portfolio/{portfolio_id}/kpis/npv-distribution | NPV year-by-year distribution PortfolioKPIApi | getPortfolioBudgetExpenditure | GET /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure PortfolioKPIApi | getPortfolioBudgetExpenditureAll | GET /portfolio/{portfolio_id}/budget-expenditure-all | Budget year-by-year expenditure for all budgets PortfolioKPIApi | getPortfolioBudgetExpenditureNoBudget | GET /portfolio/{portfolio_id}/budget-expenditure-no-budget | Year-by-year expenditure for options with no budget PortfolioKPIApi | getPortfolioBudgetUsage | GET /portfolio/{portfolio_id}/budget-usage | Budget usage summary PortfolioKPIApi | getPortfolioKpis | GET /portfolio/{portfolio_id}/kpis | Get portfolio KPIs PortfolioKPIApi | getPortfolioMetricPerformance | GET /portfolio/{portfolio_id}/metric-performance/{metric_id} | Metric performance over time PortfolioKPIApi | getPortfolioMonetizedImpact | GET /portfolio/{portfolio_id}/monetized-impact | Portfolio monetized impact over time PortfolioKPIApi | getPortfolioMonetizedImpactDetailed | GET /portfolio/{portfolio_id}/monetized-impact/detailed | Portfolio monetized impact over time (split by metric) PreferredOptionApi | getPreferredOption | GET /investment/{investment_id}/preferred_option | Get the preferred option for an investment PreferredOptionApi | setPreferredOption | POST /investment/{investment_id}/preferred_option | Set the preferred option for an investment PrioritizationApi | abortScenario | POST /portfolio/{portfolio_id}/scenario/abort | Abort a running prioritization PrioritizationApi | deleteScenario | DELETE /portfolio/{portfolio_id}/scenario/ | Delete the prioritization scenario PrioritizationApi | getScenario | GET /portfolio/{portfolio_id}/scenario/ | Get the prioritization scenario PrioritizationApi | getScenarioBudgetExpenditure | GET /portfolio/{portfolio_id}/scenario/budget-expenditure/{budget_id} | Per-year expenditure for one budget (performed investments) PrioritizationApi | getScenarioBudgetExpenditureAll | GET /portfolio/{portfolio_id}/scenario/budget-expenditure-all | Per-budget expenditure for performed investments PrioritizationApi | getScenarioBudgetExpenditureNoBudget | GET /portfolio/{portfolio_id}/scenario/budget-expenditure-no-budget | Per-year expenditure for performed investments with no budget PrioritizationApi | getScenarioBudgetUsage | GET /portfolio/{portfolio_id}/scenario/budget-usage | Budget usage for performed investments PrioritizationApi | getScenarioCapexDistribution | GET /portfolio/{portfolio_id}/scenario/capex-distribution | CAPEX year-by-year distribution for performed investments PrioritizationApi | getScenarioMetricPerformance | GET /portfolio/{portfolio_id}/scenario/metric-performance/{metric_id} | Metric performance over time for performed investments PrioritizationApi | getScenarioOverview | GET /portfolio/{portfolio_id}/scenario/overview | Run vs portfolio comparison KPIs PrioritizationApi | getScenarioResults | GET /portfolio/{portfolio_id}/scenario/results | Get prioritization results PrioritizationApi | getScenarioStatus | GET /portfolio/{portfolio_id}/scenario/status | Get prioritization run status PrioritizationApi | getScenarioValueFrameworkImpact | GET /portfolio/{portfolio_id}/scenario/value-framework-impact | Monetized impact filtered to performed investments PrioritizationApi | getScenarioValueFrameworkImpactDetailed | GET /portfolio/{portfolio_id}/scenario/value-framework-impact/detailed | Monetized impact (split by metric) filtered to performed investments PrioritizationApi | runScenario | POST /portfolio/{portfolio_id}/scenario/run | Create/update and run a prioritization scenario ValueFrameworkApi | deleteValueFramework | DELETE /value_framework/{value_framework_id} | Delete a value framework ValueFrameworkApi | getValueFrameworkById | GET /value_framework/{value_framework_id} | Get a value framework by ID ValueFrameworkApi | getValueFrameworks | GET /value_framework/ | List value frameworks ValueFrameworkApi | patchValueFramework | PATCH /value_framework/{value_framework_id} | Partially update a value framework ValueFrameworkApi | postValueFramework | POST /value_framework/ | Create a value framework ValueFrameworkCostsApi | getCostsForValueFramework | GET /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework ValueFrameworkCostsApi | getCostsForValueFrameworkByMetric | GET /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric ValueFrameworkWeightsApi | getWeightsForValueFramework | GET /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework

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