@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
package/docs/PortfolioKPIApi.md
CHANGED
|
@@ -4,15 +4,18 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**getCapexDistribution**](#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/
|
|
8
|
-
|[**getInvestmentsDistribution**](#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/
|
|
9
|
-
|[**getKpiOverrunDistribution**](#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/
|
|
10
|
-
|[**getNpvDistribution**](#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/
|
|
7
|
+
|[**getCapexDistribution**](#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/capex-distribution | CAPEX year-by-year distribution|
|
|
8
|
+
|[**getInvestmentsDistribution**](#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/investments-distribution | Investment count year-by-year distribution|
|
|
9
|
+
|[**getKpiOverrunDistribution**](#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/overrun-distribution | Budget overrun year-by-year distribution|
|
|
10
|
+
|[**getNpvDistribution**](#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/npv-distribution | NPV year-by-year distribution|
|
|
11
11
|
|[**getPortfolioBudgetExpenditure**](#getportfoliobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure|
|
|
12
|
+
|[**getPortfolioBudgetExpenditureAll**](#getportfoliobudgetexpenditureall) | **GET** /portfolio/{portfolio_id}/budget-expenditure-all | Budget year-by-year expenditure for all budgets|
|
|
13
|
+
|[**getPortfolioBudgetExpenditureNoBudget**](#getportfoliobudgetexpenditurenobudget) | **GET** /portfolio/{portfolio_id}/budget-expenditure-no-budget | Year-by-year expenditure for options with no budget|
|
|
12
14
|
|[**getPortfolioBudgetUsage**](#getportfoliobudgetusage) | **GET** /portfolio/{portfolio_id}/budget-usage | Budget usage summary|
|
|
13
|
-
|[**getPortfolioKpis**](#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis
|
|
15
|
+
|[**getPortfolioKpis**](#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis | Get portfolio KPIs|
|
|
14
16
|
|[**getPortfolioMetricPerformance**](#getportfoliometricperformance) | **GET** /portfolio/{portfolio_id}/metric-performance/{metric_id} | Metric performance over time|
|
|
15
|
-
|[**getPortfolioMonetizedImpact**](#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact
|
|
17
|
+
|[**getPortfolioMonetizedImpact**](#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact | Portfolio monetized impact over time|
|
|
18
|
+
|[**getPortfolioMonetizedImpactDetailed**](#getportfoliomonetizedimpactdetailed) | **GET** /portfolio/{portfolio_id}/monetized-impact/detailed | Portfolio monetized impact over time (split by metric)|
|
|
16
19
|
|
|
17
20
|
# **getCapexDistribution**
|
|
18
21
|
> PortfolioKPIDistributionResponse getCapexDistribution()
|
|
@@ -31,11 +34,9 @@ const configuration = new Configuration();
|
|
|
31
34
|
const apiInstance = new PortfolioKPIApi(configuration);
|
|
32
35
|
|
|
33
36
|
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
34
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
35
37
|
|
|
36
38
|
const { status, data } = await apiInstance.getCapexDistribution(
|
|
37
|
-
portfolioId
|
|
38
|
-
valueFrameworkId
|
|
39
|
+
portfolioId
|
|
39
40
|
);
|
|
40
41
|
```
|
|
41
42
|
|
|
@@ -44,7 +45,6 @@ const { status, data } = await apiInstance.getCapexDistribution(
|
|
|
44
45
|
|Name | Type | Description | Notes|
|
|
45
46
|
|------------- | ------------- | ------------- | -------------|
|
|
46
47
|
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
47
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### Return type
|
|
@@ -65,7 +65,7 @@ const { status, data } = await apiInstance.getCapexDistribution(
|
|
|
65
65
|
| Status code | Description | Response headers |
|
|
66
66
|
|-------------|-------------|------------------|
|
|
67
67
|
|**200** | Year-by-year CAPEX breakdown | - |
|
|
68
|
-
|**404** | Portfolio
|
|
68
|
+
|**404** | Portfolio not found | - |
|
|
69
69
|
|
|
70
70
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
71
71
|
|
|
@@ -86,11 +86,9 @@ const configuration = new Configuration();
|
|
|
86
86
|
const apiInstance = new PortfolioKPIApi(configuration);
|
|
87
87
|
|
|
88
88
|
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
89
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
90
89
|
|
|
91
90
|
const { status, data } = await apiInstance.getInvestmentsDistribution(
|
|
92
|
-
portfolioId
|
|
93
|
-
valueFrameworkId
|
|
91
|
+
portfolioId
|
|
94
92
|
);
|
|
95
93
|
```
|
|
96
94
|
|
|
@@ -99,7 +97,6 @@ const { status, data } = await apiInstance.getInvestmentsDistribution(
|
|
|
99
97
|
|Name | Type | Description | Notes|
|
|
100
98
|
|------------- | ------------- | ------------- | -------------|
|
|
101
99
|
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
102
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
103
100
|
|
|
104
101
|
|
|
105
102
|
### Return type
|
|
@@ -120,7 +117,7 @@ const { status, data } = await apiInstance.getInvestmentsDistribution(
|
|
|
120
117
|
| Status code | Description | Response headers |
|
|
121
118
|
|-------------|-------------|------------------|
|
|
122
119
|
|**200** | Year-by-year investment count | - |
|
|
123
|
-
|**404** | Portfolio
|
|
120
|
+
|**404** | Portfolio not found | - |
|
|
124
121
|
|
|
125
122
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
126
123
|
|
|
@@ -141,11 +138,9 @@ const configuration = new Configuration();
|
|
|
141
138
|
const apiInstance = new PortfolioKPIApi(configuration);
|
|
142
139
|
|
|
143
140
|
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
144
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
145
141
|
|
|
146
142
|
const { status, data } = await apiInstance.getKpiOverrunDistribution(
|
|
147
|
-
portfolioId
|
|
148
|
-
valueFrameworkId
|
|
143
|
+
portfolioId
|
|
149
144
|
);
|
|
150
145
|
```
|
|
151
146
|
|
|
@@ -154,7 +149,6 @@ const { status, data } = await apiInstance.getKpiOverrunDistribution(
|
|
|
154
149
|
|Name | Type | Description | Notes|
|
|
155
150
|
|------------- | ------------- | ------------- | -------------|
|
|
156
151
|
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
157
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
158
152
|
|
|
159
153
|
|
|
160
154
|
### Return type
|
|
@@ -175,14 +169,14 @@ const { status, data } = await apiInstance.getKpiOverrunDistribution(
|
|
|
175
169
|
| Status code | Description | Response headers |
|
|
176
170
|
|-------------|-------------|------------------|
|
|
177
171
|
|**200** | Year-by-year budget overrun breakdown | - |
|
|
178
|
-
|**404** | Portfolio
|
|
172
|
+
|**404** | Portfolio not found | - |
|
|
179
173
|
|
|
180
174
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
181
175
|
|
|
182
176
|
# **getNpvDistribution**
|
|
183
177
|
> PortfolioKPIDistributionResponse getNpvDistribution()
|
|
184
178
|
|
|
185
|
-
Sum of final NPV of preferred options starting each year.
|
|
179
|
+
Sum of final NPV of preferred options starting each year. Requires value_framework_id query parameter; returns empty data when omitted.
|
|
186
180
|
|
|
187
181
|
### Example
|
|
188
182
|
|
|
@@ -196,7 +190,7 @@ const configuration = new Configuration();
|
|
|
196
190
|
const apiInstance = new PortfolioKPIApi(configuration);
|
|
197
191
|
|
|
198
192
|
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
199
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
193
|
+
let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
|
|
200
194
|
|
|
201
195
|
const { status, data } = await apiInstance.getNpvDistribution(
|
|
202
196
|
portfolioId,
|
|
@@ -209,7 +203,7 @@ const { status, data } = await apiInstance.getNpvDistribution(
|
|
|
209
203
|
|Name | Type | Description | Notes|
|
|
210
204
|
|------------- | ------------- | ------------- | -------------|
|
|
211
205
|
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
212
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
206
|
+
| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
|
|
213
207
|
|
|
214
208
|
|
|
215
209
|
### Return type
|
|
@@ -289,6 +283,110 @@ const { status, data } = await apiInstance.getPortfolioBudgetExpenditure(
|
|
|
289
283
|
|
|
290
284
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
291
285
|
|
|
286
|
+
# **getPortfolioBudgetExpenditureAll**
|
|
287
|
+
> Array<PortfolioBudgetExpenditureResponse> getPortfolioBudgetExpenditureAll()
|
|
288
|
+
|
|
289
|
+
Return year-by-year expenditure of preferred options for every budget referenced in this portfolio. Each budget is returned as a separate item.
|
|
290
|
+
|
|
291
|
+
### Example
|
|
292
|
+
|
|
293
|
+
```typescript
|
|
294
|
+
import {
|
|
295
|
+
PortfolioKPIApi,
|
|
296
|
+
Configuration
|
|
297
|
+
} from '@cosmotech/aip-client';
|
|
298
|
+
|
|
299
|
+
const configuration = new Configuration();
|
|
300
|
+
const apiInstance = new PortfolioKPIApi(configuration);
|
|
301
|
+
|
|
302
|
+
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
303
|
+
|
|
304
|
+
const { status, data } = await apiInstance.getPortfolioBudgetExpenditureAll(
|
|
305
|
+
portfolioId
|
|
306
|
+
);
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
### Parameters
|
|
310
|
+
|
|
311
|
+
|Name | Type | Description | Notes|
|
|
312
|
+
|------------- | ------------- | ------------- | -------------|
|
|
313
|
+
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
### Return type
|
|
317
|
+
|
|
318
|
+
**Array<PortfolioBudgetExpenditureResponse>**
|
|
319
|
+
|
|
320
|
+
### Authorization
|
|
321
|
+
|
|
322
|
+
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
323
|
+
|
|
324
|
+
### HTTP request headers
|
|
325
|
+
|
|
326
|
+
- **Content-Type**: Not defined
|
|
327
|
+
- **Accept**: application/json
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### HTTP response details
|
|
331
|
+
| Status code | Description | Response headers |
|
|
332
|
+
|-------------|-------------|------------------|
|
|
333
|
+
|**200** | Budget expenditure over time for all budgets | - |
|
|
334
|
+
|**404** | Portfolio not found | - |
|
|
335
|
+
|
|
336
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
337
|
+
|
|
338
|
+
# **getPortfolioBudgetExpenditureNoBudget**
|
|
339
|
+
> PortfolioBudgetExpenditureResponse getPortfolioBudgetExpenditureNoBudget()
|
|
340
|
+
|
|
341
|
+
Return year-by-year expenditure of preferred options that have no budget assigned within this portfolio.
|
|
342
|
+
|
|
343
|
+
### Example
|
|
344
|
+
|
|
345
|
+
```typescript
|
|
346
|
+
import {
|
|
347
|
+
PortfolioKPIApi,
|
|
348
|
+
Configuration
|
|
349
|
+
} from '@cosmotech/aip-client';
|
|
350
|
+
|
|
351
|
+
const configuration = new Configuration();
|
|
352
|
+
const apiInstance = new PortfolioKPIApi(configuration);
|
|
353
|
+
|
|
354
|
+
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
355
|
+
|
|
356
|
+
const { status, data } = await apiInstance.getPortfolioBudgetExpenditureNoBudget(
|
|
357
|
+
portfolioId
|
|
358
|
+
);
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
### Parameters
|
|
362
|
+
|
|
363
|
+
|Name | Type | Description | Notes|
|
|
364
|
+
|------------- | ------------- | ------------- | -------------|
|
|
365
|
+
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
### Return type
|
|
369
|
+
|
|
370
|
+
**PortfolioBudgetExpenditureResponse**
|
|
371
|
+
|
|
372
|
+
### Authorization
|
|
373
|
+
|
|
374
|
+
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
375
|
+
|
|
376
|
+
### HTTP request headers
|
|
377
|
+
|
|
378
|
+
- **Content-Type**: Not defined
|
|
379
|
+
- **Accept**: application/json
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
### HTTP response details
|
|
383
|
+
| Status code | Description | Response headers |
|
|
384
|
+
|-------------|-------------|------------------|
|
|
385
|
+
|**200** | Expenditure over time for unbudgeted options | - |
|
|
386
|
+
|**404** | Portfolio not found | - |
|
|
387
|
+
|
|
388
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
389
|
+
|
|
292
390
|
# **getPortfolioBudgetUsage**
|
|
293
391
|
> Array<PortfolioBudgetUsageItem> getPortfolioBudgetUsage()
|
|
294
392
|
|
|
@@ -344,7 +442,7 @@ const { status, data } = await apiInstance.getPortfolioBudgetUsage(
|
|
|
344
442
|
# **getPortfolioKpis**
|
|
345
443
|
> PortfolioKPIResponse getPortfolioKpis()
|
|
346
444
|
|
|
347
|
-
Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio
|
|
445
|
+
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.
|
|
348
446
|
|
|
349
447
|
### Example
|
|
350
448
|
|
|
@@ -358,7 +456,7 @@ const configuration = new Configuration();
|
|
|
358
456
|
const apiInstance = new PortfolioKPIApi(configuration);
|
|
359
457
|
|
|
360
458
|
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
361
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
459
|
+
let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
|
|
362
460
|
|
|
363
461
|
const { status, data } = await apiInstance.getPortfolioKpis(
|
|
364
462
|
portfolioId,
|
|
@@ -371,7 +469,7 @@ const { status, data } = await apiInstance.getPortfolioKpis(
|
|
|
371
469
|
|Name | Type | Description | Notes|
|
|
372
470
|
|------------- | ------------- | ------------- | -------------|
|
|
373
471
|
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
374
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
472
|
+
| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
|
|
375
473
|
|
|
376
474
|
|
|
377
475
|
### Return type
|
|
@@ -454,7 +552,7 @@ const { status, data } = await apiInstance.getPortfolioMetricPerformance(
|
|
|
454
552
|
# **getPortfolioMonetizedImpact**
|
|
455
553
|
> MonetizedImpactResponse getPortfolioMonetizedImpact()
|
|
456
554
|
|
|
457
|
-
Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
|
|
555
|
+
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.
|
|
458
556
|
|
|
459
557
|
### Example
|
|
460
558
|
|
|
@@ -468,7 +566,7 @@ const configuration = new Configuration();
|
|
|
468
566
|
const apiInstance = new PortfolioKPIApi(configuration);
|
|
469
567
|
|
|
470
568
|
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
471
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
569
|
+
let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
|
|
472
570
|
|
|
473
571
|
const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
|
|
474
572
|
portfolioId,
|
|
@@ -481,7 +579,7 @@ const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
|
|
|
481
579
|
|Name | Type | Description | Notes|
|
|
482
580
|
|------------- | ------------- | ------------- | -------------|
|
|
483
581
|
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
484
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
582
|
+
| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
|
|
485
583
|
|
|
486
584
|
|
|
487
585
|
### Return type
|
|
@@ -506,3 +604,58 @@ const { status, data } = await apiInstance.getPortfolioMonetizedImpact(
|
|
|
506
604
|
|
|
507
605
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
508
606
|
|
|
607
|
+
# **getPortfolioMonetizedImpactDetailed**
|
|
608
|
+
> MonetizedImpactDetailedResponse getPortfolioMonetizedImpactDetailed()
|
|
609
|
+
|
|
610
|
+
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.
|
|
611
|
+
|
|
612
|
+
### Example
|
|
613
|
+
|
|
614
|
+
```typescript
|
|
615
|
+
import {
|
|
616
|
+
PortfolioKPIApi,
|
|
617
|
+
Configuration
|
|
618
|
+
} from '@cosmotech/aip-client';
|
|
619
|
+
|
|
620
|
+
const configuration = new Configuration();
|
|
621
|
+
const apiInstance = new PortfolioKPIApi(configuration);
|
|
622
|
+
|
|
623
|
+
let portfolioId: string; //UUID of the portfolio (default to undefined)
|
|
624
|
+
let valueFrameworkId: string; //UUID of the value framework (optional) (default to undefined)
|
|
625
|
+
|
|
626
|
+
const { status, data } = await apiInstance.getPortfolioMonetizedImpactDetailed(
|
|
627
|
+
portfolioId,
|
|
628
|
+
valueFrameworkId
|
|
629
|
+
);
|
|
630
|
+
```
|
|
631
|
+
|
|
632
|
+
### Parameters
|
|
633
|
+
|
|
634
|
+
|Name | Type | Description | Notes|
|
|
635
|
+
|------------- | ------------- | ------------- | -------------|
|
|
636
|
+
| **portfolioId** | [**string**] | UUID of the portfolio | defaults to undefined|
|
|
637
|
+
| **valueFrameworkId** | [**string**] | UUID of the value framework | (optional) defaults to undefined|
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
### Return type
|
|
641
|
+
|
|
642
|
+
**MonetizedImpactDetailedResponse**
|
|
643
|
+
|
|
644
|
+
### Authorization
|
|
645
|
+
|
|
646
|
+
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
647
|
+
|
|
648
|
+
### HTTP request headers
|
|
649
|
+
|
|
650
|
+
- **Content-Type**: Not defined
|
|
651
|
+
- **Accept**: application/json
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
### HTTP response details
|
|
655
|
+
| Status code | Description | Response headers |
|
|
656
|
+
|-------------|-------------|------------------|
|
|
657
|
+
|**200** | Detailed monetized impact data | - |
|
|
658
|
+
|**404** | Portfolio or value framework not found | - |
|
|
659
|
+
|
|
660
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
661
|
+
|
|
@@ -7,7 +7,7 @@ Response for the KPI distribution endpoint (investments / capex / npv).
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**data** | [**Array<PortfolioKPIDistributionYearValue>**](PortfolioKPIDistributionYearValue.md) | | [default to undefined]
|
|
10
|
-
**kpi** | **string** | | [default to undefined]
|
|
10
|
+
**kpi** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**unit** | **string** | | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
package/index.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/budget-create.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
* Schema for one row in the \'Options using budget\' tab on the budget detail page.
|
|
19
19
|
*/
|
|
20
20
|
export interface BudgetOptionResponse {
|
|
21
|
+
'budget_id'?: string | null;
|
|
21
22
|
/**
|
|
22
23
|
* Total investment cost of the option
|
|
23
24
|
*/
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/budget-update.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/evolution-type.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/impact-create.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/impact-update.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/index.ts
CHANGED
|
@@ -28,6 +28,9 @@ export * from './metric-performance-year';
|
|
|
28
28
|
export * from './metric-response';
|
|
29
29
|
export * from './metric-type';
|
|
30
30
|
export * from './metric-update';
|
|
31
|
+
export * from './monetized-impact-detailed-response';
|
|
32
|
+
export * from './monetized-impact-detailed-year';
|
|
33
|
+
export * from './monetized-impact-metric-value';
|
|
31
34
|
export * from './monetized-impact-response';
|
|
32
35
|
export * from './monetized-impact-year';
|
|
33
36
|
export * from './objective-create';
|
|
@@ -50,6 +53,7 @@ export * from './portfolio-create';
|
|
|
50
53
|
export * from './portfolio-investment-bulk-add-request';
|
|
51
54
|
export * from './portfolio-investment-bulk-add-response';
|
|
52
55
|
export * from './portfolio-investment-bulk-delete-request';
|
|
56
|
+
export * from './portfolio-investment-overview-response';
|
|
53
57
|
export * from './portfolio-investment-response';
|
|
54
58
|
export * from './portfolio-kpidistribution-budget-item';
|
|
55
59
|
export * from './portfolio-kpidistribution-response';
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/location-inner.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/models/metric-create.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-dev4
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|