@cosmotech/aip-client 0.3.0-dev2 → 0.3.0-dev3
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 +4 -40
- package/api/budget-api.ts +1 -1
- package/api/default-api.ts +1 -1
- package/api/impact-api.ts +90 -1
- package/api/investment-api.ts +55 -1254
- 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 -509
- package/api/objective-weight-api.ts +1 -1
- package/api/objective-weights-api.ts +1 -1
- package/api/option-api.ts +1 -454
- package/api/preferred-option-api.ts +1 -1
- package/api/value-framework-api.ts +61 -1189
- 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 +1 -1
- package/dist/api/budget-api.js +1 -1
- package/dist/api/default-api.d.ts +1 -1
- package/dist/api/default-api.js +1 -1
- package/dist/api/impact-api.d.ts +42 -1
- package/dist/api/impact-api.js +85 -1
- package/dist/api/investment-api.d.ts +1 -551
- package/dist/api/investment-api.js +57 -1189
- 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 -233
- package/dist/api/objective-api.js +1 -479
- 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 -212
- package/dist/api/option-api.js +1 -431
- 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 -519
- package/dist/api/value-framework-api.js +61 -1128
- 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 +1 -1
- package/dist/esm/api/budget-api.js +1 -1
- package/dist/esm/api/default-api.d.ts +1 -1
- package/dist/esm/api/default-api.js +1 -1
- package/dist/esm/api/impact-api.d.ts +42 -1
- package/dist/esm/api/impact-api.js +85 -1
- package/dist/esm/api/investment-api.d.ts +1 -551
- package/dist/esm/api/investment-api.js +56 -1188
- 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 -233
- package/dist/esm/api/objective-api.js +1 -479
- 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 -212
- package/dist/esm/api/option-api.js +1 -431
- 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 -519
- package/dist/esm/api/value-framework-api.js +61 -1128
- 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 +1 -1
- package/dist/esm/models/budget-option-response.js +1 -1
- package/dist/esm/models/budget-overview-response.d.ts +1 -1
- package/dist/esm/models/budget-overview-response.js +1 -1
- package/dist/esm/models/budget-response.d.ts +1 -1
- package/dist/esm/models/budget-response.js +1 -1
- package/dist/esm/models/budget-update.d.ts +1 -1
- package/dist/esm/models/budget-update.js +1 -1
- package/dist/esm/models/bulk-delete-request.d.ts +1 -1
- package/dist/esm/models/bulk-delete-request.js +1 -1
- package/dist/esm/models/evolution-type.d.ts +1 -1
- package/dist/esm/models/evolution-type.js +1 -1
- package/dist/esm/models/httpvalidation-error.d.ts +1 -1
- package/dist/esm/models/httpvalidation-error.js +1 -1
- package/dist/esm/models/impact-apiresponse.d.ts +1 -1
- package/dist/esm/models/impact-apiresponse.js +1 -1
- package/dist/esm/models/impact-bulk-item.d.ts +37 -0
- package/dist/esm/models/impact-bulk-item.js +14 -0
- 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 +1 -0
- package/dist/esm/models/index.js +1 -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-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/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/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 +1 -1
- package/dist/models/budget-option-response.js +1 -1
- package/dist/models/budget-overview-response.d.ts +1 -1
- package/dist/models/budget-overview-response.js +1 -1
- package/dist/models/budget-response.d.ts +1 -1
- package/dist/models/budget-response.js +1 -1
- package/dist/models/budget-update.d.ts +1 -1
- package/dist/models/budget-update.js +1 -1
- package/dist/models/bulk-delete-request.d.ts +1 -1
- package/dist/models/bulk-delete-request.js +1 -1
- package/dist/models/evolution-type.d.ts +1 -1
- package/dist/models/evolution-type.js +1 -1
- package/dist/models/httpvalidation-error.d.ts +1 -1
- package/dist/models/httpvalidation-error.js +1 -1
- package/dist/models/impact-apiresponse.d.ts +1 -1
- package/dist/models/impact-apiresponse.js +1 -1
- package/dist/models/impact-bulk-item.d.ts +37 -0
- package/dist/models/impact-bulk-item.js +15 -0
- 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 +1 -0
- package/dist/models/index.js +1 -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-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/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/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/ImpactApi.md +60 -0
- package/docs/ImpactBulkItem.md +29 -0
- package/docs/InvestmentApi.md +29 -851
- package/docs/ObjectiveApi.md +0 -351
- package/docs/OptionApi.md +0 -305
- package/docs/ValueFrameworkApi.md +7 -778
- package/index.ts +1 -1
- package/models/budget-bulk-delete-request.ts +1 -1
- package/models/budget-create.ts +1 -1
- package/models/budget-investment-response.ts +1 -1
- package/models/budget-link-options-request.ts +1 -1
- package/models/budget-option-response.ts +1 -1
- package/models/budget-overview-response.ts +1 -1
- package/models/budget-response.ts +1 -1
- package/models/budget-update.ts +1 -1
- package/models/bulk-delete-request.ts +1 -1
- package/models/evolution-type.ts +1 -1
- package/models/httpvalidation-error.ts +1 -1
- package/models/impact-apiresponse.ts +1 -1
- package/models/impact-bulk-item.ts +47 -0
- package/models/impact-create.ts +1 -1
- package/models/impact-update.ts +1 -1
- package/models/index.ts +1 -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-response.ts +1 -1
- package/models/metric-type.ts +1 -1
- package/models/metric-update.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/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
|
@@ -4,545 +4,16 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**createMetricCostForFramework**](#createmetriccostforframework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework|
|
|
8
|
-
|[**createObjectiveWeightForFramework**](#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework|
|
|
9
|
-
|[**deleteMetricCostForFramework**](#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework|
|
|
10
|
-
|[**deleteObjectiveWeightForFramework**](#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework|
|
|
11
7
|
|[**deleteValueFramework**](#deletevalueframework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework|
|
|
12
|
-
|[**getCostsForValueFramework**](#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework|
|
|
13
|
-
|[**getCostsForValueFrameworkByMetric**](#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric|
|
|
14
|
-
|[**getMetricCostForFramework**](#getmetriccostforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework|
|
|
15
|
-
|[**getMetricCostsForFramework**](#getmetriccostsforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework|
|
|
16
|
-
|[**getObjectiveWeightForFramework**](#getobjectiveweightforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework|
|
|
17
|
-
|[**getObjectiveWeightsForFramework**](#getobjectiveweightsforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework|
|
|
18
8
|
|[**getValueFrameworkById**](#getvalueframeworkbyid) | **GET** /value_framework/{value_framework_id} | Get a value framework by ID|
|
|
19
9
|
|[**getValueFrameworks**](#getvalueframeworks) | **GET** /value_framework/ | List value frameworks|
|
|
20
|
-
|[**getWeightsForValueFramework**](#getweightsforvalueframework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework|
|
|
21
|
-
|[**patchMetricCostForFramework**](#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework|
|
|
22
|
-
|[**patchObjectiveWeightForFramework**](#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework|
|
|
23
10
|
|[**patchValueFramework**](#patchvalueframework) | **PATCH** /value_framework/{value_framework_id} | Partially update a value framework|
|
|
24
11
|
|[**postValueFramework**](#postvalueframework) | **POST** /value_framework/ | Create a value framework|
|
|
25
12
|
|
|
26
|
-
# **
|
|
27
|
-
>
|
|
28
|
-
|
|
29
|
-
Create a yearly cost override for a metric within this framework.
|
|
30
|
-
|
|
31
|
-
### Example
|
|
32
|
-
|
|
33
|
-
```typescript
|
|
34
|
-
import {
|
|
35
|
-
ValueFrameworkApi,
|
|
36
|
-
Configuration,
|
|
37
|
-
MetricCostsPerYearCreate
|
|
38
|
-
} from '@cosmotech/aip-client';
|
|
39
|
-
|
|
40
|
-
const configuration = new Configuration();
|
|
41
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
42
|
-
|
|
43
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
44
|
-
let metricCostsPerYearCreate: MetricCostsPerYearCreate; //
|
|
45
|
-
|
|
46
|
-
const { status, data } = await apiInstance.createMetricCostForFramework(
|
|
47
|
-
valueFrameworkId,
|
|
48
|
-
metricCostsPerYearCreate
|
|
49
|
-
);
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Parameters
|
|
53
|
-
|
|
54
|
-
|Name | Type | Description | Notes|
|
|
55
|
-
|------------- | ------------- | ------------- | -------------|
|
|
56
|
-
| **metricCostsPerYearCreate** | **MetricCostsPerYearCreate**| | |
|
|
57
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
### Return type
|
|
61
|
-
|
|
62
|
-
**MetricCostsPerYearResponse**
|
|
63
|
-
|
|
64
|
-
### Authorization
|
|
65
|
-
|
|
66
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
67
|
-
|
|
68
|
-
### HTTP request headers
|
|
69
|
-
|
|
70
|
-
- **Content-Type**: application/json
|
|
71
|
-
- **Accept**: application/json
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
### HTTP response details
|
|
75
|
-
| Status code | Description | Response headers |
|
|
76
|
-
|-------------|-------------|------------------|
|
|
77
|
-
|**201** | Yearly metric cost created successfully | - |
|
|
78
|
-
|**400** | Invalid input, referenced metric not found, or year out of range | - |
|
|
79
|
-
|**404** | Value framework not found | - |
|
|
80
|
-
|**409** | Cost entry already exists for this metric/framework/year | - |
|
|
81
|
-
|
|
82
|
-
[[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)
|
|
83
|
-
|
|
84
|
-
# **createObjectiveWeightForFramework**
|
|
85
|
-
> ObjectiveWeightResponse createObjectiveWeightForFramework(objectiveWeightCreate)
|
|
86
|
-
|
|
87
|
-
Assign a weight to an objective within this framework.
|
|
88
|
-
|
|
89
|
-
### Example
|
|
90
|
-
|
|
91
|
-
```typescript
|
|
92
|
-
import {
|
|
93
|
-
ValueFrameworkApi,
|
|
94
|
-
Configuration,
|
|
95
|
-
ObjectiveWeightCreate
|
|
96
|
-
} from '@cosmotech/aip-client';
|
|
97
|
-
|
|
98
|
-
const configuration = new Configuration();
|
|
99
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
100
|
-
|
|
101
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
102
|
-
let objectiveWeightCreate: ObjectiveWeightCreate; //
|
|
103
|
-
|
|
104
|
-
const { status, data } = await apiInstance.createObjectiveWeightForFramework(
|
|
105
|
-
valueFrameworkId,
|
|
106
|
-
objectiveWeightCreate
|
|
107
|
-
);
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
### Parameters
|
|
111
|
-
|
|
112
|
-
|Name | Type | Description | Notes|
|
|
113
|
-
|------------- | ------------- | ------------- | -------------|
|
|
114
|
-
| **objectiveWeightCreate** | **ObjectiveWeightCreate**| | |
|
|
115
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
### Return type
|
|
119
|
-
|
|
120
|
-
**ObjectiveWeightResponse**
|
|
121
|
-
|
|
122
|
-
### Authorization
|
|
123
|
-
|
|
124
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
125
|
-
|
|
126
|
-
### HTTP request headers
|
|
127
|
-
|
|
128
|
-
- **Content-Type**: application/json
|
|
129
|
-
- **Accept**: application/json
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
### HTTP response details
|
|
133
|
-
| Status code | Description | Response headers |
|
|
134
|
-
|-------------|-------------|------------------|
|
|
135
|
-
|**201** | Objective weight created successfully | - |
|
|
136
|
-
|**400** | Invalid input or constraint violation | - |
|
|
137
|
-
|**404** | Value framework not found | - |
|
|
138
|
-
|**409** | Weight already exists for this framework/objective pair | - |
|
|
139
|
-
|
|
140
|
-
[[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)
|
|
141
|
-
|
|
142
|
-
# **deleteMetricCostForFramework**
|
|
143
|
-
> deleteMetricCostForFramework()
|
|
144
|
-
|
|
145
|
-
Delete a metric cost entry for a specific year within this framework.
|
|
146
|
-
|
|
147
|
-
### Example
|
|
148
|
-
|
|
149
|
-
```typescript
|
|
150
|
-
import {
|
|
151
|
-
ValueFrameworkApi,
|
|
152
|
-
Configuration
|
|
153
|
-
} from '@cosmotech/aip-client';
|
|
154
|
-
|
|
155
|
-
const configuration = new Configuration();
|
|
156
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
157
|
-
|
|
158
|
-
let metricId: string; //UUID of the metric (default to undefined)
|
|
159
|
-
let year: number; //Year (1600-3000) (default to undefined)
|
|
160
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
161
|
-
|
|
162
|
-
const { status, data } = await apiInstance.deleteMetricCostForFramework(
|
|
163
|
-
metricId,
|
|
164
|
-
year,
|
|
165
|
-
valueFrameworkId
|
|
166
|
-
);
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
### Parameters
|
|
170
|
-
|
|
171
|
-
|Name | Type | Description | Notes|
|
|
172
|
-
|------------- | ------------- | ------------- | -------------|
|
|
173
|
-
| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
|
|
174
|
-
| **year** | [**number**] | Year (1600-3000) | defaults to undefined|
|
|
175
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
### Return type
|
|
179
|
-
|
|
180
|
-
void (empty response body)
|
|
181
|
-
|
|
182
|
-
### Authorization
|
|
183
|
-
|
|
184
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
185
|
-
|
|
186
|
-
### HTTP request headers
|
|
187
|
-
|
|
188
|
-
- **Content-Type**: Not defined
|
|
189
|
-
- **Accept**: Not defined
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
### HTTP response details
|
|
193
|
-
| Status code | Description | Response headers |
|
|
194
|
-
|-------------|-------------|------------------|
|
|
195
|
-
|**204** | Metric cost successfully deleted | - |
|
|
196
|
-
|**404** | Value framework or metric cost not found | - |
|
|
197
|
-
|
|
198
|
-
[[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)
|
|
199
|
-
|
|
200
|
-
# **deleteObjectiveWeightForFramework**
|
|
201
|
-
> deleteObjectiveWeightForFramework()
|
|
202
|
-
|
|
203
|
-
Remove an objective weight from this framework.
|
|
204
|
-
|
|
205
|
-
### Example
|
|
206
|
-
|
|
207
|
-
```typescript
|
|
208
|
-
import {
|
|
209
|
-
ValueFrameworkApi,
|
|
210
|
-
Configuration
|
|
211
|
-
} from '@cosmotech/aip-client';
|
|
212
|
-
|
|
213
|
-
const configuration = new Configuration();
|
|
214
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
215
|
-
|
|
216
|
-
let objectiveId: string; //UUID of the objective (default to undefined)
|
|
217
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
218
|
-
|
|
219
|
-
const { status, data } = await apiInstance.deleteObjectiveWeightForFramework(
|
|
220
|
-
objectiveId,
|
|
221
|
-
valueFrameworkId
|
|
222
|
-
);
|
|
223
|
-
```
|
|
224
|
-
|
|
225
|
-
### Parameters
|
|
226
|
-
|
|
227
|
-
|Name | Type | Description | Notes|
|
|
228
|
-
|------------- | ------------- | ------------- | -------------|
|
|
229
|
-
| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
|
|
230
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
### Return type
|
|
234
|
-
|
|
235
|
-
void (empty response body)
|
|
236
|
-
|
|
237
|
-
### Authorization
|
|
238
|
-
|
|
239
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
240
|
-
|
|
241
|
-
### HTTP request headers
|
|
242
|
-
|
|
243
|
-
- **Content-Type**: Not defined
|
|
244
|
-
- **Accept**: Not defined
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
### HTTP response details
|
|
248
|
-
| Status code | Description | Response headers |
|
|
249
|
-
|-------------|-------------|------------------|
|
|
250
|
-
|**204** | Objective weight successfully deleted | - |
|
|
251
|
-
|**404** | Value framework or objective weight not found | - |
|
|
252
|
-
|
|
253
|
-
[[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)
|
|
254
|
-
|
|
255
|
-
# **deleteValueFramework**
|
|
256
|
-
> deleteValueFramework()
|
|
257
|
-
|
|
258
|
-
Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
259
|
-
|
|
260
|
-
### Example
|
|
261
|
-
|
|
262
|
-
```typescript
|
|
263
|
-
import {
|
|
264
|
-
ValueFrameworkApi,
|
|
265
|
-
Configuration
|
|
266
|
-
} from '@cosmotech/aip-client';
|
|
267
|
-
|
|
268
|
-
const configuration = new Configuration();
|
|
269
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
270
|
-
|
|
271
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
272
|
-
|
|
273
|
-
const { status, data } = await apiInstance.deleteValueFramework(
|
|
274
|
-
valueFrameworkId
|
|
275
|
-
);
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
### Parameters
|
|
279
|
-
|
|
280
|
-
|Name | Type | Description | Notes|
|
|
281
|
-
|------------- | ------------- | ------------- | -------------|
|
|
282
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
### Return type
|
|
286
|
-
|
|
287
|
-
void (empty response body)
|
|
288
|
-
|
|
289
|
-
### Authorization
|
|
290
|
-
|
|
291
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
292
|
-
|
|
293
|
-
### HTTP request headers
|
|
294
|
-
|
|
295
|
-
- **Content-Type**: Not defined
|
|
296
|
-
- **Accept**: Not defined
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
### HTTP response details
|
|
300
|
-
| Status code | Description | Response headers |
|
|
301
|
-
|-------------|-------------|------------------|
|
|
302
|
-
|**204** | Value framework successfully deleted | - |
|
|
303
|
-
|**404** | Value framework not found | - |
|
|
304
|
-
|
|
305
|
-
[[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)
|
|
306
|
-
|
|
307
|
-
# **getCostsForValueFramework**
|
|
308
|
-
> Array<MetricCostsPerYearResponse> getCostsForValueFramework()
|
|
309
|
-
|
|
310
|
-
Retrieve a paginated list of all metric costs for a specific value framework.
|
|
311
|
-
|
|
312
|
-
### Example
|
|
313
|
-
|
|
314
|
-
```typescript
|
|
315
|
-
import {
|
|
316
|
-
ValueFrameworkApi,
|
|
317
|
-
Configuration
|
|
318
|
-
} from '@cosmotech/aip-client';
|
|
319
|
-
|
|
320
|
-
const configuration = new Configuration();
|
|
321
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
322
|
-
|
|
323
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
324
|
-
let offset: number; //Number of records to skip (optional) (default to 0)
|
|
325
|
-
let limit: number; //Max number of records to return (optional) (default to 100)
|
|
326
|
-
|
|
327
|
-
const { status, data } = await apiInstance.getCostsForValueFramework(
|
|
328
|
-
valueFrameworkId,
|
|
329
|
-
offset,
|
|
330
|
-
limit
|
|
331
|
-
);
|
|
332
|
-
```
|
|
333
|
-
|
|
334
|
-
### Parameters
|
|
335
|
-
|
|
336
|
-
|Name | Type | Description | Notes|
|
|
337
|
-
|------------- | ------------- | ------------- | -------------|
|
|
338
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
339
|
-
| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
|
|
340
|
-
| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
### Return type
|
|
344
|
-
|
|
345
|
-
**Array<MetricCostsPerYearResponse>**
|
|
346
|
-
|
|
347
|
-
### Authorization
|
|
348
|
-
|
|
349
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
350
|
-
|
|
351
|
-
### HTTP request headers
|
|
352
|
-
|
|
353
|
-
- **Content-Type**: Not defined
|
|
354
|
-
- **Accept**: application/json
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
### HTTP response details
|
|
358
|
-
| Status code | Description | Response headers |
|
|
359
|
-
|-------------|-------------|------------------|
|
|
360
|
-
|**200** | List of metric cost entries for the framework | - |
|
|
361
|
-
|**404** | Value framework not found | - |
|
|
362
|
-
|
|
363
|
-
[[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)
|
|
364
|
-
|
|
365
|
-
# **getCostsForValueFrameworkByMetric**
|
|
366
|
-
> Array<MetricCostsPerYearResponse> getCostsForValueFrameworkByMetric()
|
|
367
|
-
|
|
368
|
-
Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
369
|
-
|
|
370
|
-
### Example
|
|
371
|
-
|
|
372
|
-
```typescript
|
|
373
|
-
import {
|
|
374
|
-
ValueFrameworkApi,
|
|
375
|
-
Configuration
|
|
376
|
-
} from '@cosmotech/aip-client';
|
|
377
|
-
|
|
378
|
-
const configuration = new Configuration();
|
|
379
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
380
|
-
|
|
381
|
-
let metricId: string; //UUID of the metric (default to undefined)
|
|
382
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
383
|
-
let offset: number; //Number of records to skip (optional) (default to 0)
|
|
384
|
-
let limit: number; //Max number of records to return (optional) (default to 100)
|
|
385
|
-
|
|
386
|
-
const { status, data } = await apiInstance.getCostsForValueFrameworkByMetric(
|
|
387
|
-
metricId,
|
|
388
|
-
valueFrameworkId,
|
|
389
|
-
offset,
|
|
390
|
-
limit
|
|
391
|
-
);
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
### Parameters
|
|
395
|
-
|
|
396
|
-
|Name | Type | Description | Notes|
|
|
397
|
-
|------------- | ------------- | ------------- | -------------|
|
|
398
|
-
| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
|
|
399
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
400
|
-
| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
|
|
401
|
-
| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
### Return type
|
|
405
|
-
|
|
406
|
-
**Array<MetricCostsPerYearResponse>**
|
|
407
|
-
|
|
408
|
-
### Authorization
|
|
409
|
-
|
|
410
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
411
|
-
|
|
412
|
-
### HTTP request headers
|
|
413
|
-
|
|
414
|
-
- **Content-Type**: Not defined
|
|
415
|
-
- **Accept**: application/json
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
### HTTP response details
|
|
419
|
-
| Status code | Description | Response headers |
|
|
420
|
-
|-------------|-------------|------------------|
|
|
421
|
-
|**200** | List of metric cost entries for the framework and metric | - |
|
|
422
|
-
|**404** | Value framework or metric not found | - |
|
|
423
|
-
|
|
424
|
-
[[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)
|
|
425
|
-
|
|
426
|
-
# **getMetricCostForFramework**
|
|
427
|
-
> MetricCostsPerYearResponse getMetricCostForFramework()
|
|
428
|
-
|
|
429
|
-
Retrieve cost data for a specific metric within this framework for a given year.
|
|
430
|
-
|
|
431
|
-
### Example
|
|
432
|
-
|
|
433
|
-
```typescript
|
|
434
|
-
import {
|
|
435
|
-
ValueFrameworkApi,
|
|
436
|
-
Configuration
|
|
437
|
-
} from '@cosmotech/aip-client';
|
|
438
|
-
|
|
439
|
-
const configuration = new Configuration();
|
|
440
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
441
|
-
|
|
442
|
-
let metricId: string; //UUID of the metric (default to undefined)
|
|
443
|
-
let year: number; //Year (1600-3000) (default to undefined)
|
|
444
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
445
|
-
|
|
446
|
-
const { status, data } = await apiInstance.getMetricCostForFramework(
|
|
447
|
-
metricId,
|
|
448
|
-
year,
|
|
449
|
-
valueFrameworkId
|
|
450
|
-
);
|
|
451
|
-
```
|
|
452
|
-
|
|
453
|
-
### Parameters
|
|
454
|
-
|
|
455
|
-
|Name | Type | Description | Notes|
|
|
456
|
-
|------------- | ------------- | ------------- | -------------|
|
|
457
|
-
| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
|
|
458
|
-
| **year** | [**number**] | Year (1600-3000) | defaults to undefined|
|
|
459
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
### Return type
|
|
463
|
-
|
|
464
|
-
**MetricCostsPerYearResponse**
|
|
465
|
-
|
|
466
|
-
### Authorization
|
|
467
|
-
|
|
468
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
469
|
-
|
|
470
|
-
### HTTP request headers
|
|
471
|
-
|
|
472
|
-
- **Content-Type**: Not defined
|
|
473
|
-
- **Accept**: application/json
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
### HTTP response details
|
|
477
|
-
| Status code | Description | Response headers |
|
|
478
|
-
|-------------|-------------|------------------|
|
|
479
|
-
|**200** | The requested yearly metric cost | - |
|
|
480
|
-
|**404** | Value framework or cost entry not found | - |
|
|
481
|
-
|
|
482
|
-
[[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)
|
|
483
|
-
|
|
484
|
-
# **getMetricCostsForFramework**
|
|
485
|
-
> Array<MetricCostsPerYearResponse> getMetricCostsForFramework()
|
|
486
|
-
|
|
487
|
-
Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
488
|
-
|
|
489
|
-
### Example
|
|
490
|
-
|
|
491
|
-
```typescript
|
|
492
|
-
import {
|
|
493
|
-
ValueFrameworkApi,
|
|
494
|
-
Configuration
|
|
495
|
-
} from '@cosmotech/aip-client';
|
|
496
|
-
|
|
497
|
-
const configuration = new Configuration();
|
|
498
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
499
|
-
|
|
500
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
501
|
-
let offset: number; //Number of records to skip (optional) (default to 0)
|
|
502
|
-
let limit: number; //Max number of records to return (optional) (default to 100)
|
|
503
|
-
|
|
504
|
-
const { status, data } = await apiInstance.getMetricCostsForFramework(
|
|
505
|
-
valueFrameworkId,
|
|
506
|
-
offset,
|
|
507
|
-
limit
|
|
508
|
-
);
|
|
509
|
-
```
|
|
510
|
-
|
|
511
|
-
### Parameters
|
|
512
|
-
|
|
513
|
-
|Name | Type | Description | Notes|
|
|
514
|
-
|------------- | ------------- | ------------- | -------------|
|
|
515
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
516
|
-
| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
|
|
517
|
-
| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
### Return type
|
|
521
|
-
|
|
522
|
-
**Array<MetricCostsPerYearResponse>**
|
|
523
|
-
|
|
524
|
-
### Authorization
|
|
525
|
-
|
|
526
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
527
|
-
|
|
528
|
-
### HTTP request headers
|
|
529
|
-
|
|
530
|
-
- **Content-Type**: Not defined
|
|
531
|
-
- **Accept**: application/json
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
### HTTP response details
|
|
535
|
-
| Status code | Description | Response headers |
|
|
536
|
-
|-------------|-------------|------------------|
|
|
537
|
-
|**200** | List of yearly metric cost entries for the framework | - |
|
|
538
|
-
|**404** | Value framework not found | - |
|
|
539
|
-
|
|
540
|
-
[[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)
|
|
541
|
-
|
|
542
|
-
# **getObjectiveWeightForFramework**
|
|
543
|
-
> ObjectiveWeightResponse getObjectiveWeightForFramework()
|
|
13
|
+
# **deleteValueFramework**
|
|
14
|
+
> deleteValueFramework()
|
|
544
15
|
|
|
545
|
-
|
|
16
|
+
Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
546
17
|
|
|
547
18
|
### Example
|
|
548
19
|
|
|
@@ -555,84 +26,23 @@ import {
|
|
|
555
26
|
const configuration = new Configuration();
|
|
556
27
|
const apiInstance = new ValueFrameworkApi(configuration);
|
|
557
28
|
|
|
558
|
-
let objectiveId: string; //UUID of the objective (default to undefined)
|
|
559
29
|
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
560
30
|
|
|
561
|
-
const { status, data } = await apiInstance.
|
|
562
|
-
objectiveId,
|
|
31
|
+
const { status, data } = await apiInstance.deleteValueFramework(
|
|
563
32
|
valueFrameworkId
|
|
564
33
|
);
|
|
565
34
|
```
|
|
566
35
|
|
|
567
36
|
### Parameters
|
|
568
37
|
|
|
569
|
-
|Name | Type | Description | Notes|
|
|
570
|
-
|------------- | ------------- | ------------- | -------------|
|
|
571
|
-
| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
|
|
572
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
### Return type
|
|
576
|
-
|
|
577
|
-
**ObjectiveWeightResponse**
|
|
578
|
-
|
|
579
|
-
### Authorization
|
|
580
|
-
|
|
581
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
582
|
-
|
|
583
|
-
### HTTP request headers
|
|
584
|
-
|
|
585
|
-
- **Content-Type**: Not defined
|
|
586
|
-
- **Accept**: application/json
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
### HTTP response details
|
|
590
|
-
| Status code | Description | Response headers |
|
|
591
|
-
|-------------|-------------|------------------|
|
|
592
|
-
|**200** | The requested objective weight | - |
|
|
593
|
-
|**404** | Value framework or objective weight not found | - |
|
|
594
|
-
|
|
595
|
-
[[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)
|
|
596
|
-
|
|
597
|
-
# **getObjectiveWeightsForFramework**
|
|
598
|
-
> Array<ObjectiveWeightResponse> getObjectiveWeightsForFramework()
|
|
599
|
-
|
|
600
|
-
Retrieve a paginated list of all objective weights for a specific framework.
|
|
601
|
-
|
|
602
|
-
### Example
|
|
603
|
-
|
|
604
|
-
```typescript
|
|
605
|
-
import {
|
|
606
|
-
ValueFrameworkApi,
|
|
607
|
-
Configuration
|
|
608
|
-
} from '@cosmotech/aip-client';
|
|
609
|
-
|
|
610
|
-
const configuration = new Configuration();
|
|
611
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
612
|
-
|
|
613
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
614
|
-
let offset: number; //Number of records to skip (optional) (default to 0)
|
|
615
|
-
let limit: number; //Max number of records to return (optional) (default to 100)
|
|
616
|
-
|
|
617
|
-
const { status, data } = await apiInstance.getObjectiveWeightsForFramework(
|
|
618
|
-
valueFrameworkId,
|
|
619
|
-
offset,
|
|
620
|
-
limit
|
|
621
|
-
);
|
|
622
|
-
```
|
|
623
|
-
|
|
624
|
-
### Parameters
|
|
625
|
-
|
|
626
38
|
|Name | Type | Description | Notes|
|
|
627
39
|
|------------- | ------------- | ------------- | -------------|
|
|
628
40
|
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
629
|
-
| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
|
|
630
|
-
| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
|
|
631
41
|
|
|
632
42
|
|
|
633
43
|
### Return type
|
|
634
44
|
|
|
635
|
-
|
|
45
|
+
void (empty response body)
|
|
636
46
|
|
|
637
47
|
### Authorization
|
|
638
48
|
|
|
@@ -641,13 +51,13 @@ const { status, data } = await apiInstance.getObjectiveWeightsForFramework(
|
|
|
641
51
|
### HTTP request headers
|
|
642
52
|
|
|
643
53
|
- **Content-Type**: Not defined
|
|
644
|
-
- **Accept**:
|
|
54
|
+
- **Accept**: Not defined
|
|
645
55
|
|
|
646
56
|
|
|
647
57
|
### HTTP response details
|
|
648
58
|
| Status code | Description | Response headers |
|
|
649
59
|
|-------------|-------------|------------------|
|
|
650
|
-
|**
|
|
60
|
+
|**204** | Value framework successfully deleted | - |
|
|
651
61
|
|**404** | Value framework not found | - |
|
|
652
62
|
|
|
653
63
|
[[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)
|
|
@@ -758,187 +168,6 @@ const { status, data } = await apiInstance.getValueFrameworks(
|
|
|
758
168
|
|
|
759
169
|
[[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)
|
|
760
170
|
|
|
761
|
-
# **getWeightsForValueFramework**
|
|
762
|
-
> Array<ObjectiveWeightResponse> getWeightsForValueFramework()
|
|
763
|
-
|
|
764
|
-
Retrieve a paginated list of all objective weights for a specific value framework.
|
|
765
|
-
|
|
766
|
-
### Example
|
|
767
|
-
|
|
768
|
-
```typescript
|
|
769
|
-
import {
|
|
770
|
-
ValueFrameworkApi,
|
|
771
|
-
Configuration
|
|
772
|
-
} from '@cosmotech/aip-client';
|
|
773
|
-
|
|
774
|
-
const configuration = new Configuration();
|
|
775
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
776
|
-
|
|
777
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
778
|
-
let offset: number; //Number of records to skip (optional) (default to 0)
|
|
779
|
-
let limit: number; //Max number of records to return (optional) (default to 100)
|
|
780
|
-
|
|
781
|
-
const { status, data } = await apiInstance.getWeightsForValueFramework(
|
|
782
|
-
valueFrameworkId,
|
|
783
|
-
offset,
|
|
784
|
-
limit
|
|
785
|
-
);
|
|
786
|
-
```
|
|
787
|
-
|
|
788
|
-
### Parameters
|
|
789
|
-
|
|
790
|
-
|Name | Type | Description | Notes|
|
|
791
|
-
|------------- | ------------- | ------------- | -------------|
|
|
792
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
793
|
-
| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
|
|
794
|
-
| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
### Return type
|
|
798
|
-
|
|
799
|
-
**Array<ObjectiveWeightResponse>**
|
|
800
|
-
|
|
801
|
-
### Authorization
|
|
802
|
-
|
|
803
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
804
|
-
|
|
805
|
-
### HTTP request headers
|
|
806
|
-
|
|
807
|
-
- **Content-Type**: Not defined
|
|
808
|
-
- **Accept**: application/json
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
### HTTP response details
|
|
812
|
-
| Status code | Description | Response headers |
|
|
813
|
-
|-------------|-------------|------------------|
|
|
814
|
-
|**200** | List of objective weights for the framework | - |
|
|
815
|
-
|**404** | Value framework not found | - |
|
|
816
|
-
|
|
817
|
-
[[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)
|
|
818
|
-
|
|
819
|
-
# **patchMetricCostForFramework**
|
|
820
|
-
> MetricCostsPerYearResponse patchMetricCostForFramework(metricCostsPerYearUpdate)
|
|
821
|
-
|
|
822
|
-
Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
823
|
-
|
|
824
|
-
### Example
|
|
825
|
-
|
|
826
|
-
```typescript
|
|
827
|
-
import {
|
|
828
|
-
ValueFrameworkApi,
|
|
829
|
-
Configuration,
|
|
830
|
-
MetricCostsPerYearUpdate
|
|
831
|
-
} from '@cosmotech/aip-client';
|
|
832
|
-
|
|
833
|
-
const configuration = new Configuration();
|
|
834
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
835
|
-
|
|
836
|
-
let metricId: string; //UUID of the metric (default to undefined)
|
|
837
|
-
let year: number; //Year (1600-3000) (default to undefined)
|
|
838
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
839
|
-
let metricCostsPerYearUpdate: MetricCostsPerYearUpdate; //
|
|
840
|
-
|
|
841
|
-
const { status, data } = await apiInstance.patchMetricCostForFramework(
|
|
842
|
-
metricId,
|
|
843
|
-
year,
|
|
844
|
-
valueFrameworkId,
|
|
845
|
-
metricCostsPerYearUpdate
|
|
846
|
-
);
|
|
847
|
-
```
|
|
848
|
-
|
|
849
|
-
### Parameters
|
|
850
|
-
|
|
851
|
-
|Name | Type | Description | Notes|
|
|
852
|
-
|------------- | ------------- | ------------- | -------------|
|
|
853
|
-
| **metricCostsPerYearUpdate** | **MetricCostsPerYearUpdate**| | |
|
|
854
|
-
| **metricId** | [**string**] | UUID of the metric | defaults to undefined|
|
|
855
|
-
| **year** | [**number**] | Year (1600-3000) | defaults to undefined|
|
|
856
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
### Return type
|
|
860
|
-
|
|
861
|
-
**MetricCostsPerYearResponse**
|
|
862
|
-
|
|
863
|
-
### Authorization
|
|
864
|
-
|
|
865
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
866
|
-
|
|
867
|
-
### HTTP request headers
|
|
868
|
-
|
|
869
|
-
- **Content-Type**: application/json
|
|
870
|
-
- **Accept**: application/json
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
### HTTP response details
|
|
874
|
-
| Status code | Description | Response headers |
|
|
875
|
-
|-------------|-------------|------------------|
|
|
876
|
-
|**200** | Metric cost updated successfully | - |
|
|
877
|
-
|**400** | Validation or constraint error (e.g. negative cost) | - |
|
|
878
|
-
|**404** | Value framework or metric cost not found | - |
|
|
879
|
-
|
|
880
|
-
[[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)
|
|
881
|
-
|
|
882
|
-
# **patchObjectiveWeightForFramework**
|
|
883
|
-
> ObjectiveWeightResponse patchObjectiveWeightForFramework(objectiveWeightUpdate)
|
|
884
|
-
|
|
885
|
-
Update the weight of an objective within this value framework.
|
|
886
|
-
|
|
887
|
-
### Example
|
|
888
|
-
|
|
889
|
-
```typescript
|
|
890
|
-
import {
|
|
891
|
-
ValueFrameworkApi,
|
|
892
|
-
Configuration,
|
|
893
|
-
ObjectiveWeightUpdate
|
|
894
|
-
} from '@cosmotech/aip-client';
|
|
895
|
-
|
|
896
|
-
const configuration = new Configuration();
|
|
897
|
-
const apiInstance = new ValueFrameworkApi(configuration);
|
|
898
|
-
|
|
899
|
-
let objectiveId: string; //UUID of the objective (default to undefined)
|
|
900
|
-
let valueFrameworkId: string; //UUID of the value framework (default to undefined)
|
|
901
|
-
let objectiveWeightUpdate: ObjectiveWeightUpdate; //
|
|
902
|
-
|
|
903
|
-
const { status, data } = await apiInstance.patchObjectiveWeightForFramework(
|
|
904
|
-
objectiveId,
|
|
905
|
-
valueFrameworkId,
|
|
906
|
-
objectiveWeightUpdate
|
|
907
|
-
);
|
|
908
|
-
```
|
|
909
|
-
|
|
910
|
-
### Parameters
|
|
911
|
-
|
|
912
|
-
|Name | Type | Description | Notes|
|
|
913
|
-
|------------- | ------------- | ------------- | -------------|
|
|
914
|
-
| **objectiveWeightUpdate** | **ObjectiveWeightUpdate**| | |
|
|
915
|
-
| **objectiveId** | [**string**] | UUID of the objective | defaults to undefined|
|
|
916
|
-
| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
### Return type
|
|
920
|
-
|
|
921
|
-
**ObjectiveWeightResponse**
|
|
922
|
-
|
|
923
|
-
### Authorization
|
|
924
|
-
|
|
925
|
-
[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
|
|
926
|
-
|
|
927
|
-
### HTTP request headers
|
|
928
|
-
|
|
929
|
-
- **Content-Type**: application/json
|
|
930
|
-
- **Accept**: application/json
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
### HTTP response details
|
|
934
|
-
| Status code | Description | Response headers |
|
|
935
|
-
|-------------|-------------|------------------|
|
|
936
|
-
|**200** | Objective weight updated successfully | - |
|
|
937
|
-
|**400** | Validation or constraint error (e.g. negative weight) | - |
|
|
938
|
-
|**404** | Value framework or objective weight not found | - |
|
|
939
|
-
|
|
940
|
-
[[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)
|
|
941
|
-
|
|
942
171
|
# **patchValueFramework**
|
|
943
172
|
> ValueFrameworkResponse patchValueFramework(valueFrameworkUpdate)
|
|
944
173
|
|