@cosmotech/aip-client 0.4.0-dev5 → 1.0.0-dev2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -2
- package/api/budget-api.ts +1 -1
- package/api/default-api.ts +1 -1
- package/api/impact-api.ts +1 -1
- package/api/investment-api.ts +1 -1
- package/api/metric-api.ts +1 -1
- package/api/metric-costs-api.ts +1 -1
- package/api/metric-costs-per-year-api.ts +1 -1
- package/api/objective-api.ts +1 -1
- package/api/objective-weight-api.ts +1 -1
- package/api/objective-weights-api.ts +1 -1
- package/api/option-api.ts +9 -11
- package/api/portfolio-api.ts +1 -1
- package/api/portfolio-investment-api.ts +1 -1
- package/api/portfolio-kpiapi.ts +1 -1
- package/api/preferred-option-api.ts +1 -1
- package/api/prioritization-api.ts +1022 -0
- package/api/value-framework-api.ts +1 -1
- package/api/value-framework-costs-api.ts +1 -1
- package/api/value-framework-weights-api.ts +1 -1
- package/api.ts +2 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/budget-api.d.ts +1 -1
- package/dist/api/budget-api.js +1 -1
- package/dist/api/default-api.d.ts +1 -1
- package/dist/api/default-api.js +1 -1
- package/dist/api/impact-api.d.ts +1 -1
- package/dist/api/impact-api.js +1 -1
- package/dist/api/investment-api.d.ts +1 -1
- package/dist/api/investment-api.js +1 -1
- package/dist/api/metric-api.d.ts +1 -1
- package/dist/api/metric-api.js +1 -1
- package/dist/api/metric-costs-api.d.ts +1 -1
- package/dist/api/metric-costs-api.js +1 -1
- package/dist/api/metric-costs-per-year-api.d.ts +1 -1
- package/dist/api/metric-costs-per-year-api.js +1 -1
- package/dist/api/objective-api.d.ts +1 -1
- package/dist/api/objective-api.js +1 -1
- package/dist/api/objective-weight-api.d.ts +1 -1
- package/dist/api/objective-weight-api.js +1 -1
- package/dist/api/objective-weights-api.d.ts +1 -1
- package/dist/api/objective-weights-api.js +1 -1
- package/dist/api/option-api.d.ts +9 -9
- package/dist/api/option-api.js +5 -7
- package/dist/api/portfolio-api.d.ts +1 -1
- package/dist/api/portfolio-api.js +1 -1
- package/dist/api/portfolio-investment-api.d.ts +1 -1
- package/dist/api/portfolio-investment-api.js +1 -1
- package/dist/api/portfolio-kpiapi.d.ts +1 -1
- package/dist/api/portfolio-kpiapi.js +1 -1
- package/dist/api/preferred-option-api.d.ts +1 -1
- package/dist/api/preferred-option-api.js +1 -1
- package/dist/api/prioritization-api.d.ts +467 -0
- package/dist/api/prioritization-api.js +974 -0
- package/dist/api/value-framework-api.d.ts +1 -1
- package/dist/api/value-framework-api.js +1 -1
- package/dist/api/value-framework-costs-api.d.ts +1 -1
- package/dist/api/value-framework-costs-api.js +1 -1
- package/dist/api/value-framework-weights-api.d.ts +1 -1
- package/dist/api/value-framework-weights-api.js +1 -1
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/budget-api.d.ts +1 -1
- package/dist/esm/api/budget-api.js +1 -1
- package/dist/esm/api/default-api.d.ts +1 -1
- package/dist/esm/api/default-api.js +1 -1
- package/dist/esm/api/impact-api.d.ts +1 -1
- package/dist/esm/api/impact-api.js +1 -1
- package/dist/esm/api/investment-api.d.ts +1 -1
- package/dist/esm/api/investment-api.js +1 -1
- package/dist/esm/api/metric-api.d.ts +1 -1
- package/dist/esm/api/metric-api.js +1 -1
- package/dist/esm/api/metric-costs-api.d.ts +1 -1
- package/dist/esm/api/metric-costs-api.js +1 -1
- package/dist/esm/api/metric-costs-per-year-api.d.ts +1 -1
- package/dist/esm/api/metric-costs-per-year-api.js +1 -1
- package/dist/esm/api/objective-api.d.ts +1 -1
- package/dist/esm/api/objective-api.js +1 -1
- package/dist/esm/api/objective-weight-api.d.ts +1 -1
- package/dist/esm/api/objective-weight-api.js +1 -1
- package/dist/esm/api/objective-weights-api.d.ts +1 -1
- package/dist/esm/api/objective-weights-api.js +1 -1
- package/dist/esm/api/option-api.d.ts +9 -9
- package/dist/esm/api/option-api.js +5 -7
- package/dist/esm/api/portfolio-api.d.ts +1 -1
- package/dist/esm/api/portfolio-api.js +1 -1
- package/dist/esm/api/portfolio-investment-api.d.ts +1 -1
- package/dist/esm/api/portfolio-investment-api.js +1 -1
- package/dist/esm/api/portfolio-kpiapi.d.ts +1 -1
- package/dist/esm/api/portfolio-kpiapi.js +1 -1
- package/dist/esm/api/preferred-option-api.d.ts +1 -1
- package/dist/esm/api/preferred-option-api.js +1 -1
- package/dist/esm/api/prioritization-api.d.ts +467 -0
- package/dist/esm/api/prioritization-api.js +967 -0
- package/dist/esm/api/value-framework-api.d.ts +1 -1
- package/dist/esm/api/value-framework-api.js +1 -1
- package/dist/esm/api/value-framework-costs-api.d.ts +1 -1
- package/dist/esm/api/value-framework-costs-api.js +1 -1
- package/dist/esm/api/value-framework-weights-api.d.ts +1 -1
- package/dist/esm/api/value-framework-weights-api.js +1 -1
- package/dist/esm/api.d.ts +2 -1
- package/dist/esm/api.js +2 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/budget-bulk-delete-request.d.ts +1 -1
- package/dist/esm/models/budget-bulk-delete-request.js +1 -1
- package/dist/esm/models/budget-create.d.ts +1 -1
- package/dist/esm/models/budget-create.js +1 -1
- package/dist/esm/models/budget-investment-response.d.ts +1 -1
- package/dist/esm/models/budget-investment-response.js +1 -1
- package/dist/esm/models/budget-link-options-request.d.ts +1 -1
- package/dist/esm/models/budget-link-options-request.js +1 -1
- package/dist/esm/models/budget-option-response.d.ts +1 -1
- package/dist/esm/models/budget-option-response.js +1 -1
- package/dist/esm/models/budget-overview-response.d.ts +1 -1
- package/dist/esm/models/budget-overview-response.js +1 -1
- package/dist/esm/models/budget-response.d.ts +1 -1
- package/dist/esm/models/budget-response.js +1 -1
- package/dist/esm/models/budget-update.d.ts +1 -1
- package/dist/esm/models/budget-update.js +1 -1
- package/dist/esm/models/bulk-delete-request.d.ts +1 -1
- package/dist/esm/models/bulk-delete-request.js +1 -1
- package/dist/esm/models/evolution-type.d.ts +1 -1
- package/dist/esm/models/evolution-type.js +1 -1
- package/dist/esm/models/httpvalidation-error.d.ts +1 -1
- package/dist/esm/models/httpvalidation-error.js +1 -1
- package/dist/esm/models/impact-apiresponse.d.ts +1 -1
- package/dist/esm/models/impact-apiresponse.js +1 -1
- package/dist/esm/models/impact-bulk-item.d.ts +1 -1
- package/dist/esm/models/impact-bulk-item.js +1 -1
- package/dist/esm/models/impact-create.d.ts +1 -1
- package/dist/esm/models/impact-create.js +1 -1
- package/dist/esm/models/impact-update.d.ts +1 -1
- package/dist/esm/models/impact-update.js +1 -1
- package/dist/esm/models/index.d.ts +7 -0
- package/dist/esm/models/index.js +7 -0
- package/dist/esm/models/investment-create.d.ts +1 -1
- package/dist/esm/models/investment-create.js +1 -1
- package/dist/esm/models/investment-overview-response.d.ts +1 -1
- package/dist/esm/models/investment-overview-response.js +1 -1
- package/dist/esm/models/investment-response.d.ts +1 -1
- package/dist/esm/models/investment-response.js +1 -1
- package/dist/esm/models/investment-update.d.ts +1 -1
- package/dist/esm/models/investment-update.js +1 -1
- package/dist/esm/models/location-inner.d.ts +1 -1
- package/dist/esm/models/location-inner.js +1 -1
- package/dist/esm/models/measurement-type.d.ts +1 -1
- package/dist/esm/models/measurement-type.js +1 -1
- package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
- package/dist/esm/models/metric-costs-per-year-create.js +1 -1
- package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
- package/dist/esm/models/metric-costs-per-year-response.js +1 -1
- package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
- package/dist/esm/models/metric-costs-per-year-update.js +1 -1
- package/dist/esm/models/metric-create.d.ts +1 -1
- package/dist/esm/models/metric-create.js +1 -1
- package/dist/esm/models/metric-performance-response.d.ts +1 -1
- package/dist/esm/models/metric-performance-response.js +1 -1
- package/dist/esm/models/metric-performance-year.d.ts +1 -1
- package/dist/esm/models/metric-performance-year.js +1 -1
- package/dist/esm/models/metric-response.d.ts +1 -1
- package/dist/esm/models/metric-response.js +1 -1
- package/dist/esm/models/metric-type.d.ts +1 -1
- package/dist/esm/models/metric-type.js +1 -1
- package/dist/esm/models/metric-update.d.ts +1 -1
- package/dist/esm/models/metric-update.js +1 -1
- package/dist/esm/models/monetized-impact-detailed-response.d.ts +1 -1
- package/dist/esm/models/monetized-impact-detailed-response.js +1 -1
- package/dist/esm/models/monetized-impact-detailed-year.d.ts +1 -1
- package/dist/esm/models/monetized-impact-detailed-year.js +1 -1
- package/dist/esm/models/monetized-impact-metric-value.d.ts +2 -1
- package/dist/esm/models/monetized-impact-metric-value.js +1 -1
- package/dist/esm/models/monetized-impact-response.d.ts +1 -1
- package/dist/esm/models/monetized-impact-response.js +1 -1
- package/dist/esm/models/monetized-impact-year.d.ts +1 -1
- package/dist/esm/models/monetized-impact-year.js +1 -1
- package/dist/esm/models/objective-create.d.ts +1 -1
- package/dist/esm/models/objective-create.js +1 -1
- package/dist/esm/models/objective-response.d.ts +1 -1
- package/dist/esm/models/objective-response.js +1 -1
- package/dist/esm/models/objective-update.d.ts +1 -1
- package/dist/esm/models/objective-update.js +1 -1
- package/dist/esm/models/objective-weight-create.d.ts +1 -1
- package/dist/esm/models/objective-weight-create.js +1 -1
- package/dist/esm/models/objective-weight-response.d.ts +1 -1
- package/dist/esm/models/objective-weight-response.js +1 -1
- package/dist/esm/models/objective-weight-update.d.ts +1 -1
- package/dist/esm/models/objective-weight-update.js +1 -1
- package/dist/esm/models/option-chart-kpi.d.ts +1 -1
- package/dist/esm/models/option-chart-kpi.js +1 -1
- package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
- package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
- package/dist/esm/models/option-create.d.ts +1 -1
- package/dist/esm/models/option-create.js +1 -1
- package/dist/esm/models/option-overview-response.d.ts +1 -1
- package/dist/esm/models/option-overview-response.js +1 -1
- package/dist/esm/models/option-response.d.ts +1 -1
- package/dist/esm/models/option-response.js +1 -1
- package/dist/esm/models/option-update.d.ts +1 -1
- package/dist/esm/models/option-update.js +1 -1
- package/dist/esm/models/portfolio-budget-expenditure-response.d.ts +1 -1
- package/dist/esm/models/portfolio-budget-expenditure-response.js +1 -1
- package/dist/esm/models/portfolio-budget-expenditure-year.d.ts +1 -1
- package/dist/esm/models/portfolio-budget-expenditure-year.js +1 -1
- package/dist/esm/models/portfolio-budget-usage-item.d.ts +2 -1
- package/dist/esm/models/portfolio-budget-usage-item.js +1 -1
- package/dist/esm/models/portfolio-bulk-delete-request.d.ts +1 -1
- package/dist/esm/models/portfolio-bulk-delete-request.js +1 -1
- package/dist/esm/models/portfolio-create.d.ts +1 -1
- package/dist/esm/models/portfolio-create.js +1 -1
- package/dist/esm/models/portfolio-investment-bulk-add-request.d.ts +1 -1
- package/dist/esm/models/portfolio-investment-bulk-add-request.js +1 -1
- package/dist/esm/models/portfolio-investment-bulk-add-response.d.ts +1 -1
- package/dist/esm/models/portfolio-investment-bulk-add-response.js +1 -1
- package/dist/esm/models/portfolio-investment-bulk-delete-request.d.ts +1 -1
- package/dist/esm/models/portfolio-investment-bulk-delete-request.js +1 -1
- package/dist/esm/models/portfolio-investment-overview-response.d.ts +1 -1
- package/dist/esm/models/portfolio-investment-overview-response.js +1 -1
- package/dist/esm/models/portfolio-investment-response.d.ts +1 -1
- package/dist/esm/models/portfolio-investment-response.js +1 -1
- package/dist/esm/models/portfolio-kpidistribution-budget-item.d.ts +1 -1
- package/dist/esm/models/portfolio-kpidistribution-budget-item.js +1 -1
- package/dist/esm/models/portfolio-kpidistribution-response.d.ts +1 -1
- package/dist/esm/models/portfolio-kpidistribution-response.js +1 -1
- package/dist/esm/models/portfolio-kpidistribution-year-overrun.d.ts +1 -1
- package/dist/esm/models/portfolio-kpidistribution-year-overrun.js +1 -1
- package/dist/esm/models/portfolio-kpidistribution-year-value.d.ts +1 -1
- package/dist/esm/models/portfolio-kpidistribution-year-value.js +1 -1
- package/dist/esm/models/portfolio-kpioverrun-distribution-response.d.ts +1 -1
- package/dist/esm/models/portfolio-kpioverrun-distribution-response.js +1 -1
- package/dist/esm/models/portfolio-kpiresponse.d.ts +1 -1
- package/dist/esm/models/portfolio-kpiresponse.js +1 -1
- package/dist/esm/models/portfolio-overview-item-response.d.ts +1 -1
- package/dist/esm/models/portfolio-overview-item-response.js +1 -1
- package/dist/esm/models/portfolio-response.d.ts +1 -1
- package/dist/esm/models/portfolio-response.js +1 -1
- package/dist/esm/models/portfolio-update.d.ts +1 -1
- package/dist/esm/models/portfolio-update.js +1 -1
- package/dist/esm/models/preferred-option-request.d.ts +1 -1
- package/dist/esm/models/preferred-option-request.js +1 -1
- package/dist/esm/models/preferred-option-response.d.ts +1 -1
- package/dist/esm/models/preferred-option-response.js +1 -1
- package/dist/esm/models/prioritization-overview-response.d.ts +71 -0
- package/dist/esm/models/prioritization-overview-response.js +14 -0
- package/dist/esm/models/prioritization-result-response.d.ts +47 -0
- package/dist/esm/models/prioritization-result-response.js +14 -0
- package/dist/esm/models/prioritization-results-response.d.ts +19 -0
- package/dist/esm/models/prioritization-results-response.js +14 -0
- package/dist/esm/models/prioritization-scenario-response.d.ts +38 -0
- package/dist/esm/models/prioritization-scenario-response.js +14 -0
- package/dist/esm/models/prioritization-scenario-run-request.d.ts +24 -0
- package/dist/esm/models/prioritization-scenario-run-request.js +14 -0
- package/dist/esm/models/prioritization-scenario-status-response.d.ts +20 -0
- package/dist/esm/models/prioritization-scenario-status-response.js +14 -0
- package/dist/esm/models/scenario-status.d.ts +19 -0
- package/dist/esm/models/scenario-status.js +20 -0
- package/dist/esm/models/validation-error.d.ts +1 -1
- package/dist/esm/models/validation-error.js +1 -1
- package/dist/esm/models/value-framework-create.d.ts +1 -1
- package/dist/esm/models/value-framework-create.js +1 -1
- package/dist/esm/models/value-framework-response.d.ts +1 -1
- package/dist/esm/models/value-framework-response.js +1 -1
- package/dist/esm/models/value-framework-update.d.ts +1 -1
- package/dist/esm/models/value-framework-update.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/budget-bulk-delete-request.d.ts +1 -1
- package/dist/models/budget-bulk-delete-request.js +1 -1
- package/dist/models/budget-create.d.ts +1 -1
- package/dist/models/budget-create.js +1 -1
- package/dist/models/budget-investment-response.d.ts +1 -1
- package/dist/models/budget-investment-response.js +1 -1
- package/dist/models/budget-link-options-request.d.ts +1 -1
- package/dist/models/budget-link-options-request.js +1 -1
- package/dist/models/budget-option-response.d.ts +1 -1
- package/dist/models/budget-option-response.js +1 -1
- package/dist/models/budget-overview-response.d.ts +1 -1
- package/dist/models/budget-overview-response.js +1 -1
- package/dist/models/budget-response.d.ts +1 -1
- package/dist/models/budget-response.js +1 -1
- package/dist/models/budget-update.d.ts +1 -1
- package/dist/models/budget-update.js +1 -1
- package/dist/models/bulk-delete-request.d.ts +1 -1
- package/dist/models/bulk-delete-request.js +1 -1
- package/dist/models/evolution-type.d.ts +1 -1
- package/dist/models/evolution-type.js +1 -1
- package/dist/models/httpvalidation-error.d.ts +1 -1
- package/dist/models/httpvalidation-error.js +1 -1
- package/dist/models/impact-apiresponse.d.ts +1 -1
- package/dist/models/impact-apiresponse.js +1 -1
- package/dist/models/impact-bulk-item.d.ts +1 -1
- package/dist/models/impact-bulk-item.js +1 -1
- package/dist/models/impact-create.d.ts +1 -1
- package/dist/models/impact-create.js +1 -1
- package/dist/models/impact-update.d.ts +1 -1
- package/dist/models/impact-update.js +1 -1
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/investment-create.d.ts +1 -1
- package/dist/models/investment-create.js +1 -1
- package/dist/models/investment-overview-response.d.ts +1 -1
- package/dist/models/investment-overview-response.js +1 -1
- package/dist/models/investment-response.d.ts +1 -1
- package/dist/models/investment-response.js +1 -1
- package/dist/models/investment-update.d.ts +1 -1
- package/dist/models/investment-update.js +1 -1
- package/dist/models/location-inner.d.ts +1 -1
- package/dist/models/location-inner.js +1 -1
- package/dist/models/measurement-type.d.ts +1 -1
- package/dist/models/measurement-type.js +1 -1
- package/dist/models/metric-costs-per-year-create.d.ts +1 -1
- package/dist/models/metric-costs-per-year-create.js +1 -1
- package/dist/models/metric-costs-per-year-response.d.ts +1 -1
- package/dist/models/metric-costs-per-year-response.js +1 -1
- package/dist/models/metric-costs-per-year-update.d.ts +1 -1
- package/dist/models/metric-costs-per-year-update.js +1 -1
- package/dist/models/metric-create.d.ts +1 -1
- package/dist/models/metric-create.js +1 -1
- package/dist/models/metric-performance-response.d.ts +1 -1
- package/dist/models/metric-performance-response.js +1 -1
- package/dist/models/metric-performance-year.d.ts +1 -1
- package/dist/models/metric-performance-year.js +1 -1
- package/dist/models/metric-response.d.ts +1 -1
- package/dist/models/metric-response.js +1 -1
- package/dist/models/metric-type.d.ts +1 -1
- package/dist/models/metric-type.js +1 -1
- package/dist/models/metric-update.d.ts +1 -1
- package/dist/models/metric-update.js +1 -1
- package/dist/models/monetized-impact-detailed-response.d.ts +1 -1
- package/dist/models/monetized-impact-detailed-response.js +1 -1
- package/dist/models/monetized-impact-detailed-year.d.ts +1 -1
- package/dist/models/monetized-impact-detailed-year.js +1 -1
- package/dist/models/monetized-impact-metric-value.d.ts +2 -1
- package/dist/models/monetized-impact-metric-value.js +1 -1
- package/dist/models/monetized-impact-response.d.ts +1 -1
- package/dist/models/monetized-impact-response.js +1 -1
- package/dist/models/monetized-impact-year.d.ts +1 -1
- package/dist/models/monetized-impact-year.js +1 -1
- package/dist/models/objective-create.d.ts +1 -1
- package/dist/models/objective-create.js +1 -1
- package/dist/models/objective-response.d.ts +1 -1
- package/dist/models/objective-response.js +1 -1
- package/dist/models/objective-update.d.ts +1 -1
- package/dist/models/objective-update.js +1 -1
- package/dist/models/objective-weight-create.d.ts +1 -1
- package/dist/models/objective-weight-create.js +1 -1
- package/dist/models/objective-weight-response.d.ts +1 -1
- package/dist/models/objective-weight-response.js +1 -1
- package/dist/models/objective-weight-update.d.ts +1 -1
- package/dist/models/objective-weight-update.js +1 -1
- package/dist/models/option-chart-kpi.d.ts +1 -1
- package/dist/models/option-chart-kpi.js +1 -1
- package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
- package/dist/models/option-chart-kpis-yearly.js +1 -1
- package/dist/models/option-create.d.ts +1 -1
- package/dist/models/option-create.js +1 -1
- package/dist/models/option-overview-response.d.ts +1 -1
- package/dist/models/option-overview-response.js +1 -1
- package/dist/models/option-response.d.ts +1 -1
- package/dist/models/option-response.js +1 -1
- package/dist/models/option-update.d.ts +1 -1
- package/dist/models/option-update.js +1 -1
- package/dist/models/portfolio-budget-expenditure-response.d.ts +1 -1
- package/dist/models/portfolio-budget-expenditure-response.js +1 -1
- package/dist/models/portfolio-budget-expenditure-year.d.ts +1 -1
- package/dist/models/portfolio-budget-expenditure-year.js +1 -1
- package/dist/models/portfolio-budget-usage-item.d.ts +2 -1
- package/dist/models/portfolio-budget-usage-item.js +1 -1
- package/dist/models/portfolio-bulk-delete-request.d.ts +1 -1
- package/dist/models/portfolio-bulk-delete-request.js +1 -1
- package/dist/models/portfolio-create.d.ts +1 -1
- package/dist/models/portfolio-create.js +1 -1
- package/dist/models/portfolio-investment-bulk-add-request.d.ts +1 -1
- package/dist/models/portfolio-investment-bulk-add-request.js +1 -1
- package/dist/models/portfolio-investment-bulk-add-response.d.ts +1 -1
- package/dist/models/portfolio-investment-bulk-add-response.js +1 -1
- package/dist/models/portfolio-investment-bulk-delete-request.d.ts +1 -1
- package/dist/models/portfolio-investment-bulk-delete-request.js +1 -1
- package/dist/models/portfolio-investment-overview-response.d.ts +1 -1
- package/dist/models/portfolio-investment-overview-response.js +1 -1
- package/dist/models/portfolio-investment-response.d.ts +1 -1
- package/dist/models/portfolio-investment-response.js +1 -1
- package/dist/models/portfolio-kpidistribution-budget-item.d.ts +1 -1
- package/dist/models/portfolio-kpidistribution-budget-item.js +1 -1
- package/dist/models/portfolio-kpidistribution-response.d.ts +1 -1
- package/dist/models/portfolio-kpidistribution-response.js +1 -1
- package/dist/models/portfolio-kpidistribution-year-overrun.d.ts +1 -1
- package/dist/models/portfolio-kpidistribution-year-overrun.js +1 -1
- package/dist/models/portfolio-kpidistribution-year-value.d.ts +1 -1
- package/dist/models/portfolio-kpidistribution-year-value.js +1 -1
- package/dist/models/portfolio-kpioverrun-distribution-response.d.ts +1 -1
- package/dist/models/portfolio-kpioverrun-distribution-response.js +1 -1
- package/dist/models/portfolio-kpiresponse.d.ts +1 -1
- package/dist/models/portfolio-kpiresponse.js +1 -1
- package/dist/models/portfolio-overview-item-response.d.ts +1 -1
- package/dist/models/portfolio-overview-item-response.js +1 -1
- package/dist/models/portfolio-response.d.ts +1 -1
- package/dist/models/portfolio-response.js +1 -1
- package/dist/models/portfolio-update.d.ts +1 -1
- package/dist/models/portfolio-update.js +1 -1
- package/dist/models/preferred-option-request.d.ts +1 -1
- package/dist/models/preferred-option-request.js +1 -1
- package/dist/models/preferred-option-response.d.ts +1 -1
- package/dist/models/preferred-option-response.js +1 -1
- package/dist/models/prioritization-overview-response.d.ts +71 -0
- package/dist/models/prioritization-overview-response.js +15 -0
- package/dist/models/prioritization-result-response.d.ts +47 -0
- package/dist/models/prioritization-result-response.js +15 -0
- package/dist/models/prioritization-results-response.d.ts +19 -0
- package/dist/models/prioritization-results-response.js +15 -0
- package/dist/models/prioritization-scenario-response.d.ts +38 -0
- package/dist/models/prioritization-scenario-response.js +15 -0
- package/dist/models/prioritization-scenario-run-request.d.ts +24 -0
- package/dist/models/prioritization-scenario-run-request.js +15 -0
- package/dist/models/prioritization-scenario-status-response.d.ts +20 -0
- package/dist/models/prioritization-scenario-status-response.js +15 -0
- package/dist/models/scenario-status.d.ts +19 -0
- package/dist/models/scenario-status.js +23 -0
- package/dist/models/validation-error.d.ts +1 -1
- package/dist/models/validation-error.js +1 -1
- package/dist/models/value-framework-create.d.ts +1 -1
- package/dist/models/value-framework-create.js +1 -1
- package/dist/models/value-framework-response.d.ts +1 -1
- package/dist/models/value-framework-response.js +1 -1
- package/dist/models/value-framework-update.d.ts +1 -1
- package/dist/models/value-framework-update.js +1 -1
- package/docs/MonetizedImpactMetricValue.md +2 -0
- package/docs/OptionApi.md +2 -2
- package/docs/PortfolioBudgetUsageItem.md +2 -0
- package/docs/PrioritizationApi.md +705 -0
- package/docs/PrioritizationOverviewResponse.md +57 -0
- package/docs/PrioritizationResultResponse.md +39 -0
- package/docs/PrioritizationResultsResponse.md +23 -0
- package/docs/PrioritizationScenarioResponse.md +43 -0
- package/docs/PrioritizationScenarioRunRequest.md +23 -0
- package/docs/PrioritizationScenarioStatusResponse.md +25 -0
- package/docs/ScenarioStatus.md +16 -0
- package/index.ts +1 -1
- package/models/budget-bulk-delete-request.ts +1 -1
- package/models/budget-create.ts +1 -1
- package/models/budget-investment-response.ts +1 -1
- package/models/budget-link-options-request.ts +1 -1
- package/models/budget-option-response.ts +1 -1
- package/models/budget-overview-response.ts +1 -1
- package/models/budget-response.ts +1 -1
- package/models/budget-update.ts +1 -1
- package/models/bulk-delete-request.ts +1 -1
- package/models/evolution-type.ts +1 -1
- package/models/httpvalidation-error.ts +1 -1
- package/models/impact-apiresponse.ts +1 -1
- package/models/impact-bulk-item.ts +1 -1
- package/models/impact-create.ts +1 -1
- package/models/impact-update.ts +1 -1
- package/models/index.ts +7 -0
- package/models/investment-create.ts +1 -1
- package/models/investment-overview-response.ts +1 -1
- package/models/investment-response.ts +1 -1
- package/models/investment-update.ts +1 -1
- package/models/location-inner.ts +1 -1
- package/models/measurement-type.ts +1 -1
- package/models/metric-costs-per-year-create.ts +1 -1
- package/models/metric-costs-per-year-response.ts +1 -1
- package/models/metric-costs-per-year-update.ts +1 -1
- package/models/metric-create.ts +1 -1
- package/models/metric-performance-response.ts +1 -1
- package/models/metric-performance-year.ts +1 -1
- package/models/metric-response.ts +1 -1
- package/models/metric-type.ts +1 -1
- package/models/metric-update.ts +1 -1
- package/models/monetized-impact-detailed-response.ts +1 -1
- package/models/monetized-impact-detailed-year.ts +1 -1
- package/models/monetized-impact-metric-value.ts +2 -1
- package/models/monetized-impact-response.ts +1 -1
- package/models/monetized-impact-year.ts +1 -1
- package/models/objective-create.ts +1 -1
- package/models/objective-response.ts +1 -1
- package/models/objective-update.ts +1 -1
- package/models/objective-weight-create.ts +1 -1
- package/models/objective-weight-response.ts +1 -1
- package/models/objective-weight-update.ts +1 -1
- package/models/option-chart-kpi.ts +1 -1
- package/models/option-chart-kpis-yearly.ts +1 -1
- package/models/option-create.ts +1 -1
- package/models/option-overview-response.ts +1 -1
- package/models/option-response.ts +1 -1
- package/models/option-update.ts +1 -1
- package/models/portfolio-budget-expenditure-response.ts +1 -1
- package/models/portfolio-budget-expenditure-year.ts +1 -1
- package/models/portfolio-budget-usage-item.ts +2 -1
- package/models/portfolio-bulk-delete-request.ts +1 -1
- package/models/portfolio-create.ts +1 -1
- package/models/portfolio-investment-bulk-add-request.ts +1 -1
- package/models/portfolio-investment-bulk-add-response.ts +1 -1
- package/models/portfolio-investment-bulk-delete-request.ts +1 -1
- package/models/portfolio-investment-overview-response.ts +1 -1
- package/models/portfolio-investment-response.ts +1 -1
- package/models/portfolio-kpidistribution-budget-item.ts +1 -1
- package/models/portfolio-kpidistribution-response.ts +1 -1
- package/models/portfolio-kpidistribution-year-overrun.ts +1 -1
- package/models/portfolio-kpidistribution-year-value.ts +1 -1
- package/models/portfolio-kpioverrun-distribution-response.ts +1 -1
- package/models/portfolio-kpiresponse.ts +1 -1
- package/models/portfolio-overview-item-response.ts +1 -1
- package/models/portfolio-response.ts +1 -1
- package/models/portfolio-update.ts +1 -1
- package/models/preferred-option-request.ts +1 -1
- package/models/preferred-option-response.ts +1 -1
- package/models/prioritization-overview-response.ts +77 -0
- package/models/prioritization-result-response.ts +53 -0
- package/models/prioritization-results-response.ts +27 -0
- package/models/prioritization-scenario-response.ts +48 -0
- package/models/prioritization-scenario-run-request.ts +30 -0
- package/models/prioritization-scenario-status-response.ts +30 -0
- package/models/scenario-status.ts +29 -0
- package/models/validation-error.ts +1 -1
- package/models/value-framework-create.ts +1 -1
- package/models/value-framework-response.ts +1 -1
- package/models/value-framework-update.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,1022 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Asset Investment Planning
|
|
5
|
+
* API for Asset Investment Planning
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0-dev2
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import type { MonetizedImpactDetailedResponse } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { MonetizedImpactResponse } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { PortfolioBudgetExpenditureResponse } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
import type { PortfolioBudgetUsageItem } from '../models';
|
|
32
|
+
// @ts-ignore
|
|
33
|
+
import type { PrioritizationOverviewResponse } from '../models';
|
|
34
|
+
// @ts-ignore
|
|
35
|
+
import type { PrioritizationResultsResponse } from '../models';
|
|
36
|
+
// @ts-ignore
|
|
37
|
+
import type { PrioritizationScenarioResponse } from '../models';
|
|
38
|
+
// @ts-ignore
|
|
39
|
+
import type { PrioritizationScenarioRunRequest } from '../models';
|
|
40
|
+
// @ts-ignore
|
|
41
|
+
import type { PrioritizationScenarioStatusResponse } from '../models';
|
|
42
|
+
/**
|
|
43
|
+
* PrioritizationApi - axios parameter creator
|
|
44
|
+
*/
|
|
45
|
+
export const PrioritizationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
|
+
return {
|
|
47
|
+
/**
|
|
48
|
+
* Abort the currently running prioritization for this portfolio.
|
|
49
|
+
* @summary Abort a running prioritization
|
|
50
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
abortScenario: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
56
|
+
assertParamExists('abortScenario', 'portfolioId', portfolioId)
|
|
57
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/abort`
|
|
58
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
59
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
61
|
+
let baseOptions;
|
|
62
|
+
if (configuration) {
|
|
63
|
+
baseOptions = configuration.baseOptions;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
67
|
+
const localVarHeaderParameter = {} as any;
|
|
68
|
+
const localVarQueryParameter = {} as any;
|
|
69
|
+
|
|
70
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
71
|
+
// oauth required
|
|
72
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
73
|
+
|
|
74
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
75
|
+
|
|
76
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
77
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
78
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
79
|
+
|
|
80
|
+
return {
|
|
81
|
+
url: toPathString(localVarUrlObj),
|
|
82
|
+
options: localVarRequestOptions,
|
|
83
|
+
};
|
|
84
|
+
},
|
|
85
|
+
/**
|
|
86
|
+
* Delete the scenario and all its results for this portfolio.
|
|
87
|
+
* @summary Delete the prioritization scenario
|
|
88
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
deleteScenario: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
94
|
+
assertParamExists('deleteScenario', 'portfolioId', portfolioId)
|
|
95
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/`
|
|
96
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
97
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
98
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
99
|
+
let baseOptions;
|
|
100
|
+
if (configuration) {
|
|
101
|
+
baseOptions = configuration.baseOptions;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
105
|
+
const localVarHeaderParameter = {} as any;
|
|
106
|
+
const localVarQueryParameter = {} as any;
|
|
107
|
+
|
|
108
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
109
|
+
// oauth required
|
|
110
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
114
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
115
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
116
|
+
|
|
117
|
+
return {
|
|
118
|
+
url: toPathString(localVarUrlObj),
|
|
119
|
+
options: localVarRequestOptions,
|
|
120
|
+
};
|
|
121
|
+
},
|
|
122
|
+
/**
|
|
123
|
+
* Get the current prioritization scenario for this portfolio, including config and status.
|
|
124
|
+
* @summary Get the prioritization scenario
|
|
125
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
getScenario: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
131
|
+
assertParamExists('getScenario', 'portfolioId', portfolioId)
|
|
132
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/`
|
|
133
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
134
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
135
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
136
|
+
let baseOptions;
|
|
137
|
+
if (configuration) {
|
|
138
|
+
baseOptions = configuration.baseOptions;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
142
|
+
const localVarHeaderParameter = {} as any;
|
|
143
|
+
const localVarQueryParameter = {} as any;
|
|
144
|
+
|
|
145
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
146
|
+
// oauth required
|
|
147
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
148
|
+
|
|
149
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
150
|
+
|
|
151
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
153
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
154
|
+
|
|
155
|
+
return {
|
|
156
|
+
url: toPathString(localVarUrlObj),
|
|
157
|
+
options: localVarRequestOptions,
|
|
158
|
+
};
|
|
159
|
+
},
|
|
160
|
+
/**
|
|
161
|
+
* Year-by-year expenditure of performed investments linked to a specific budget within this scenario.
|
|
162
|
+
* @summary Per-year expenditure for one budget (performed investments)
|
|
163
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
164
|
+
* @param {string} budgetId UUID of the budget
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
getScenarioBudgetExpenditure: async (portfolioId: string, budgetId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
169
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
170
|
+
assertParamExists('getScenarioBudgetExpenditure', 'portfolioId', portfolioId)
|
|
171
|
+
// verify required parameter 'budgetId' is not null or undefined
|
|
172
|
+
assertParamExists('getScenarioBudgetExpenditure', 'budgetId', budgetId)
|
|
173
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/budget-expenditure/{budget_id}`
|
|
174
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
175
|
+
.replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
|
|
176
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
177
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
178
|
+
let baseOptions;
|
|
179
|
+
if (configuration) {
|
|
180
|
+
baseOptions = configuration.baseOptions;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
184
|
+
const localVarHeaderParameter = {} as any;
|
|
185
|
+
const localVarQueryParameter = {} as any;
|
|
186
|
+
|
|
187
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
188
|
+
// oauth required
|
|
189
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
190
|
+
|
|
191
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
192
|
+
|
|
193
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
194
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
195
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
196
|
+
|
|
197
|
+
return {
|
|
198
|
+
url: toPathString(localVarUrlObj),
|
|
199
|
+
options: localVarRequestOptions,
|
|
200
|
+
};
|
|
201
|
+
},
|
|
202
|
+
/**
|
|
203
|
+
* Year-by-year expenditure for every budget referenced by a performed investment in the run.
|
|
204
|
+
* @summary Per-budget expenditure for performed investments
|
|
205
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
getScenarioBudgetExpenditureAll: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
210
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
211
|
+
assertParamExists('getScenarioBudgetExpenditureAll', 'portfolioId', portfolioId)
|
|
212
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/budget-expenditure-all`
|
|
213
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
214
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
215
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
216
|
+
let baseOptions;
|
|
217
|
+
if (configuration) {
|
|
218
|
+
baseOptions = configuration.baseOptions;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
222
|
+
const localVarHeaderParameter = {} as any;
|
|
223
|
+
const localVarQueryParameter = {} as any;
|
|
224
|
+
|
|
225
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
226
|
+
// oauth required
|
|
227
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
228
|
+
|
|
229
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
230
|
+
|
|
231
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
232
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
233
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
234
|
+
|
|
235
|
+
return {
|
|
236
|
+
url: toPathString(localVarUrlObj),
|
|
237
|
+
options: localVarRequestOptions,
|
|
238
|
+
};
|
|
239
|
+
},
|
|
240
|
+
/**
|
|
241
|
+
* Year-by-year expenditure of performed investments that have no budget assigned within this scenario.
|
|
242
|
+
* @summary Per-year expenditure for performed investments with no budget
|
|
243
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
*/
|
|
247
|
+
getScenarioBudgetExpenditureNoBudget: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
248
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
249
|
+
assertParamExists('getScenarioBudgetExpenditureNoBudget', 'portfolioId', portfolioId)
|
|
250
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/budget-expenditure-no-budget`
|
|
251
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
252
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
253
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
254
|
+
let baseOptions;
|
|
255
|
+
if (configuration) {
|
|
256
|
+
baseOptions = configuration.baseOptions;
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
260
|
+
const localVarHeaderParameter = {} as any;
|
|
261
|
+
const localVarQueryParameter = {} as any;
|
|
262
|
+
|
|
263
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
264
|
+
// oauth required
|
|
265
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
266
|
+
|
|
267
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
268
|
+
|
|
269
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
270
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
271
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
272
|
+
|
|
273
|
+
return {
|
|
274
|
+
url: toPathString(localVarUrlObj),
|
|
275
|
+
options: localVarRequestOptions,
|
|
276
|
+
};
|
|
277
|
+
},
|
|
278
|
+
/**
|
|
279
|
+
* 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.
|
|
280
|
+
* @summary Budget usage for performed investments
|
|
281
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
282
|
+
* @param {*} [options] Override http request option.
|
|
283
|
+
* @throws {RequiredError}
|
|
284
|
+
*/
|
|
285
|
+
getScenarioBudgetUsage: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
286
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
287
|
+
assertParamExists('getScenarioBudgetUsage', 'portfolioId', portfolioId)
|
|
288
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/budget-usage`
|
|
289
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
290
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
291
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
292
|
+
let baseOptions;
|
|
293
|
+
if (configuration) {
|
|
294
|
+
baseOptions = configuration.baseOptions;
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
298
|
+
const localVarHeaderParameter = {} as any;
|
|
299
|
+
const localVarQueryParameter = {} as any;
|
|
300
|
+
|
|
301
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
302
|
+
// oauth required
|
|
303
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
304
|
+
|
|
305
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
306
|
+
|
|
307
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
308
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
309
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
310
|
+
|
|
311
|
+
return {
|
|
312
|
+
url: toPathString(localVarUrlObj),
|
|
313
|
+
options: localVarRequestOptions,
|
|
314
|
+
};
|
|
315
|
+
},
|
|
316
|
+
/**
|
|
317
|
+
* Aggregate KPIs comparing the prioritization run against the full portfolio (Overview tab of the scenario results).
|
|
318
|
+
* @summary Run vs portfolio comparison KPIs
|
|
319
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
320
|
+
* @param {*} [options] Override http request option.
|
|
321
|
+
* @throws {RequiredError}
|
|
322
|
+
*/
|
|
323
|
+
getScenarioOverview: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
324
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
325
|
+
assertParamExists('getScenarioOverview', 'portfolioId', portfolioId)
|
|
326
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/overview`
|
|
327
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
328
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
329
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
330
|
+
let baseOptions;
|
|
331
|
+
if (configuration) {
|
|
332
|
+
baseOptions = configuration.baseOptions;
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
336
|
+
const localVarHeaderParameter = {} as any;
|
|
337
|
+
const localVarQueryParameter = {} as any;
|
|
338
|
+
|
|
339
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
340
|
+
// oauth required
|
|
341
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
342
|
+
|
|
343
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
344
|
+
|
|
345
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
346
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
347
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
348
|
+
|
|
349
|
+
return {
|
|
350
|
+
url: toPathString(localVarUrlObj),
|
|
351
|
+
options: localVarRequestOptions,
|
|
352
|
+
};
|
|
353
|
+
},
|
|
354
|
+
/**
|
|
355
|
+
* Get the results of the last successful prioritization run. Returns the list of investments with their rank and performed/unperformed status.
|
|
356
|
+
* @summary Get prioritization results
|
|
357
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
358
|
+
* @param {*} [options] Override http request option.
|
|
359
|
+
* @throws {RequiredError}
|
|
360
|
+
*/
|
|
361
|
+
getScenarioResults: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
362
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
363
|
+
assertParamExists('getScenarioResults', 'portfolioId', portfolioId)
|
|
364
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/results`
|
|
365
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
366
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
367
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
368
|
+
let baseOptions;
|
|
369
|
+
if (configuration) {
|
|
370
|
+
baseOptions = configuration.baseOptions;
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
374
|
+
const localVarHeaderParameter = {} as any;
|
|
375
|
+
const localVarQueryParameter = {} as any;
|
|
376
|
+
|
|
377
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
378
|
+
// oauth required
|
|
379
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
380
|
+
|
|
381
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
382
|
+
|
|
383
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
384
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
385
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
386
|
+
|
|
387
|
+
return {
|
|
388
|
+
url: toPathString(localVarUrlObj),
|
|
389
|
+
options: localVarRequestOptions,
|
|
390
|
+
};
|
|
391
|
+
},
|
|
392
|
+
/**
|
|
393
|
+
* Lightweight polling endpoint to check the status of a prioritization run.
|
|
394
|
+
* @summary Get prioritization run status
|
|
395
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
396
|
+
* @param {*} [options] Override http request option.
|
|
397
|
+
* @throws {RequiredError}
|
|
398
|
+
*/
|
|
399
|
+
getScenarioStatus: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
400
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
401
|
+
assertParamExists('getScenarioStatus', 'portfolioId', portfolioId)
|
|
402
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/status`
|
|
403
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
404
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
405
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
406
|
+
let baseOptions;
|
|
407
|
+
if (configuration) {
|
|
408
|
+
baseOptions = configuration.baseOptions;
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
412
|
+
const localVarHeaderParameter = {} as any;
|
|
413
|
+
const localVarQueryParameter = {} as any;
|
|
414
|
+
|
|
415
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
416
|
+
// oauth required
|
|
417
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
418
|
+
|
|
419
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
420
|
+
|
|
421
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
422
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
423
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
424
|
+
|
|
425
|
+
return {
|
|
426
|
+
url: toPathString(localVarUrlObj),
|
|
427
|
+
options: localVarRequestOptions,
|
|
428
|
+
};
|
|
429
|
+
},
|
|
430
|
+
/**
|
|
431
|
+
* 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.
|
|
432
|
+
* @summary Monetized impact filtered to performed investments
|
|
433
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
434
|
+
* @param {*} [options] Override http request option.
|
|
435
|
+
* @throws {RequiredError}
|
|
436
|
+
*/
|
|
437
|
+
getScenarioValueFrameworkImpact: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
438
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
439
|
+
assertParamExists('getScenarioValueFrameworkImpact', 'portfolioId', portfolioId)
|
|
440
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/value-framework-impact`
|
|
441
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
442
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
443
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
444
|
+
let baseOptions;
|
|
445
|
+
if (configuration) {
|
|
446
|
+
baseOptions = configuration.baseOptions;
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
450
|
+
const localVarHeaderParameter = {} as any;
|
|
451
|
+
const localVarQueryParameter = {} as any;
|
|
452
|
+
|
|
453
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
454
|
+
// oauth required
|
|
455
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
456
|
+
|
|
457
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
458
|
+
|
|
459
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
460
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
461
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
462
|
+
|
|
463
|
+
return {
|
|
464
|
+
url: toPathString(localVarUrlObj),
|
|
465
|
+
options: localVarRequestOptions,
|
|
466
|
+
};
|
|
467
|
+
},
|
|
468
|
+
/**
|
|
469
|
+
* 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.
|
|
470
|
+
* @summary Monetized impact (split by metric) filtered to performed investments
|
|
471
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
*/
|
|
475
|
+
getScenarioValueFrameworkImpactDetailed: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
476
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
477
|
+
assertParamExists('getScenarioValueFrameworkImpactDetailed', 'portfolioId', portfolioId)
|
|
478
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/value-framework-impact/detailed`
|
|
479
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
480
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
481
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
482
|
+
let baseOptions;
|
|
483
|
+
if (configuration) {
|
|
484
|
+
baseOptions = configuration.baseOptions;
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
488
|
+
const localVarHeaderParameter = {} as any;
|
|
489
|
+
const localVarQueryParameter = {} as any;
|
|
490
|
+
|
|
491
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
492
|
+
// oauth required
|
|
493
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
494
|
+
|
|
495
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
496
|
+
|
|
497
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
498
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
499
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
500
|
+
|
|
501
|
+
return {
|
|
502
|
+
url: toPathString(localVarUrlObj),
|
|
503
|
+
options: localVarRequestOptions,
|
|
504
|
+
};
|
|
505
|
+
},
|
|
506
|
+
/**
|
|
507
|
+
* 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.
|
|
508
|
+
* @summary Create/update and run a prioritization scenario
|
|
509
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
510
|
+
* @param {PrioritizationScenarioRunRequest} prioritizationScenarioRunRequest
|
|
511
|
+
* @param {*} [options] Override http request option.
|
|
512
|
+
* @throws {RequiredError}
|
|
513
|
+
*/
|
|
514
|
+
runScenario: async (portfolioId: string, prioritizationScenarioRunRequest: PrioritizationScenarioRunRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
515
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
516
|
+
assertParamExists('runScenario', 'portfolioId', portfolioId)
|
|
517
|
+
// verify required parameter 'prioritizationScenarioRunRequest' is not null or undefined
|
|
518
|
+
assertParamExists('runScenario', 'prioritizationScenarioRunRequest', prioritizationScenarioRunRequest)
|
|
519
|
+
const localVarPath = `/portfolio/{portfolio_id}/scenario/run`
|
|
520
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
521
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
522
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
523
|
+
let baseOptions;
|
|
524
|
+
if (configuration) {
|
|
525
|
+
baseOptions = configuration.baseOptions;
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
529
|
+
const localVarHeaderParameter = {} as any;
|
|
530
|
+
const localVarQueryParameter = {} as any;
|
|
531
|
+
|
|
532
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
533
|
+
// oauth required
|
|
534
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
535
|
+
|
|
536
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
537
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
538
|
+
|
|
539
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
540
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
541
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
542
|
+
localVarRequestOptions.data = serializeDataIfNeeded(prioritizationScenarioRunRequest, localVarRequestOptions, configuration)
|
|
543
|
+
|
|
544
|
+
return {
|
|
545
|
+
url: toPathString(localVarUrlObj),
|
|
546
|
+
options: localVarRequestOptions,
|
|
547
|
+
};
|
|
548
|
+
},
|
|
549
|
+
}
|
|
550
|
+
};
|
|
551
|
+
|
|
552
|
+
/**
|
|
553
|
+
* PrioritizationApi - functional programming interface
|
|
554
|
+
*/
|
|
555
|
+
export const PrioritizationApiFp = function(configuration?: Configuration) {
|
|
556
|
+
const localVarAxiosParamCreator = PrioritizationApiAxiosParamCreator(configuration)
|
|
557
|
+
return {
|
|
558
|
+
/**
|
|
559
|
+
* Abort the currently running prioritization for this portfolio.
|
|
560
|
+
* @summary Abort a running prioritization
|
|
561
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
562
|
+
* @param {*} [options] Override http request option.
|
|
563
|
+
* @throws {RequiredError}
|
|
564
|
+
*/
|
|
565
|
+
async abortScenario(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrioritizationScenarioResponse>> {
|
|
566
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.abortScenario(portfolioId, options);
|
|
567
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
568
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.abortScenario']?.[localVarOperationServerIndex]?.url;
|
|
569
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
570
|
+
},
|
|
571
|
+
/**
|
|
572
|
+
* Delete the scenario and all its results for this portfolio.
|
|
573
|
+
* @summary Delete the prioritization scenario
|
|
574
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
575
|
+
* @param {*} [options] Override http request option.
|
|
576
|
+
* @throws {RequiredError}
|
|
577
|
+
*/
|
|
578
|
+
async deleteScenario(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
579
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteScenario(portfolioId, options);
|
|
580
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
581
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.deleteScenario']?.[localVarOperationServerIndex]?.url;
|
|
582
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
583
|
+
},
|
|
584
|
+
/**
|
|
585
|
+
* Get the current prioritization scenario for this portfolio, including config and status.
|
|
586
|
+
* @summary Get the prioritization scenario
|
|
587
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
588
|
+
* @param {*} [options] Override http request option.
|
|
589
|
+
* @throws {RequiredError}
|
|
590
|
+
*/
|
|
591
|
+
async getScenario(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrioritizationScenarioResponse>> {
|
|
592
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenario(portfolioId, options);
|
|
593
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
594
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenario']?.[localVarOperationServerIndex]?.url;
|
|
595
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
596
|
+
},
|
|
597
|
+
/**
|
|
598
|
+
* Year-by-year expenditure of performed investments linked to a specific budget within this scenario.
|
|
599
|
+
* @summary Per-year expenditure for one budget (performed investments)
|
|
600
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
601
|
+
* @param {string} budgetId UUID of the budget
|
|
602
|
+
* @param {*} [options] Override http request option.
|
|
603
|
+
* @throws {RequiredError}
|
|
604
|
+
*/
|
|
605
|
+
async getScenarioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>> {
|
|
606
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioBudgetExpenditure(portfolioId, budgetId, options);
|
|
607
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
608
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioBudgetExpenditure']?.[localVarOperationServerIndex]?.url;
|
|
609
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
610
|
+
},
|
|
611
|
+
/**
|
|
612
|
+
* Year-by-year expenditure for every budget referenced by a performed investment in the run.
|
|
613
|
+
* @summary Per-budget expenditure for performed investments
|
|
614
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
615
|
+
* @param {*} [options] Override http request option.
|
|
616
|
+
* @throws {RequiredError}
|
|
617
|
+
*/
|
|
618
|
+
async getScenarioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetExpenditureResponse>>> {
|
|
619
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioBudgetExpenditureAll(portfolioId, options);
|
|
620
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
621
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioBudgetExpenditureAll']?.[localVarOperationServerIndex]?.url;
|
|
622
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
623
|
+
},
|
|
624
|
+
/**
|
|
625
|
+
* Year-by-year expenditure of performed investments that have no budget assigned within this scenario.
|
|
626
|
+
* @summary Per-year expenditure for performed investments with no budget
|
|
627
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
628
|
+
* @param {*} [options] Override http request option.
|
|
629
|
+
* @throws {RequiredError}
|
|
630
|
+
*/
|
|
631
|
+
async getScenarioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>> {
|
|
632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioBudgetExpenditureNoBudget(portfolioId, options);
|
|
633
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
634
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioBudgetExpenditureNoBudget']?.[localVarOperationServerIndex]?.url;
|
|
635
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
636
|
+
},
|
|
637
|
+
/**
|
|
638
|
+
* 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.
|
|
639
|
+
* @summary Budget usage for performed investments
|
|
640
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
641
|
+
* @param {*} [options] Override http request option.
|
|
642
|
+
* @throws {RequiredError}
|
|
643
|
+
*/
|
|
644
|
+
async getScenarioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetUsageItem>>> {
|
|
645
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioBudgetUsage(portfolioId, options);
|
|
646
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
647
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioBudgetUsage']?.[localVarOperationServerIndex]?.url;
|
|
648
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
649
|
+
},
|
|
650
|
+
/**
|
|
651
|
+
* Aggregate KPIs comparing the prioritization run against the full portfolio (Overview tab of the scenario results).
|
|
652
|
+
* @summary Run vs portfolio comparison KPIs
|
|
653
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
*/
|
|
657
|
+
async getScenarioOverview(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrioritizationOverviewResponse>> {
|
|
658
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioOverview(portfolioId, options);
|
|
659
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
660
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioOverview']?.[localVarOperationServerIndex]?.url;
|
|
661
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
662
|
+
},
|
|
663
|
+
/**
|
|
664
|
+
* Get the results of the last successful prioritization run. Returns the list of investments with their rank and performed/unperformed status.
|
|
665
|
+
* @summary Get prioritization results
|
|
666
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
667
|
+
* @param {*} [options] Override http request option.
|
|
668
|
+
* @throws {RequiredError}
|
|
669
|
+
*/
|
|
670
|
+
async getScenarioResults(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrioritizationResultsResponse>> {
|
|
671
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioResults(portfolioId, options);
|
|
672
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
673
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioResults']?.[localVarOperationServerIndex]?.url;
|
|
674
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
675
|
+
},
|
|
676
|
+
/**
|
|
677
|
+
* Lightweight polling endpoint to check the status of a prioritization run.
|
|
678
|
+
* @summary Get prioritization run status
|
|
679
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
680
|
+
* @param {*} [options] Override http request option.
|
|
681
|
+
* @throws {RequiredError}
|
|
682
|
+
*/
|
|
683
|
+
async getScenarioStatus(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrioritizationScenarioStatusResponse>> {
|
|
684
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioStatus(portfolioId, options);
|
|
685
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
686
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioStatus']?.[localVarOperationServerIndex]?.url;
|
|
687
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
688
|
+
},
|
|
689
|
+
/**
|
|
690
|
+
* 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.
|
|
691
|
+
* @summary Monetized impact filtered to performed investments
|
|
692
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
693
|
+
* @param {*} [options] Override http request option.
|
|
694
|
+
* @throws {RequiredError}
|
|
695
|
+
*/
|
|
696
|
+
async getScenarioValueFrameworkImpact(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactResponse>> {
|
|
697
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioValueFrameworkImpact(portfolioId, options);
|
|
698
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
699
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioValueFrameworkImpact']?.[localVarOperationServerIndex]?.url;
|
|
700
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
701
|
+
},
|
|
702
|
+
/**
|
|
703
|
+
* 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.
|
|
704
|
+
* @summary Monetized impact (split by metric) filtered to performed investments
|
|
705
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
706
|
+
* @param {*} [options] Override http request option.
|
|
707
|
+
* @throws {RequiredError}
|
|
708
|
+
*/
|
|
709
|
+
async getScenarioValueFrameworkImpactDetailed(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactDetailedResponse>> {
|
|
710
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getScenarioValueFrameworkImpactDetailed(portfolioId, options);
|
|
711
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
712
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.getScenarioValueFrameworkImpactDetailed']?.[localVarOperationServerIndex]?.url;
|
|
713
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
714
|
+
},
|
|
715
|
+
/**
|
|
716
|
+
* 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.
|
|
717
|
+
* @summary Create/update and run a prioritization scenario
|
|
718
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
719
|
+
* @param {PrioritizationScenarioRunRequest} prioritizationScenarioRunRequest
|
|
720
|
+
* @param {*} [options] Override http request option.
|
|
721
|
+
* @throws {RequiredError}
|
|
722
|
+
*/
|
|
723
|
+
async runScenario(portfolioId: string, prioritizationScenarioRunRequest: PrioritizationScenarioRunRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrioritizationScenarioResponse>> {
|
|
724
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.runScenario(portfolioId, prioritizationScenarioRunRequest, options);
|
|
725
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
726
|
+
const localVarOperationServerBasePath = operationServerMap['PrioritizationApi.runScenario']?.[localVarOperationServerIndex]?.url;
|
|
727
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
728
|
+
},
|
|
729
|
+
}
|
|
730
|
+
};
|
|
731
|
+
|
|
732
|
+
/**
|
|
733
|
+
* PrioritizationApi - factory interface
|
|
734
|
+
*/
|
|
735
|
+
export const PrioritizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
736
|
+
const localVarFp = PrioritizationApiFp(configuration)
|
|
737
|
+
return {
|
|
738
|
+
/**
|
|
739
|
+
* Abort the currently running prioritization for this portfolio.
|
|
740
|
+
* @summary Abort a running prioritization
|
|
741
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
742
|
+
* @param {*} [options] Override http request option.
|
|
743
|
+
* @throws {RequiredError}
|
|
744
|
+
*/
|
|
745
|
+
abortScenario(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrioritizationScenarioResponse> {
|
|
746
|
+
return localVarFp.abortScenario(portfolioId, options).then((request) => request(axios, basePath));
|
|
747
|
+
},
|
|
748
|
+
/**
|
|
749
|
+
* Delete the scenario and all its results for this portfolio.
|
|
750
|
+
* @summary Delete the prioritization scenario
|
|
751
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
752
|
+
* @param {*} [options] Override http request option.
|
|
753
|
+
* @throws {RequiredError}
|
|
754
|
+
*/
|
|
755
|
+
deleteScenario(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
756
|
+
return localVarFp.deleteScenario(portfolioId, options).then((request) => request(axios, basePath));
|
|
757
|
+
},
|
|
758
|
+
/**
|
|
759
|
+
* Get the current prioritization scenario for this portfolio, including config and status.
|
|
760
|
+
* @summary Get the prioritization scenario
|
|
761
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
762
|
+
* @param {*} [options] Override http request option.
|
|
763
|
+
* @throws {RequiredError}
|
|
764
|
+
*/
|
|
765
|
+
getScenario(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrioritizationScenarioResponse> {
|
|
766
|
+
return localVarFp.getScenario(portfolioId, options).then((request) => request(axios, basePath));
|
|
767
|
+
},
|
|
768
|
+
/**
|
|
769
|
+
* Year-by-year expenditure of performed investments linked to a specific budget within this scenario.
|
|
770
|
+
* @summary Per-year expenditure for one budget (performed investments)
|
|
771
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
772
|
+
* @param {string} budgetId UUID of the budget
|
|
773
|
+
* @param {*} [options] Override http request option.
|
|
774
|
+
* @throws {RequiredError}
|
|
775
|
+
*/
|
|
776
|
+
getScenarioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse> {
|
|
777
|
+
return localVarFp.getScenarioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(axios, basePath));
|
|
778
|
+
},
|
|
779
|
+
/**
|
|
780
|
+
* Year-by-year expenditure for every budget referenced by a performed investment in the run.
|
|
781
|
+
* @summary Per-budget expenditure for performed investments
|
|
782
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
783
|
+
* @param {*} [options] Override http request option.
|
|
784
|
+
* @throws {RequiredError}
|
|
785
|
+
*/
|
|
786
|
+
getScenarioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioBudgetExpenditureResponse>> {
|
|
787
|
+
return localVarFp.getScenarioBudgetExpenditureAll(portfolioId, options).then((request) => request(axios, basePath));
|
|
788
|
+
},
|
|
789
|
+
/**
|
|
790
|
+
* Year-by-year expenditure of performed investments that have no budget assigned within this scenario.
|
|
791
|
+
* @summary Per-year expenditure for performed investments with no budget
|
|
792
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
793
|
+
* @param {*} [options] Override http request option.
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
*/
|
|
796
|
+
getScenarioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse> {
|
|
797
|
+
return localVarFp.getScenarioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(axios, basePath));
|
|
798
|
+
},
|
|
799
|
+
/**
|
|
800
|
+
* 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.
|
|
801
|
+
* @summary Budget usage for performed investments
|
|
802
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
803
|
+
* @param {*} [options] Override http request option.
|
|
804
|
+
* @throws {RequiredError}
|
|
805
|
+
*/
|
|
806
|
+
getScenarioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioBudgetUsageItem>> {
|
|
807
|
+
return localVarFp.getScenarioBudgetUsage(portfolioId, options).then((request) => request(axios, basePath));
|
|
808
|
+
},
|
|
809
|
+
/**
|
|
810
|
+
* Aggregate KPIs comparing the prioritization run against the full portfolio (Overview tab of the scenario results).
|
|
811
|
+
* @summary Run vs portfolio comparison KPIs
|
|
812
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
813
|
+
* @param {*} [options] Override http request option.
|
|
814
|
+
* @throws {RequiredError}
|
|
815
|
+
*/
|
|
816
|
+
getScenarioOverview(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrioritizationOverviewResponse> {
|
|
817
|
+
return localVarFp.getScenarioOverview(portfolioId, options).then((request) => request(axios, basePath));
|
|
818
|
+
},
|
|
819
|
+
/**
|
|
820
|
+
* Get the results of the last successful prioritization run. Returns the list of investments with their rank and performed/unperformed status.
|
|
821
|
+
* @summary Get prioritization results
|
|
822
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
823
|
+
* @param {*} [options] Override http request option.
|
|
824
|
+
* @throws {RequiredError}
|
|
825
|
+
*/
|
|
826
|
+
getScenarioResults(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrioritizationResultsResponse> {
|
|
827
|
+
return localVarFp.getScenarioResults(portfolioId, options).then((request) => request(axios, basePath));
|
|
828
|
+
},
|
|
829
|
+
/**
|
|
830
|
+
* Lightweight polling endpoint to check the status of a prioritization run.
|
|
831
|
+
* @summary Get prioritization run status
|
|
832
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
833
|
+
* @param {*} [options] Override http request option.
|
|
834
|
+
* @throws {RequiredError}
|
|
835
|
+
*/
|
|
836
|
+
getScenarioStatus(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrioritizationScenarioStatusResponse> {
|
|
837
|
+
return localVarFp.getScenarioStatus(portfolioId, options).then((request) => request(axios, basePath));
|
|
838
|
+
},
|
|
839
|
+
/**
|
|
840
|
+
* 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.
|
|
841
|
+
* @summary Monetized impact filtered to performed investments
|
|
842
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
843
|
+
* @param {*} [options] Override http request option.
|
|
844
|
+
* @throws {RequiredError}
|
|
845
|
+
*/
|
|
846
|
+
getScenarioValueFrameworkImpact(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactResponse> {
|
|
847
|
+
return localVarFp.getScenarioValueFrameworkImpact(portfolioId, options).then((request) => request(axios, basePath));
|
|
848
|
+
},
|
|
849
|
+
/**
|
|
850
|
+
* 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.
|
|
851
|
+
* @summary Monetized impact (split by metric) filtered to performed investments
|
|
852
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
853
|
+
* @param {*} [options] Override http request option.
|
|
854
|
+
* @throws {RequiredError}
|
|
855
|
+
*/
|
|
856
|
+
getScenarioValueFrameworkImpactDetailed(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactDetailedResponse> {
|
|
857
|
+
return localVarFp.getScenarioValueFrameworkImpactDetailed(portfolioId, options).then((request) => request(axios, basePath));
|
|
858
|
+
},
|
|
859
|
+
/**
|
|
860
|
+
* 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.
|
|
861
|
+
* @summary Create/update and run a prioritization scenario
|
|
862
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
863
|
+
* @param {PrioritizationScenarioRunRequest} prioritizationScenarioRunRequest
|
|
864
|
+
* @param {*} [options] Override http request option.
|
|
865
|
+
* @throws {RequiredError}
|
|
866
|
+
*/
|
|
867
|
+
runScenario(portfolioId: string, prioritizationScenarioRunRequest: PrioritizationScenarioRunRequest, options?: RawAxiosRequestConfig): AxiosPromise<PrioritizationScenarioResponse> {
|
|
868
|
+
return localVarFp.runScenario(portfolioId, prioritizationScenarioRunRequest, options).then((request) => request(axios, basePath));
|
|
869
|
+
},
|
|
870
|
+
};
|
|
871
|
+
};
|
|
872
|
+
|
|
873
|
+
/**
|
|
874
|
+
* PrioritizationApi - object-oriented interface
|
|
875
|
+
*/
|
|
876
|
+
export class PrioritizationApi extends BaseAPI {
|
|
877
|
+
/**
|
|
878
|
+
* Abort the currently running prioritization for this portfolio.
|
|
879
|
+
* @summary Abort a running prioritization
|
|
880
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
881
|
+
* @param {*} [options] Override http request option.
|
|
882
|
+
* @throws {RequiredError}
|
|
883
|
+
*/
|
|
884
|
+
public abortScenario(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
885
|
+
return PrioritizationApiFp(this.configuration).abortScenario(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
/**
|
|
889
|
+
* Delete the scenario and all its results for this portfolio.
|
|
890
|
+
* @summary Delete the prioritization scenario
|
|
891
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
892
|
+
* @param {*} [options] Override http request option.
|
|
893
|
+
* @throws {RequiredError}
|
|
894
|
+
*/
|
|
895
|
+
public deleteScenario(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
896
|
+
return PrioritizationApiFp(this.configuration).deleteScenario(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* Get the current prioritization scenario for this portfolio, including config and status.
|
|
901
|
+
* @summary Get the prioritization scenario
|
|
902
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
903
|
+
* @param {*} [options] Override http request option.
|
|
904
|
+
* @throws {RequiredError}
|
|
905
|
+
*/
|
|
906
|
+
public getScenario(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
907
|
+
return PrioritizationApiFp(this.configuration).getScenario(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* Year-by-year expenditure of performed investments linked to a specific budget within this scenario.
|
|
912
|
+
* @summary Per-year expenditure for one budget (performed investments)
|
|
913
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
914
|
+
* @param {string} budgetId UUID of the budget
|
|
915
|
+
* @param {*} [options] Override http request option.
|
|
916
|
+
* @throws {RequiredError}
|
|
917
|
+
*/
|
|
918
|
+
public getScenarioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig) {
|
|
919
|
+
return PrioritizationApiFp(this.configuration).getScenarioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(this.axios, this.basePath));
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
/**
|
|
923
|
+
* Year-by-year expenditure for every budget referenced by a performed investment in the run.
|
|
924
|
+
* @summary Per-budget expenditure for performed investments
|
|
925
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
public getScenarioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
930
|
+
return PrioritizationApiFp(this.configuration).getScenarioBudgetExpenditureAll(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
931
|
+
}
|
|
932
|
+
|
|
933
|
+
/**
|
|
934
|
+
* Year-by-year expenditure of performed investments that have no budget assigned within this scenario.
|
|
935
|
+
* @summary Per-year expenditure for performed investments with no budget
|
|
936
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
937
|
+
* @param {*} [options] Override http request option.
|
|
938
|
+
* @throws {RequiredError}
|
|
939
|
+
*/
|
|
940
|
+
public getScenarioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
941
|
+
return PrioritizationApiFp(this.configuration).getScenarioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* 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.
|
|
946
|
+
* @summary Budget usage for performed investments
|
|
947
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
948
|
+
* @param {*} [options] Override http request option.
|
|
949
|
+
* @throws {RequiredError}
|
|
950
|
+
*/
|
|
951
|
+
public getScenarioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
952
|
+
return PrioritizationApiFp(this.configuration).getScenarioBudgetUsage(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
953
|
+
}
|
|
954
|
+
|
|
955
|
+
/**
|
|
956
|
+
* Aggregate KPIs comparing the prioritization run against the full portfolio (Overview tab of the scenario results).
|
|
957
|
+
* @summary Run vs portfolio comparison KPIs
|
|
958
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
959
|
+
* @param {*} [options] Override http request option.
|
|
960
|
+
* @throws {RequiredError}
|
|
961
|
+
*/
|
|
962
|
+
public getScenarioOverview(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
963
|
+
return PrioritizationApiFp(this.configuration).getScenarioOverview(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
/**
|
|
967
|
+
* Get the results of the last successful prioritization run. Returns the list of investments with their rank and performed/unperformed status.
|
|
968
|
+
* @summary Get prioritization results
|
|
969
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
970
|
+
* @param {*} [options] Override http request option.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
*/
|
|
973
|
+
public getScenarioResults(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
974
|
+
return PrioritizationApiFp(this.configuration).getScenarioResults(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
/**
|
|
978
|
+
* Lightweight polling endpoint to check the status of a prioritization run.
|
|
979
|
+
* @summary Get prioritization run status
|
|
980
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
981
|
+
* @param {*} [options] Override http request option.
|
|
982
|
+
* @throws {RequiredError}
|
|
983
|
+
*/
|
|
984
|
+
public getScenarioStatus(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
985
|
+
return PrioritizationApiFp(this.configuration).getScenarioStatus(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* 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.
|
|
990
|
+
* @summary Monetized impact filtered to performed investments
|
|
991
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
992
|
+
* @param {*} [options] Override http request option.
|
|
993
|
+
* @throws {RequiredError}
|
|
994
|
+
*/
|
|
995
|
+
public getScenarioValueFrameworkImpact(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
996
|
+
return PrioritizationApiFp(this.configuration).getScenarioValueFrameworkImpact(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
997
|
+
}
|
|
998
|
+
|
|
999
|
+
/**
|
|
1000
|
+
* 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.
|
|
1001
|
+
* @summary Monetized impact (split by metric) filtered to performed investments
|
|
1002
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
1003
|
+
* @param {*} [options] Override http request option.
|
|
1004
|
+
* @throws {RequiredError}
|
|
1005
|
+
*/
|
|
1006
|
+
public getScenarioValueFrameworkImpactDetailed(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
1007
|
+
return PrioritizationApiFp(this.configuration).getScenarioValueFrameworkImpactDetailed(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
1008
|
+
}
|
|
1009
|
+
|
|
1010
|
+
/**
|
|
1011
|
+
* 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.
|
|
1012
|
+
* @summary Create/update and run a prioritization scenario
|
|
1013
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
1014
|
+
* @param {PrioritizationScenarioRunRequest} prioritizationScenarioRunRequest
|
|
1015
|
+
* @param {*} [options] Override http request option.
|
|
1016
|
+
* @throws {RequiredError}
|
|
1017
|
+
*/
|
|
1018
|
+
public runScenario(portfolioId: string, prioritizationScenarioRunRequest: PrioritizationScenarioRunRequest, options?: RawAxiosRequestConfig) {
|
|
1019
|
+
return PrioritizationApiFp(this.configuration).runScenario(portfolioId, prioritizationScenarioRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1020
|
+
}
|
|
1021
|
+
}
|
|
1022
|
+
|