@cosmotech/aip-client 0.4.0-dev1 → 0.4.0-dev4
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 +20 -11
- package/api/budget-api.ts +85 -19
- 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 +1 -1
- 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 +39 -7
- package/dist/api/budget-api.js +80 -15
- 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 +1 -1
- package/dist/api/option-api.js +1 -1
- 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 +39 -7
- package/dist/esm/api/budget-api.js +80 -15
- 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 +1 -1
- package/dist/esm/api/option-api.js +1 -1
- 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 +57 -5
- 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/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
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Asset Investment Planning
|
|
6
6
|
* API for Asset Investment Planning
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.4.0-
|
|
8
|
+
* The version of the OpenAPI document: 0.4.0-dev4
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -38,18 +38,14 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
38
38
|
* Total cost of preferred options starting each year.
|
|
39
39
|
* @summary CAPEX year-by-year distribution
|
|
40
40
|
* @param {string} portfolioId UUID of the portfolio
|
|
41
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
42
41
|
* @param {*} [options] Override http request option.
|
|
43
42
|
* @throws {RequiredError}
|
|
44
43
|
*/
|
|
45
|
-
getCapexDistribution: (portfolioId_1,
|
|
44
|
+
getCapexDistribution: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
|
|
46
45
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
47
46
|
(0, common_1.assertParamExists)('getCapexDistribution', 'portfolioId', portfolioId);
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution`
|
|
51
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
52
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
47
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/capex-distribution`
|
|
48
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
53
49
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54
50
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
55
51
|
let baseOptions;
|
|
@@ -75,18 +71,14 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
75
71
|
* Count of investments with a preferred option starting each year.
|
|
76
72
|
* @summary Investment count year-by-year distribution
|
|
77
73
|
* @param {string} portfolioId UUID of the portfolio
|
|
78
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
79
74
|
* @param {*} [options] Override http request option.
|
|
80
75
|
* @throws {RequiredError}
|
|
81
76
|
*/
|
|
82
|
-
getInvestmentsDistribution: (portfolioId_1,
|
|
77
|
+
getInvestmentsDistribution: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
|
|
83
78
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
84
79
|
(0, common_1.assertParamExists)('getInvestmentsDistribution', 'portfolioId', portfolioId);
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution`
|
|
88
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
89
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
80
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/investments-distribution`
|
|
81
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
90
82
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
91
83
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
92
84
|
let baseOptions;
|
|
@@ -112,18 +104,14 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
112
104
|
* 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.
|
|
113
105
|
* @summary Budget overrun year-by-year distribution
|
|
114
106
|
* @param {string} portfolioId UUID of the portfolio
|
|
115
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
116
107
|
* @param {*} [options] Override http request option.
|
|
117
108
|
* @throws {RequiredError}
|
|
118
109
|
*/
|
|
119
|
-
getKpiOverrunDistribution: (portfolioId_1,
|
|
110
|
+
getKpiOverrunDistribution: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
|
|
120
111
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
121
112
|
(0, common_1.assertParamExists)('getKpiOverrunDistribution', 'portfolioId', portfolioId);
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution`
|
|
125
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
126
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
113
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/overrun-distribution`
|
|
114
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
127
115
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
128
116
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
129
117
|
let baseOptions;
|
|
@@ -146,21 +134,18 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
146
134
|
};
|
|
147
135
|
}),
|
|
148
136
|
/**
|
|
149
|
-
* Sum of final NPV of preferred options starting each year.
|
|
137
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
150
138
|
* @summary NPV year-by-year distribution
|
|
151
139
|
* @param {string} portfolioId UUID of the portfolio
|
|
152
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
140
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
153
141
|
* @param {*} [options] Override http request option.
|
|
154
142
|
* @throws {RequiredError}
|
|
155
143
|
*/
|
|
156
144
|
getNpvDistribution: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
|
|
157
145
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
158
146
|
(0, common_1.assertParamExists)('getNpvDistribution', 'portfolioId', portfolioId);
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution`
|
|
162
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
163
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
147
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis/npv-distribution`
|
|
148
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
164
149
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
165
150
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
166
151
|
let baseOptions;
|
|
@@ -173,6 +158,9 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
173
158
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
174
159
|
// oauth required
|
|
175
160
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
161
|
+
if (valueFrameworkId !== undefined) {
|
|
162
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
163
|
+
}
|
|
176
164
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
177
165
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
178
166
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -219,6 +207,72 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
219
207
|
options: localVarRequestOptions,
|
|
220
208
|
};
|
|
221
209
|
}),
|
|
210
|
+
/**
|
|
211
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
212
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
213
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
214
|
+
* @param {*} [options] Override http request option.
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
*/
|
|
217
|
+
getPortfolioBudgetExpenditureAll: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
|
|
218
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
219
|
+
(0, common_1.assertParamExists)('getPortfolioBudgetExpenditureAll', 'portfolioId', portfolioId);
|
|
220
|
+
const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure-all`
|
|
221
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
222
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
223
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
224
|
+
let baseOptions;
|
|
225
|
+
if (configuration) {
|
|
226
|
+
baseOptions = configuration.baseOptions;
|
|
227
|
+
}
|
|
228
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
229
|
+
const localVarHeaderParameter = {};
|
|
230
|
+
const localVarQueryParameter = {};
|
|
231
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
232
|
+
// oauth required
|
|
233
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
234
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
235
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
236
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
237
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
238
|
+
return {
|
|
239
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
240
|
+
options: localVarRequestOptions,
|
|
241
|
+
};
|
|
242
|
+
}),
|
|
243
|
+
/**
|
|
244
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
245
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
246
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
getPortfolioBudgetExpenditureNoBudget: (portfolioId_1, ...args_1) => __awaiter(this, [portfolioId_1, ...args_1], void 0, function* (portfolioId, options = {}) {
|
|
251
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
252
|
+
(0, common_1.assertParamExists)('getPortfolioBudgetExpenditureNoBudget', 'portfolioId', portfolioId);
|
|
253
|
+
const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure-no-budget`
|
|
254
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
255
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
256
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
257
|
+
let baseOptions;
|
|
258
|
+
if (configuration) {
|
|
259
|
+
baseOptions = configuration.baseOptions;
|
|
260
|
+
}
|
|
261
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
262
|
+
const localVarHeaderParameter = {};
|
|
263
|
+
const localVarQueryParameter = {};
|
|
264
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
265
|
+
// oauth required
|
|
266
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
267
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
268
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
269
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
270
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
271
|
+
return {
|
|
272
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
273
|
+
options: localVarRequestOptions,
|
|
274
|
+
};
|
|
275
|
+
}),
|
|
222
276
|
/**
|
|
223
277
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
224
278
|
* @summary Budget usage summary
|
|
@@ -253,21 +307,18 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
253
307
|
};
|
|
254
308
|
}),
|
|
255
309
|
/**
|
|
256
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
310
|
+
* 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.
|
|
257
311
|
* @summary Get portfolio KPIs
|
|
258
312
|
* @param {string} portfolioId UUID of the portfolio
|
|
259
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
313
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
260
314
|
* @param {*} [options] Override http request option.
|
|
261
315
|
* @throws {RequiredError}
|
|
262
316
|
*/
|
|
263
317
|
getPortfolioKpis: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
|
|
264
318
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
265
319
|
(0, common_1.assertParamExists)('getPortfolioKpis', 'portfolioId', portfolioId);
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}`
|
|
269
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
270
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
320
|
+
const localVarPath = `/portfolio/{portfolio_id}/kpis`
|
|
321
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
271
322
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
272
323
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
273
324
|
let baseOptions;
|
|
@@ -280,6 +331,9 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
280
331
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
281
332
|
// oauth required
|
|
282
333
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
334
|
+
if (valueFrameworkId !== undefined) {
|
|
335
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
336
|
+
}
|
|
283
337
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
284
338
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
285
339
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -327,21 +381,18 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
327
381
|
};
|
|
328
382
|
}),
|
|
329
383
|
/**
|
|
330
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
384
|
+
* 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.
|
|
331
385
|
* @summary Portfolio monetized impact over time
|
|
332
386
|
* @param {string} portfolioId UUID of the portfolio
|
|
333
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
387
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
334
388
|
* @param {*} [options] Override http request option.
|
|
335
389
|
* @throws {RequiredError}
|
|
336
390
|
*/
|
|
337
391
|
getPortfolioMonetizedImpact: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
|
|
338
392
|
// verify required parameter 'portfolioId' is not null or undefined
|
|
339
393
|
(0, common_1.assertParamExists)('getPortfolioMonetizedImpact', 'portfolioId', portfolioId);
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/{value_framework_id}`
|
|
343
|
-
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
|
|
344
|
-
.replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
|
|
394
|
+
const localVarPath = `/portfolio/{portfolio_id}/monetized-impact`
|
|
395
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
345
396
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
346
397
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
347
398
|
let baseOptions;
|
|
@@ -354,6 +405,46 @@ const PortfolioKPIApiAxiosParamCreator = function (configuration) {
|
|
|
354
405
|
// authentication OAuth2AuthorizationCodeBearer required
|
|
355
406
|
// oauth required
|
|
356
407
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
408
|
+
if (valueFrameworkId !== undefined) {
|
|
409
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
410
|
+
}
|
|
411
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
412
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
413
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
414
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
415
|
+
return {
|
|
416
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
417
|
+
options: localVarRequestOptions,
|
|
418
|
+
};
|
|
419
|
+
}),
|
|
420
|
+
/**
|
|
421
|
+
* 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.
|
|
422
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
423
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
424
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
425
|
+
* @param {*} [options] Override http request option.
|
|
426
|
+
* @throws {RequiredError}
|
|
427
|
+
*/
|
|
428
|
+
getPortfolioMonetizedImpactDetailed: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
|
|
429
|
+
// verify required parameter 'portfolioId' is not null or undefined
|
|
430
|
+
(0, common_1.assertParamExists)('getPortfolioMonetizedImpactDetailed', 'portfolioId', portfolioId);
|
|
431
|
+
const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/detailed`
|
|
432
|
+
.replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
|
|
433
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
434
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
435
|
+
let baseOptions;
|
|
436
|
+
if (configuration) {
|
|
437
|
+
baseOptions = configuration.baseOptions;
|
|
438
|
+
}
|
|
439
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
440
|
+
const localVarHeaderParameter = {};
|
|
441
|
+
const localVarQueryParameter = {};
|
|
442
|
+
// authentication OAuth2AuthorizationCodeBearer required
|
|
443
|
+
// oauth required
|
|
444
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
|
|
445
|
+
if (valueFrameworkId !== undefined) {
|
|
446
|
+
localVarQueryParameter['value_framework_id'] = valueFrameworkId;
|
|
447
|
+
}
|
|
357
448
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
358
449
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
359
450
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -376,14 +467,13 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
376
467
|
* Total cost of preferred options starting each year.
|
|
377
468
|
* @summary CAPEX year-by-year distribution
|
|
378
469
|
* @param {string} portfolioId UUID of the portfolio
|
|
379
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
380
470
|
* @param {*} [options] Override http request option.
|
|
381
471
|
* @throws {RequiredError}
|
|
382
472
|
*/
|
|
383
|
-
getCapexDistribution(portfolioId,
|
|
473
|
+
getCapexDistribution(portfolioId, options) {
|
|
384
474
|
return __awaiter(this, void 0, void 0, function* () {
|
|
385
475
|
var _a, _b, _c;
|
|
386
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCapexDistribution(portfolioId,
|
|
476
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCapexDistribution(portfolioId, options);
|
|
387
477
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
388
478
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioKPIApi.getCapexDistribution']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
389
479
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -393,14 +483,13 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
393
483
|
* Count of investments with a preferred option starting each year.
|
|
394
484
|
* @summary Investment count year-by-year distribution
|
|
395
485
|
* @param {string} portfolioId UUID of the portfolio
|
|
396
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
397
486
|
* @param {*} [options] Override http request option.
|
|
398
487
|
* @throws {RequiredError}
|
|
399
488
|
*/
|
|
400
|
-
getInvestmentsDistribution(portfolioId,
|
|
489
|
+
getInvestmentsDistribution(portfolioId, options) {
|
|
401
490
|
return __awaiter(this, void 0, void 0, function* () {
|
|
402
491
|
var _a, _b, _c;
|
|
403
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId,
|
|
492
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId, options);
|
|
404
493
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
405
494
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioKPIApi.getInvestmentsDistribution']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
406
495
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -410,24 +499,23 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
410
499
|
* 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.
|
|
411
500
|
* @summary Budget overrun year-by-year distribution
|
|
412
501
|
* @param {string} portfolioId UUID of the portfolio
|
|
413
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
414
502
|
* @param {*} [options] Override http request option.
|
|
415
503
|
* @throws {RequiredError}
|
|
416
504
|
*/
|
|
417
|
-
getKpiOverrunDistribution(portfolioId,
|
|
505
|
+
getKpiOverrunDistribution(portfolioId, options) {
|
|
418
506
|
return __awaiter(this, void 0, void 0, function* () {
|
|
419
507
|
var _a, _b, _c;
|
|
420
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId,
|
|
508
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId, options);
|
|
421
509
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
422
510
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioKPIApi.getKpiOverrunDistribution']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
423
511
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
424
512
|
});
|
|
425
513
|
},
|
|
426
514
|
/**
|
|
427
|
-
* Sum of final NPV of preferred options starting each year.
|
|
515
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
428
516
|
* @summary NPV year-by-year distribution
|
|
429
517
|
* @param {string} portfolioId UUID of the portfolio
|
|
430
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
518
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
431
519
|
* @param {*} [options] Override http request option.
|
|
432
520
|
* @throws {RequiredError}
|
|
433
521
|
*/
|
|
@@ -457,6 +545,38 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
457
545
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
458
546
|
});
|
|
459
547
|
},
|
|
548
|
+
/**
|
|
549
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
550
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
551
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
552
|
+
* @param {*} [options] Override http request option.
|
|
553
|
+
* @throws {RequiredError}
|
|
554
|
+
*/
|
|
555
|
+
getPortfolioBudgetExpenditureAll(portfolioId, options) {
|
|
556
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
557
|
+
var _a, _b, _c;
|
|
558
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioBudgetExpenditureAll(portfolioId, options);
|
|
559
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
560
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditureAll']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
561
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
562
|
+
});
|
|
563
|
+
},
|
|
564
|
+
/**
|
|
565
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
566
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
567
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
568
|
+
* @param {*} [options] Override http request option.
|
|
569
|
+
* @throws {RequiredError}
|
|
570
|
+
*/
|
|
571
|
+
getPortfolioBudgetExpenditureNoBudget(portfolioId, options) {
|
|
572
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
573
|
+
var _a, _b, _c;
|
|
574
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioBudgetExpenditureNoBudget(portfolioId, options);
|
|
575
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
576
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditureNoBudget']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
577
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
578
|
+
});
|
|
579
|
+
},
|
|
460
580
|
/**
|
|
461
581
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
462
582
|
* @summary Budget usage summary
|
|
@@ -474,10 +594,10 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
474
594
|
});
|
|
475
595
|
},
|
|
476
596
|
/**
|
|
477
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
597
|
+
* 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.
|
|
478
598
|
* @summary Get portfolio KPIs
|
|
479
599
|
* @param {string} portfolioId UUID of the portfolio
|
|
480
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
600
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
481
601
|
* @param {*} [options] Override http request option.
|
|
482
602
|
* @throws {RequiredError}
|
|
483
603
|
*/
|
|
@@ -508,10 +628,10 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
508
628
|
});
|
|
509
629
|
},
|
|
510
630
|
/**
|
|
511
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
631
|
+
* 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.
|
|
512
632
|
* @summary Portfolio monetized impact over time
|
|
513
633
|
* @param {string} portfolioId UUID of the portfolio
|
|
514
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
634
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
515
635
|
* @param {*} [options] Override http request option.
|
|
516
636
|
* @throws {RequiredError}
|
|
517
637
|
*/
|
|
@@ -524,6 +644,23 @@ const PortfolioKPIApiFp = function (configuration) {
|
|
|
524
644
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
525
645
|
});
|
|
526
646
|
},
|
|
647
|
+
/**
|
|
648
|
+
* 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.
|
|
649
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
650
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
651
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
652
|
+
* @param {*} [options] Override http request option.
|
|
653
|
+
* @throws {RequiredError}
|
|
654
|
+
*/
|
|
655
|
+
getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options) {
|
|
656
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
657
|
+
var _a, _b, _c;
|
|
658
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options);
|
|
659
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
660
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioKPIApi.getPortfolioMonetizedImpactDetailed']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
661
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
662
|
+
});
|
|
663
|
+
},
|
|
527
664
|
};
|
|
528
665
|
};
|
|
529
666
|
exports.PortfolioKPIApiFp = PortfolioKPIApiFp;
|
|
@@ -537,40 +674,37 @@ const PortfolioKPIApiFactory = function (configuration, basePath, axios) {
|
|
|
537
674
|
* Total cost of preferred options starting each year.
|
|
538
675
|
* @summary CAPEX year-by-year distribution
|
|
539
676
|
* @param {string} portfolioId UUID of the portfolio
|
|
540
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
541
677
|
* @param {*} [options] Override http request option.
|
|
542
678
|
* @throws {RequiredError}
|
|
543
679
|
*/
|
|
544
|
-
getCapexDistribution(portfolioId,
|
|
545
|
-
return localVarFp.getCapexDistribution(portfolioId,
|
|
680
|
+
getCapexDistribution(portfolioId, options) {
|
|
681
|
+
return localVarFp.getCapexDistribution(portfolioId, options).then((request) => request(axios, basePath));
|
|
546
682
|
},
|
|
547
683
|
/**
|
|
548
684
|
* Count of investments with a preferred option starting each year.
|
|
549
685
|
* @summary Investment count year-by-year distribution
|
|
550
686
|
* @param {string} portfolioId UUID of the portfolio
|
|
551
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
552
687
|
* @param {*} [options] Override http request option.
|
|
553
688
|
* @throws {RequiredError}
|
|
554
689
|
*/
|
|
555
|
-
getInvestmentsDistribution(portfolioId,
|
|
556
|
-
return localVarFp.getInvestmentsDistribution(portfolioId,
|
|
690
|
+
getInvestmentsDistribution(portfolioId, options) {
|
|
691
|
+
return localVarFp.getInvestmentsDistribution(portfolioId, options).then((request) => request(axios, basePath));
|
|
557
692
|
},
|
|
558
693
|
/**
|
|
559
694
|
* 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.
|
|
560
695
|
* @summary Budget overrun year-by-year distribution
|
|
561
696
|
* @param {string} portfolioId UUID of the portfolio
|
|
562
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
563
697
|
* @param {*} [options] Override http request option.
|
|
564
698
|
* @throws {RequiredError}
|
|
565
699
|
*/
|
|
566
|
-
getKpiOverrunDistribution(portfolioId,
|
|
567
|
-
return localVarFp.getKpiOverrunDistribution(portfolioId,
|
|
700
|
+
getKpiOverrunDistribution(portfolioId, options) {
|
|
701
|
+
return localVarFp.getKpiOverrunDistribution(portfolioId, options).then((request) => request(axios, basePath));
|
|
568
702
|
},
|
|
569
703
|
/**
|
|
570
|
-
* Sum of final NPV of preferred options starting each year.
|
|
704
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
571
705
|
* @summary NPV year-by-year distribution
|
|
572
706
|
* @param {string} portfolioId UUID of the portfolio
|
|
573
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
707
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
574
708
|
* @param {*} [options] Override http request option.
|
|
575
709
|
* @throws {RequiredError}
|
|
576
710
|
*/
|
|
@@ -588,6 +722,26 @@ const PortfolioKPIApiFactory = function (configuration, basePath, axios) {
|
|
|
588
722
|
getPortfolioBudgetExpenditure(portfolioId, budgetId, options) {
|
|
589
723
|
return localVarFp.getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(axios, basePath));
|
|
590
724
|
},
|
|
725
|
+
/**
|
|
726
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
727
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
728
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
729
|
+
* @param {*} [options] Override http request option.
|
|
730
|
+
* @throws {RequiredError}
|
|
731
|
+
*/
|
|
732
|
+
getPortfolioBudgetExpenditureAll(portfolioId, options) {
|
|
733
|
+
return localVarFp.getPortfolioBudgetExpenditureAll(portfolioId, options).then((request) => request(axios, basePath));
|
|
734
|
+
},
|
|
735
|
+
/**
|
|
736
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
737
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
738
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
739
|
+
* @param {*} [options] Override http request option.
|
|
740
|
+
* @throws {RequiredError}
|
|
741
|
+
*/
|
|
742
|
+
getPortfolioBudgetExpenditureNoBudget(portfolioId, options) {
|
|
743
|
+
return localVarFp.getPortfolioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(axios, basePath));
|
|
744
|
+
},
|
|
591
745
|
/**
|
|
592
746
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
593
747
|
* @summary Budget usage summary
|
|
@@ -599,10 +753,10 @@ const PortfolioKPIApiFactory = function (configuration, basePath, axios) {
|
|
|
599
753
|
return localVarFp.getPortfolioBudgetUsage(portfolioId, options).then((request) => request(axios, basePath));
|
|
600
754
|
},
|
|
601
755
|
/**
|
|
602
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
756
|
+
* 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.
|
|
603
757
|
* @summary Get portfolio KPIs
|
|
604
758
|
* @param {string} portfolioId UUID of the portfolio
|
|
605
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
759
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
606
760
|
* @param {*} [options] Override http request option.
|
|
607
761
|
* @throws {RequiredError}
|
|
608
762
|
*/
|
|
@@ -621,16 +775,27 @@ const PortfolioKPIApiFactory = function (configuration, basePath, axios) {
|
|
|
621
775
|
return localVarFp.getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(axios, basePath));
|
|
622
776
|
},
|
|
623
777
|
/**
|
|
624
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
778
|
+
* 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.
|
|
625
779
|
* @summary Portfolio monetized impact over time
|
|
626
780
|
* @param {string} portfolioId UUID of the portfolio
|
|
627
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
781
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
628
782
|
* @param {*} [options] Override http request option.
|
|
629
783
|
* @throws {RequiredError}
|
|
630
784
|
*/
|
|
631
785
|
getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options) {
|
|
632
786
|
return localVarFp.getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
633
787
|
},
|
|
788
|
+
/**
|
|
789
|
+
* 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.
|
|
790
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
791
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
792
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
793
|
+
* @param {*} [options] Override http request option.
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
*/
|
|
796
|
+
getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options) {
|
|
797
|
+
return localVarFp.getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
|
|
798
|
+
},
|
|
634
799
|
};
|
|
635
800
|
};
|
|
636
801
|
exports.PortfolioKPIApiFactory = PortfolioKPIApiFactory;
|
|
@@ -642,40 +807,37 @@ class PortfolioKPIApi extends base_1.BaseAPI {
|
|
|
642
807
|
* Total cost of preferred options starting each year.
|
|
643
808
|
* @summary CAPEX year-by-year distribution
|
|
644
809
|
* @param {string} portfolioId UUID of the portfolio
|
|
645
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
646
810
|
* @param {*} [options] Override http request option.
|
|
647
811
|
* @throws {RequiredError}
|
|
648
812
|
*/
|
|
649
|
-
getCapexDistribution(portfolioId,
|
|
650
|
-
return (0, exports.PortfolioKPIApiFp)(this.configuration).getCapexDistribution(portfolioId,
|
|
813
|
+
getCapexDistribution(portfolioId, options) {
|
|
814
|
+
return (0, exports.PortfolioKPIApiFp)(this.configuration).getCapexDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
651
815
|
}
|
|
652
816
|
/**
|
|
653
817
|
* Count of investments with a preferred option starting each year.
|
|
654
818
|
* @summary Investment count year-by-year distribution
|
|
655
819
|
* @param {string} portfolioId UUID of the portfolio
|
|
656
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
657
820
|
* @param {*} [options] Override http request option.
|
|
658
821
|
* @throws {RequiredError}
|
|
659
822
|
*/
|
|
660
|
-
getInvestmentsDistribution(portfolioId,
|
|
661
|
-
return (0, exports.PortfolioKPIApiFp)(this.configuration).getInvestmentsDistribution(portfolioId,
|
|
823
|
+
getInvestmentsDistribution(portfolioId, options) {
|
|
824
|
+
return (0, exports.PortfolioKPIApiFp)(this.configuration).getInvestmentsDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
662
825
|
}
|
|
663
826
|
/**
|
|
664
827
|
* 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.
|
|
665
828
|
* @summary Budget overrun year-by-year distribution
|
|
666
829
|
* @param {string} portfolioId UUID of the portfolio
|
|
667
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
668
830
|
* @param {*} [options] Override http request option.
|
|
669
831
|
* @throws {RequiredError}
|
|
670
832
|
*/
|
|
671
|
-
getKpiOverrunDistribution(portfolioId,
|
|
672
|
-
return (0, exports.PortfolioKPIApiFp)(this.configuration).getKpiOverrunDistribution(portfolioId,
|
|
833
|
+
getKpiOverrunDistribution(portfolioId, options) {
|
|
834
|
+
return (0, exports.PortfolioKPIApiFp)(this.configuration).getKpiOverrunDistribution(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
673
835
|
}
|
|
674
836
|
/**
|
|
675
|
-
* Sum of final NPV of preferred options starting each year.
|
|
837
|
+
* Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
676
838
|
* @summary NPV year-by-year distribution
|
|
677
839
|
* @param {string} portfolioId UUID of the portfolio
|
|
678
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
840
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
679
841
|
* @param {*} [options] Override http request option.
|
|
680
842
|
* @throws {RequiredError}
|
|
681
843
|
*/
|
|
@@ -693,6 +855,26 @@ class PortfolioKPIApi extends base_1.BaseAPI {
|
|
|
693
855
|
getPortfolioBudgetExpenditure(portfolioId, budgetId, options) {
|
|
694
856
|
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(this.axios, this.basePath));
|
|
695
857
|
}
|
|
858
|
+
/**
|
|
859
|
+
* Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
860
|
+
* @summary Budget year-by-year expenditure for all budgets
|
|
861
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
862
|
+
* @param {*} [options] Override http request option.
|
|
863
|
+
* @throws {RequiredError}
|
|
864
|
+
*/
|
|
865
|
+
getPortfolioBudgetExpenditureAll(portfolioId, options) {
|
|
866
|
+
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioBudgetExpenditureAll(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
867
|
+
}
|
|
868
|
+
/**
|
|
869
|
+
* Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
870
|
+
* @summary Year-by-year expenditure for options with no budget
|
|
871
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
872
|
+
* @param {*} [options] Override http request option.
|
|
873
|
+
* @throws {RequiredError}
|
|
874
|
+
*/
|
|
875
|
+
getPortfolioBudgetExpenditureNoBudget(portfolioId, options) {
|
|
876
|
+
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioBudgetExpenditureNoBudget(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
877
|
+
}
|
|
696
878
|
/**
|
|
697
879
|
* For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
|
|
698
880
|
* @summary Budget usage summary
|
|
@@ -704,10 +886,10 @@ class PortfolioKPIApi extends base_1.BaseAPI {
|
|
|
704
886
|
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioBudgetUsage(portfolioId, options).then((request) => request(this.axios, this.basePath));
|
|
705
887
|
}
|
|
706
888
|
/**
|
|
707
|
-
* Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
889
|
+
* 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.
|
|
708
890
|
* @summary Get portfolio KPIs
|
|
709
891
|
* @param {string} portfolioId UUID of the portfolio
|
|
710
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
892
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
711
893
|
* @param {*} [options] Override http request option.
|
|
712
894
|
* @throws {RequiredError}
|
|
713
895
|
*/
|
|
@@ -726,15 +908,26 @@ class PortfolioKPIApi extends base_1.BaseAPI {
|
|
|
726
908
|
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(this.axios, this.basePath));
|
|
727
909
|
}
|
|
728
910
|
/**
|
|
729
|
-
* Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
911
|
+
* 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.
|
|
730
912
|
* @summary Portfolio monetized impact over time
|
|
731
913
|
* @param {string} portfolioId UUID of the portfolio
|
|
732
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
914
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
733
915
|
* @param {*} [options] Override http request option.
|
|
734
916
|
* @throws {RequiredError}
|
|
735
917
|
*/
|
|
736
918
|
getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options) {
|
|
737
919
|
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
738
920
|
}
|
|
921
|
+
/**
|
|
922
|
+
* 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.
|
|
923
|
+
* @summary Portfolio monetized impact over time (split by metric)
|
|
924
|
+
* @param {string} portfolioId UUID of the portfolio
|
|
925
|
+
* @param {string | null} [valueFrameworkId] UUID of the value framework
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options) {
|
|
930
|
+
return (0, exports.PortfolioKPIApiFp)(this.configuration).getPortfolioMonetizedImpactDetailed(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
|
|
931
|
+
}
|
|
739
932
|
}
|
|
740
933
|
exports.PortfolioKPIApi = PortfolioKPIApi;
|