@cosmotech/aip-client 0.4.0-dev2 → 0.4.0-dev5
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 +21 -13
- package/api/budget-api.ts +52 -49
- package/api/default-api.ts +1 -1
- package/api/impact-api.ts +1 -1
- package/api/investment-api.ts +13 -15
- 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 +19 -18
- package/api/portfolio-api.ts +21 -20
- package/api/portfolio-investment-api.ts +83 -1
- package/api/portfolio-kpiapi.ts +308 -100
- package/api/preferred-option-api.ts +1 -1
- 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 +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/budget-api.d.ts +35 -35
- package/dist/api/budget-api.js +35 -35
- 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 +13 -13
- package/dist/api/investment-api.js +9 -11
- 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 +13 -13
- package/dist/api/option-api.js +14 -14
- package/dist/api/portfolio-api.d.ts +13 -13
- package/dist/api/portfolio-api.js +20 -20
- package/dist/api/portfolio-investment-api.d.ts +38 -1
- package/dist/api/portfolio-investment-api.js +77 -1
- package/dist/api/portfolio-kpiapi.d.ts +150 -61
- package/dist/api/portfolio-kpiapi.js +281 -88
- package/dist/api/preferred-option-api.d.ts +1 -1
- package/dist/api/preferred-option-api.js +1 -1
- 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 +1 -1
- package/dist/api.js +1 -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 +35 -35
- package/dist/esm/api/budget-api.js +35 -35
- 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 +13 -13
- package/dist/esm/api/investment-api.js +9 -11
- 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 +13 -13
- package/dist/esm/api/option-api.js +14 -14
- package/dist/esm/api/portfolio-api.d.ts +13 -13
- package/dist/esm/api/portfolio-api.js +20 -20
- package/dist/esm/api/portfolio-investment-api.d.ts +38 -1
- package/dist/esm/api/portfolio-investment-api.js +77 -1
- package/dist/esm/api/portfolio-kpiapi.d.ts +150 -61
- package/dist/esm/api/portfolio-kpiapi.js +281 -88
- 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/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 +1 -1
- package/dist/esm/api.js +1 -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 +2 -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 +4 -0
- package/dist/esm/models/index.js +4 -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 +18 -0
- package/dist/esm/models/monetized-impact-detailed-response.js +14 -0
- package/dist/esm/models/monetized-impact-detailed-year.d.ts +20 -0
- package/dist/esm/models/monetized-impact-detailed-year.js +14 -0
- package/dist/esm/models/monetized-impact-metric-value.d.ts +19 -0
- package/dist/esm/models/monetized-impact-metric-value.js +14 -0
- 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 +1 -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 +30 -0
- package/dist/esm/models/portfolio-investment-overview-response.js +14 -0
- 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 +2 -2
- 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/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 +2 -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 +4 -0
- package/dist/models/index.js +4 -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 +18 -0
- package/dist/models/monetized-impact-detailed-response.js +15 -0
- package/dist/models/monetized-impact-detailed-year.d.ts +20 -0
- package/dist/models/monetized-impact-detailed-year.js +15 -0
- package/dist/models/monetized-impact-metric-value.d.ts +19 -0
- package/dist/models/monetized-impact-metric-value.js +15 -0
- 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 +1 -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 +30 -0
- package/dist/models/portfolio-investment-overview-response.js +15 -0
- 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 +2 -2
- 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/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/BudgetApi.md +16 -15
- package/docs/BudgetOptionResponse.md +2 -0
- package/docs/InvestmentApi.md +3 -3
- package/docs/MonetizedImpactDetailedResponse.md +21 -0
- package/docs/MonetizedImpactDetailedYear.md +25 -0
- package/docs/MonetizedImpactMetricValue.md +25 -0
- package/docs/OptionApi.md +4 -4
- package/docs/PortfolioApi.md +7 -7
- package/docs/PortfolioInvestmentApi.md +56 -0
- package/docs/PortfolioInvestmentOverviewResponse.md +35 -0
- package/docs/PortfolioKPIApi.md +183 -30
- package/docs/PortfolioKPIDistributionResponse.md +1 -1
- 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 +2 -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 +4 -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 +26 -0
- package/models/monetized-impact-detailed-year.ts +28 -0
- package/models/monetized-impact-metric-value.ts +25 -0
- 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 +1 -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 +36 -0
- package/models/portfolio-investment-response.ts +1 -1
- package/models/portfolio-kpidistribution-budget-item.ts +1 -1
- package/models/portfolio-kpidistribution-response.ts +2 -2
- 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/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
package/api/portfolio-kpiapi.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Asset Investment Planning
|
|
5
5
|
* API for Asset Investment Planning
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.4.0-
|
|
7
|
+
* The version of the OpenAPI document: 0.4.0-dev5
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
import type { MetricPerformanceResponse } from '../models';
|
|
26
26
|
// @ts-ignore
|
|
27
|
+
import type { MonetizedImpactDetailedResponse } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
27
29
|
import type { MonetizedImpactResponse } from '../models';
|
|
28
30
|
// @ts-ignore
|
|
29
31
|
import type { PortfolioBudgetExpenditureResponse } from '../models';
|
|
@@ -44,18 +46,14 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
44
46
|
* Total cost of preferred options starting each year.
|
|
45
47
|
* @summary CAPEX year-by-year distribution
|
|
46
48
|
* @param {string} portfolioId UUID of the portfolio
|
|
47
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
48
49
|
* @param {*} [options] Override http request option.
|
|
49
50
|
* @throws {RequiredError}
|
|
50
51
|
*/
|
|
51
|
-
getCapexDistribution: async (portfolioId: string,
|
|
52
|
+
getCapexDistribution: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
52
53
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
53
54
|
assertParamExists('getCapexDistribution', 'portfolioId', portfolioId)
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution`
|
|
57
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
58
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
55
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/capex-distribution`
|
|
56
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
59
57
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60
58
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
61
59
|
let baseOptions;
|
|
@@ -86,18 +84,14 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
86
84
|
* Count of investments with a preferred option starting each year.
|
|
87
85
|
* @summary Investment count year-by-year distribution
|
|
88
86
|
* @param {string} portfolioId UUID of the portfolio
|
|
89
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
90
87
|
* @param {*} [options] Override http request option.
|
|
91
88
|
* @throws {RequiredError}
|
|
92
89
|
*/
|
|
93
|
-
getInvestmentsDistribution: async (portfolioId: string,
|
|
90
|
+
getInvestmentsDistribution: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
94
91
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
95
92
|
assertParamExists('getInvestmentsDistribution', 'portfolioId', portfolioId)
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution`
|
|
99
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
100
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
93
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/investments-distribution`
|
|
94
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
101
95
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
102
96
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
103
97
|
let baseOptions;
|
|
@@ -128,18 +122,14 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
128
122
|
* Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
|
|
129
123
|
* @summary Budget overrun year-by-year distribution
|
|
130
124
|
* @param {string} portfolioId UUID of the portfolio
|
|
131
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
132
125
|
* @param {*} [options] Override http request option.
|
|
133
126
|
* @throws {RequiredError}
|
|
134
127
|
*/
|
|
135
|
-
getKpiOverrunDistribution: async (portfolioId: string,
|
|
128
|
+
getKpiOverrunDistribution: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
136
129
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
137
130
|
assertParamExists('getKpiOverrunDistribution', 'portfolioId', portfolioId)
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution`
|
|
141
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
142
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
131
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/overrun-distribution`
|
|
132
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
143
133
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
144
134
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
145
135
|
let baseOptions;
|
|
@@ -167,21 +157,18 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
167
157
|
};
|
|
168
158
|
},
|
|
169
159
|
/**
|
|
170
|
-
* Sum of final NPV of preferred options starting each year.
|
|
160
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
171
161
|
* @summary NPV year-by-year distribution
|
|
172
162
|
* @param {string} portfolioId UUID of the portfolio
|
|
173
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
163
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
174
164
|
* @param {*} [options] Override http request option.
|
|
175
165
|
* @throws {RequiredError}
|
|
176
166
|
*/
|
|
177
|
-
getNpvDistribution: async (portfolioId: string, valueFrameworkId
|
|
167
|
+
getNpvDistribution: async (portfolioId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
178
168
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
179
169
|
assertParamExists('getNpvDistribution', 'portfolioId', portfolioId)
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution`
|
|
183
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
184
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
170
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/npv-distribution`
|
|
171
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
185
172
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
186
173
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
187
174
|
let baseOptions;
|
|
@@ -197,6 +184,10 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
197
184
|
// oauth required
|
|
198
185
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
199
186
|
|
|
187
|
+
if (valueFrameworkId !== undefined) {
|
|
188
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
189
|
+
}
|
|
190
|
+
|
|
200
191
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
201
192
|
|
|
202
193
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -250,6 +241,82 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
250
241
|
options: localVarRequestOptions,
|
|
251
242
|
};
|
|
252
243
|
},
|
|
244
|
+
/**
|
|
245
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
246
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
247
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
248
|
+
* @param {*} [options] Override http request option.
|
|
249
|
+
* @throws {RequiredError}
|
|
250
|
+
*/
|
|
251
|
+
getPortfolioBudgetExpenditureAll: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
252
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
253
|
+
assertParamExists('getPortfolioBudgetExpenditureAll', 'portfolioId', portfolioId)
|
|
254
|
+
const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure-all`
|
|
255
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
256
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
257
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
258
|
+
let baseOptions;
|
|
259
|
+
if (configuration) {
|
|
260
|
+
baseOptions = configuration.baseOptions;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
264
|
+
const localVarHeaderParameter = {} as any;
|
|
265
|
+
const localVarQueryParameter = {} as any;
|
|
266
|
+
|
|
267
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
268
|
+
// oauth required
|
|
269
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
270
|
+
|
|
271
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
272
|
+
|
|
273
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
274
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
275
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
276
|
+
|
|
277
|
+
return {
|
|
278
|
+
url: toPathString(localVarUrlObj),
|
|
279
|
+
options: localVarRequestOptions,
|
|
280
|
+
};
|
|
281
|
+
},
|
|
282
|
+
/**
|
|
283
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
284
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
285
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
*/
|
|
289
|
+
getPortfolioBudgetExpenditureNoBudget: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
290
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
291
|
+
assertParamExists('getPortfolioBudgetExpenditureNoBudget', 'portfolioId', portfolioId)
|
|
292
|
+
const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure-no-budget`
|
|
293
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
294
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
295
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
296
|
+
let baseOptions;
|
|
297
|
+
if (configuration) {
|
|
298
|
+
baseOptions = configuration.baseOptions;
|
|
299
|
+
}
|
|
300
|
+
|
|
301
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
302
|
+
const localVarHeaderParameter = {} as any;
|
|
303
|
+
const localVarQueryParameter = {} as any;
|
|
304
|
+
|
|
305
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
306
|
+
// oauth required
|
|
307
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
308
|
+
|
|
309
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
310
|
+
|
|
311
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
312
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
313
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
314
|
+
|
|
315
|
+
return {
|
|
316
|
+
url: toPathString(localVarUrlObj),
|
|
317
|
+
options: localVarRequestOptions,
|
|
318
|
+
};
|
|
319
|
+
},
|
|
253
320
|
/**
|
|
254
321
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
255
322
|
* @summary Budget usage summary
|
|
@@ -289,21 +356,18 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
289
356
|
};
|
|
290
357
|
},
|
|
291
358
|
/**
|
|
292
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
359
|
+
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio. NPV is only computed when value_framework_id is provided; otherwise it is null.
|
|
293
360
|
* @summary Get portfolio KPIs
|
|
294
361
|
* @param {string} portfolioId UUID of the portfolio
|
|
295
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
362
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
296
363
|
* @param {*} [options] Override http request option.
|
|
297
364
|
* @throws {RequiredError}
|
|
298
365
|
*/
|
|
299
|
-
getPortfolioKpis: async (portfolioId: string, valueFrameworkId
|
|
366
|
+
getPortfolioKpis: async (portfolioId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
300
367
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
301
368
|
assertParamExists('getPortfolioKpis', 'portfolioId', portfolioId)
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}`
|
|
305
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
306
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
369
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis`
|
|
370
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
307
371
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
308
372
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
309
373
|
let baseOptions;
|
|
@@ -319,6 +383,10 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
319
383
|
// oauth required
|
|
320
384
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
321
385
|
|
|
386
|
+
if (valueFrameworkId !== undefined) {
|
|
387
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
388
|
+
}
|
|
389
|
+
|
|
322
390
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
323
391
|
|
|
324
392
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -373,21 +441,18 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
373
441
|
};
|
|
374
442
|
},
|
|
375
443
|
/**
|
|
376
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
444
|
+
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
377
445
|
* @summary Portfolio monetized impact over time
|
|
378
446
|
* @param {string} portfolioId UUID of the portfolio
|
|
379
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
447
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
380
448
|
* @param {*} [options] Override http request option.
|
|
381
449
|
* @throws {RequiredError}
|
|
382
450
|
*/
|
|
383
|
-
getPortfolioMonetizedImpact: async (portfolioId: string, valueFrameworkId
|
|
451
|
+
getPortfolioMonetizedImpact: async (portfolioId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
384
452
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
385
453
|
assertParamExists('getPortfolioMonetizedImpact', 'portfolioId', portfolioId)
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/{value_framework_id}`
|
|
389
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
390
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
454
|
+
const localVarPath = `/portfolio/{portfolio_id}/monetized-impact`
|
|
455
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
391
456
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
392
457
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
393
458
|
let baseOptions;
|
|
@@ -403,6 +468,53 @@ export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Config
|
|
|
403
468
|
// oauth required
|
|
404
469
|
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
405
470
|
|
|
471
|
+
if (valueFrameworkId !== undefined) {
|
|
472
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
476
|
+
|
|
477
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
478
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
479
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
480
|
+
|
|
481
|
+
return {
|
|
482
|
+
url: toPathString(localVarUrlObj),
|
|
483
|
+
options: localVarRequestOptions,
|
|
484
|
+
};
|
|
485
|
+
},
|
|
486
|
+
/**
|
|
487
|
+
* Return year-by-year monetized impact split by individual metric and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
488
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
489
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
490
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
491
|
+
* @param {*} [options] Override http request option.
|
|
492
|
+
* @throws {RequiredError}
|
|
493
|
+
*/
|
|
494
|
+
getPortfolioMonetizedImpactDetailed: async (portfolioId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
495
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
496
|
+
assertParamExists('getPortfolioMonetizedImpactDetailed', 'portfolioId', portfolioId)
|
|
497
|
+
const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/detailed`
|
|
498
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
499
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
500
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
501
|
+
let baseOptions;
|
|
502
|
+
if (configuration) {
|
|
503
|
+
baseOptions = configuration.baseOptions;
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
507
|
+
const localVarHeaderParameter = {} as any;
|
|
508
|
+
const localVarQueryParameter = {} as any;
|
|
509
|
+
|
|
510
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
511
|
+
// oauth required
|
|
512
|
+
await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
|
|
513
|
+
|
|
514
|
+
if (valueFrameworkId !== undefined) {
|
|
515
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
516
|
+
}
|
|
517
|
+
|
|
406
518
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
407
519
|
|
|
408
520
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -427,12 +539,11 @@ export const PortfolioKPIApiFp = function(configuration?: Configuration) {
|
|
|
427
539
|
* Total cost of preferred options starting each year.
|
|
428
540
|
* @summary CAPEX year-by-year distribution
|
|
429
541
|
* @param {string} portfolioId UUID of the portfolio
|
|
430
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
431
542
|
* @param {*} [options] Override http request option.
|
|
432
543
|
* @throws {RequiredError}
|
|
433
544
|
*/
|
|
434
|
-
async getCapexDistribution(portfolioId: string,
|
|
435
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCapexDistribution(portfolioId,
|
|
545
|
+
async getCapexDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>> {
|
|
546
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCapexDistribution(portfolioId, options);
|
|
436
547
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
437
548
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getCapexDistribution']?.[localVarOperationServerIndex]?.url;
|
|
438
549
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -441,12 +552,11 @@ export const PortfolioKPIApiFp = function(configuration?: Configuration) {
|
|
|
441
552
|
* Count of investments with a preferred option starting each year.
|
|
442
553
|
* @summary Investment count year-by-year distribution
|
|
443
554
|
* @param {string} portfolioId UUID of the portfolio
|
|
444
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
445
555
|
* @param {*} [options] Override http request option.
|
|
446
556
|
* @throws {RequiredError}
|
|
447
557
|
*/
|
|
448
|
-
async getInvestmentsDistribution(portfolioId: string,
|
|
449
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId,
|
|
558
|
+
async getInvestmentsDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>> {
|
|
559
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId, options);
|
|
450
560
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
451
561
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getInvestmentsDistribution']?.[localVarOperationServerIndex]?.url;
|
|
452
562
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -455,25 +565,24 @@ export const PortfolioKPIApiFp = function(configuration?: Configuration) {
|
|
|
455
565
|
* Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
|
|
456
566
|
* @summary Budget overrun year-by-year distribution
|
|
457
567
|
* @param {string} portfolioId UUID of the portfolio
|
|
458
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
459
568
|
* @param {*} [options] Override http request option.
|
|
460
569
|
* @throws {RequiredError}
|
|
461
570
|
*/
|
|
462
|
-
async getKpiOverrunDistribution(portfolioId: string,
|
|
463
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId,
|
|
571
|
+
async getKpiOverrunDistribution(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIOverrunDistributionResponse>> {
|
|
572
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId, options);
|
|
464
573
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
465
574
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getKpiOverrunDistribution']?.[localVarOperationServerIndex]?.url;
|
|
466
575
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
467
576
|
},
|
|
468
577
|
/**
|
|
469
|
-
* Sum of final NPV of preferred options starting each year.
|
|
578
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
470
579
|
* @summary NPV year-by-year distribution
|
|
471
580
|
* @param {string} portfolioId UUID of the portfolio
|
|
472
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
581
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
473
582
|
* @param {*} [options] Override http request option.
|
|
474
583
|
* @throws {RequiredError}
|
|
475
584
|
*/
|
|
476
|
-
async getNpvDistribution(portfolioId: string, valueFrameworkId
|
|
585
|
+
async getNpvDistribution(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>> {
|
|
477
586
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getNpvDistribution(portfolioId, valueFrameworkId, options);
|
|
478
587
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
479
588
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getNpvDistribution']?.[localVarOperationServerIndex]?.url;
|
|
@@ -493,6 +602,32 @@ export const PortfolioKPIApiFp = function(configuration?: Configuration) {
|
|
|
493
602
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditure']?.[localVarOperationServerIndex]?.url;
|
|
494
603
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
495
604
|
},
|
|
605
|
+
/**
|
|
606
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
607
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
608
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
609
|
+
* @param {*} [options] Override http request option.
|
|
610
|
+
* @throws {RequiredError}
|
|
611
|
+
*/
|
|
612
|
+
async getPortfolioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetExpenditureResponse>>> {
|
|
613
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioBudgetExpenditureAll(portfolioId, options);
|
|
614
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
615
|
+
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditureAll']?.[localVarOperationServerIndex]?.url;
|
|
616
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
617
|
+
},
|
|
618
|
+
/**
|
|
619
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
620
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
621
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
622
|
+
* @param {*} [options] Override http request option.
|
|
623
|
+
* @throws {RequiredError}
|
|
624
|
+
*/
|
|
625
|
+
async getPortfolioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>> {
|
|
626
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioBudgetExpenditureNoBudget(portfolioId, options);
|
|
627
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
628
|
+
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditureNoBudget']?.[localVarOperationServerIndex]?.url;
|
|
629
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
630
|
+
},
|
|
496
631
|
/**
|
|
497
632
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
498
633
|
* @summary Budget usage summary
|
|
@@ -507,14 +642,14 @@ export const PortfolioKPIApiFp = function(configuration?: Configuration) {
|
|
|
507
642
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
508
643
|
},
|
|
509
644
|
/**
|
|
510
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
645
|
+
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio. NPV is only computed when value_framework_id is provided; otherwise it is null.
|
|
511
646
|
* @summary Get portfolio KPIs
|
|
512
647
|
* @param {string} portfolioId UUID of the portfolio
|
|
513
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
648
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
514
649
|
* @param {*} [options] Override http request option.
|
|
515
650
|
* @throws {RequiredError}
|
|
516
651
|
*/
|
|
517
|
-
async getPortfolioKpis(portfolioId: string, valueFrameworkId
|
|
652
|
+
async getPortfolioKpis(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIResponse>> {
|
|
518
653
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioKpis(portfolioId, valueFrameworkId, options);
|
|
519
654
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
520
655
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioKpis']?.[localVarOperationServerIndex]?.url;
|
|
@@ -535,19 +670,33 @@ export const PortfolioKPIApiFp = function(configuration?: Configuration) {
|
|
|
535
670
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
536
671
|
},
|
|
537
672
|
/**
|
|
538
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
673
|
+
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
539
674
|
* @summary Portfolio monetized impact over time
|
|
540
675
|
* @param {string} portfolioId UUID of the portfolio
|
|
541
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
676
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
542
677
|
* @param {*} [options] Override http request option.
|
|
543
678
|
* @throws {RequiredError}
|
|
544
679
|
*/
|
|
545
|
-
async getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId
|
|
680
|
+
async getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactResponse>> {
|
|
546
681
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options);
|
|
547
682
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
548
683
|
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioMonetizedImpact']?.[localVarOperationServerIndex]?.url;
|
|
549
684
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
550
685
|
},
|
|
686
|
+
/**
|
|
687
|
+
* Return year-by-year monetized impact split by individual metric and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
688
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
689
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
690
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
691
|
+
* @param {*} [options] Override http request option.
|
|
692
|
+
* @throws {RequiredError}
|
|
693
|
+
*/
|
|
694
|
+
async getPortfolioMonetizedImpactDetailed(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactDetailedResponse>> {
|
|
695
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options);
|
|
696
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
697
|
+
const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioMonetizedImpactDetailed']?.[localVarOperationServerIndex]?.url;
|
|
698
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
699
|
+
},
|
|
551
700
|
}
|
|
552
701
|
};
|
|
553
702
|
|
|
@@ -561,44 +710,41 @@ export const PortfolioKPIApiFactory = function (configuration?: Configuration, b
|
|
|
561
710
|
* Total cost of preferred options starting each year.
|
|
562
711
|
* @summary CAPEX year-by-year distribution
|
|
563
712
|
* @param {string} portfolioId UUID of the portfolio
|
|
564
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
565
713
|
* @param {*} [options] Override http request option.
|
|
566
714
|
* @throws {RequiredError}
|
|
567
715
|
*/
|
|
568
|
-
getCapexDistribution(portfolioId: string,
|
|
569
|
-
return localVarFp.getCapexDistribution(portfolioId,
|
|
716
|
+
getCapexDistribution(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse> {
|
|
717
|
+
return localVarFp.getCapexDistribution(portfolioId, options).then((request) => request(axios, basePath));
|
|
570
718
|
},
|
|
571
719
|
/**
|
|
572
720
|
* Count of investments with a preferred option starting each year.
|
|
573
721
|
* @summary Investment count year-by-year distribution
|
|
574
722
|
* @param {string} portfolioId UUID of the portfolio
|
|
575
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
576
723
|
* @param {*} [options] Override http request option.
|
|
577
724
|
* @throws {RequiredError}
|
|
578
725
|
*/
|
|
579
|
-
getInvestmentsDistribution(portfolioId: string,
|
|
580
|
-
return localVarFp.getInvestmentsDistribution(portfolioId,
|
|
726
|
+
getInvestmentsDistribution(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse> {
|
|
727
|
+
return localVarFp.getInvestmentsDistribution(portfolioId, options).then((request) => request(axios, basePath));
|
|
581
728
|
},
|
|
582
729
|
/**
|
|
583
730
|
* Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
|
|
584
731
|
* @summary Budget overrun year-by-year distribution
|
|
585
732
|
* @param {string} portfolioId UUID of the portfolio
|
|
586
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
587
733
|
* @param {*} [options] Override http request option.
|
|
588
734
|
* @throws {RequiredError}
|
|
589
735
|
*/
|
|
590
|
-
getKpiOverrunDistribution(portfolioId: string,
|
|
591
|
-
return localVarFp.getKpiOverrunDistribution(portfolioId,
|
|
736
|
+
getKpiOverrunDistribution(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIOverrunDistributionResponse> {
|
|
737
|
+
return localVarFp.getKpiOverrunDistribution(portfolioId, options).then((request) => request(axios, basePath));
|
|
592
738
|
},
|
|
593
739
|
/**
|
|
594
|
-
* Sum of final NPV of preferred options starting each year.
|
|
740
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
595
741
|
* @summary NPV year-by-year distribution
|
|
596
742
|
* @param {string} portfolioId UUID of the portfolio
|
|
597
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
743
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
598
744
|
* @param {*} [options] Override http request option.
|
|
599
745
|
* @throws {RequiredError}
|
|
600
746
|
*/
|
|
601
|
-
getNpvDistribution(portfolioId: string, valueFrameworkId
|
|
747
|
+
getNpvDistribution(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse> {
|
|
602
748
|
return localVarFp.getNpvDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
603
749
|
},
|
|
604
750
|
/**
|
|
@@ -612,6 +758,26 @@ export const PortfolioKPIApiFactory = function (configuration?: Configuration, b
|
|
|
612
758
|
getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse> {
|
|
613
759
|
return localVarFp.getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(axios, basePath));
|
|
614
760
|
},
|
|
761
|
+
/**
|
|
762
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
763
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
764
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
765
|
+
* @param {*} [options] Override http request option.
|
|
766
|
+
* @throws {RequiredError}
|
|
767
|
+
*/
|
|
768
|
+
getPortfolioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioBudgetExpenditureResponse>> {
|
|
769
|
+
return localVarFp.getPortfolioBudgetExpenditureAll(portfolioId, options).then((request) => request(axios, basePath));
|
|
770
|
+
},
|
|
771
|
+
/**
|
|
772
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
773
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
774
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
775
|
+
* @param {*} [options] Override http request option.
|
|
776
|
+
* @throws {RequiredError}
|
|
777
|
+
*/
|
|
778
|
+
getPortfolioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse> {
|
|
779
|
+
return localVarFp.getPortfolioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(axios, basePath));
|
|
780
|
+
},
|
|
615
781
|
/**
|
|
616
782
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
617
783
|
* @summary Budget usage summary
|
|
@@ -623,14 +789,14 @@ export const PortfolioKPIApiFactory = function (configuration?: Configuration, b
|
|
|
623
789
|
return localVarFp.getPortfolioBudgetUsage(portfolioId, options).then((request) => request(axios, basePath));
|
|
624
790
|
},
|
|
625
791
|
/**
|
|
626
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
792
|
+
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio. NPV is only computed when value_framework_id is provided; otherwise it is null.
|
|
627
793
|
* @summary Get portfolio KPIs
|
|
628
794
|
* @param {string} portfolioId UUID of the portfolio
|
|
629
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
795
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
630
796
|
* @param {*} [options] Override http request option.
|
|
631
797
|
* @throws {RequiredError}
|
|
632
798
|
*/
|
|
633
|
-
getPortfolioKpis(portfolioId: string, valueFrameworkId
|
|
799
|
+
getPortfolioKpis(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIResponse> {
|
|
634
800
|
return localVarFp.getPortfolioKpis(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
635
801
|
},
|
|
636
802
|
/**
|
|
@@ -645,16 +811,27 @@ export const PortfolioKPIApiFactory = function (configuration?: Configuration, b
|
|
|
645
811
|
return localVarFp.getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(axios, basePath));
|
|
646
812
|
},
|
|
647
813
|
/**
|
|
648
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
814
|
+
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
649
815
|
* @summary Portfolio monetized impact over time
|
|
650
816
|
* @param {string} portfolioId UUID of the portfolio
|
|
651
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
817
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
652
818
|
* @param {*} [options] Override http request option.
|
|
653
819
|
* @throws {RequiredError}
|
|
654
820
|
*/
|
|
655
|
-
getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId
|
|
821
|
+
getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactResponse> {
|
|
656
822
|
return localVarFp.getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
657
823
|
},
|
|
824
|
+
/**
|
|
825
|
+
* Return year-by-year monetized impact split by individual metric and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
826
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
827
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
828
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
829
|
+
* @param {*} [options] Override http request option.
|
|
830
|
+
* @throws {RequiredError}
|
|
831
|
+
*/
|
|
832
|
+
getPortfolioMonetizedImpactDetailed(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactDetailedResponse> {
|
|
833
|
+
return localVarFp.getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
834
|
+
},
|
|
658
835
|
};
|
|
659
836
|
};
|
|
660
837
|
|
|
@@ -666,47 +843,44 @@ export class PortfolioKPIApi extends BaseAPI {
|
|
|
666
843
|
* Total cost of preferred options starting each year.
|
|
667
844
|
* @summary CAPEX year-by-year distribution
|
|
668
845
|
* @param {string} portfolioId UUID of the portfolio
|
|
669
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
670
846
|
* @param {*} [options] Override http request option.
|
|
671
847
|
* @throws {RequiredError}
|
|
672
848
|
*/
|
|
673
|
-
public getCapexDistribution(portfolioId: string,
|
|
674
|
-
return PortfolioKPIApiFp(this.configuration).getCapexDistribution(portfolioId,
|
|
849
|
+
public getCapexDistribution(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
850
|
+
return PortfolioKPIApiFp(this.configuration).getCapexDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
675
851
|
}
|
|
676
852
|
|
|
677
853
|
/**
|
|
678
854
|
* Count of investments with a preferred option starting each year.
|
|
679
855
|
* @summary Investment count year-by-year distribution
|
|
680
856
|
* @param {string} portfolioId UUID of the portfolio
|
|
681
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
682
857
|
* @param {*} [options] Override http request option.
|
|
683
858
|
* @throws {RequiredError}
|
|
684
859
|
*/
|
|
685
|
-
public getInvestmentsDistribution(portfolioId: string,
|
|
686
|
-
return PortfolioKPIApiFp(this.configuration).getInvestmentsDistribution(portfolioId,
|
|
860
|
+
public getInvestmentsDistribution(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
861
|
+
return PortfolioKPIApiFp(this.configuration).getInvestmentsDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
687
862
|
}
|
|
688
863
|
|
|
689
864
|
/**
|
|
690
865
|
* Break down budget overruns by year across all preferred options in the portfolio. For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
|
|
691
866
|
* @summary Budget overrun year-by-year distribution
|
|
692
867
|
* @param {string} portfolioId UUID of the portfolio
|
|
693
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
694
868
|
* @param {*} [options] Override http request option.
|
|
695
869
|
* @throws {RequiredError}
|
|
696
870
|
*/
|
|
697
|
-
public getKpiOverrunDistribution(portfolioId: string,
|
|
698
|
-
return PortfolioKPIApiFp(this.configuration).getKpiOverrunDistribution(portfolioId,
|
|
871
|
+
public getKpiOverrunDistribution(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
872
|
+
return PortfolioKPIApiFp(this.configuration).getKpiOverrunDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
699
873
|
}
|
|
700
874
|
|
|
701
875
|
/**
|
|
702
|
-
* Sum of final NPV of preferred options starting each year.
|
|
876
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
703
877
|
* @summary NPV year-by-year distribution
|
|
704
878
|
* @param {string} portfolioId UUID of the portfolio
|
|
705
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
879
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
706
880
|
* @param {*} [options] Override http request option.
|
|
707
881
|
* @throws {RequiredError}
|
|
708
882
|
*/
|
|
709
|
-
public getNpvDistribution(portfolioId: string, valueFrameworkId
|
|
883
|
+
public getNpvDistribution(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
|
|
710
884
|
return PortfolioKPIApiFp(this.configuration).getNpvDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
711
885
|
}
|
|
712
886
|
|
|
@@ -722,6 +896,28 @@ export class PortfolioKPIApi extends BaseAPI {
|
|
|
722
896
|
return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(this.axios, this.basePath));
|
|
723
897
|
}
|
|
724
898
|
|
|
899
|
+
/**
|
|
900
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
901
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
902
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
903
|
+
* @param {*} [options] Override http request option.
|
|
904
|
+
* @throws {RequiredError}
|
|
905
|
+
*/
|
|
906
|
+
public getPortfolioBudgetExpenditureAll(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
907
|
+
return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditureAll(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
912
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
913
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
914
|
+
* @param {*} [options] Override http request option.
|
|
915
|
+
* @throws {RequiredError}
|
|
916
|
+
*/
|
|
917
|
+
public getPortfolioBudgetExpenditureNoBudget(portfolioId: string, options?: RawAxiosRequestConfig) {
|
|
918
|
+
return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
919
|
+
}
|
|
920
|
+
|
|
725
921
|
/**
|
|
726
922
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
727
923
|
* @summary Budget usage summary
|
|
@@ -734,14 +930,14 @@ export class PortfolioKPIApi extends BaseAPI {
|
|
|
734
930
|
}
|
|
735
931
|
|
|
736
932
|
/**
|
|
737
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
933
|
+
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio. NPV is only computed when value_framework_id is provided; otherwise it is null.
|
|
738
934
|
* @summary Get portfolio KPIs
|
|
739
935
|
* @param {string} portfolioId UUID of the portfolio
|
|
740
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
936
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
741
937
|
* @param {*} [options] Override http request option.
|
|
742
938
|
* @throws {RequiredError}
|
|
743
939
|
*/
|
|
744
|
-
public getPortfolioKpis(portfolioId: string, valueFrameworkId
|
|
940
|
+
public getPortfolioKpis(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
|
|
745
941
|
return PortfolioKPIApiFp(this.configuration).getPortfolioKpis(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
746
942
|
}
|
|
747
943
|
|
|
@@ -758,15 +954,27 @@ export class PortfolioKPIApi extends BaseAPI {
|
|
|
758
954
|
}
|
|
759
955
|
|
|
760
956
|
/**
|
|
761
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
957
|
+
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
762
958
|
* @summary Portfolio monetized impact over time
|
|
763
959
|
* @param {string} portfolioId UUID of the portfolio
|
|
764
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
960
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
765
961
|
* @param {*} [options] Override http request option.
|
|
766
962
|
* @throws {RequiredError}
|
|
767
963
|
*/
|
|
768
|
-
public getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId
|
|
964
|
+
public getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
|
|
769
965
|
return PortfolioKPIApiFp(this.configuration).getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
770
966
|
}
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* Return year-by-year monetized impact split by individual metric and investment cost (preferred option CAPEX by start year) across the portfolio. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
970
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
971
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
972
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
973
|
+
* @param {*} [options] Override http request option.
|
|
974
|
+
* @throws {RequiredError}
|
|
975
|
+
*/
|
|
976
|
+
public getPortfolioMonetizedImpactDetailed(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
|
|
977
|
+
return PortfolioKPIApiFp(this.configuration).getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
978
|
+
}
|
|
771
979
|
}
|
|
772
980
|
|