@cosmotech/aip-client 0.3.0-dev1 → 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 +6 -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 +68 -1193
- 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 +18 -535
- package/dist/api/investment-api.js +79 -1142
- 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 +18 -535
- package/dist/esm/api/investment-api.js +78 -1141
- 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 +20 -0
- package/dist/esm/models/bulk-delete-request.js +14 -0
- 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 +2 -0
- package/dist/esm/models/index.js +2 -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 +20 -0
- package/dist/models/bulk-delete-request.js +15 -0
- 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 +2 -0
- package/dist/models/index.js +2 -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/BulkDeleteRequest.md +21 -0
- package/docs/ImpactApi.md +60 -0
- package/docs/ImpactBulkItem.md +29 -0
- package/docs/InvestmentApi.md +43 -811
- 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 +26 -0
- 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 +2 -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
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Asset Investment Planning
|
|
3
3
|
* API for Asset Investment Planning
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.0-
|
|
5
|
+
* The version of the OpenAPI document: 0.3.0-dev3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,12 +12,6 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import type { MetricCostsPerYearCreate } from '../models';
|
|
16
|
-
import type { MetricCostsPerYearResponse } from '../models';
|
|
17
|
-
import type { MetricCostsPerYearUpdate } from '../models';
|
|
18
|
-
import type { ObjectiveWeightCreate } from '../models';
|
|
19
|
-
import type { ObjectiveWeightResponse } from '../models';
|
|
20
|
-
import type { ObjectiveWeightUpdate } from '../models';
|
|
21
15
|
import type { ValueFrameworkCreate } from '../models';
|
|
22
16
|
import type { ValueFrameworkResponse } from '../models';
|
|
23
17
|
import type { ValueFrameworkUpdate } from '../models';
|
|
@@ -25,43 +19,6 @@ import type { ValueFrameworkUpdate } from '../models';
|
|
|
25
19
|
* ValueFrameworkApi - axios parameter creator
|
|
26
20
|
*/
|
|
27
21
|
export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
-
/**
|
|
29
|
-
* Create a yearly cost override for a metric within this framework.
|
|
30
|
-
* @summary Create a yearly metric cost for this framework
|
|
31
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
32
|
-
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
33
|
-
* @param {*} [options] Override http request option.
|
|
34
|
-
* @throws {RequiredError}
|
|
35
|
-
*/
|
|
36
|
-
createMetricCostForFramework: (valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
-
/**
|
|
38
|
-
* Assign a weight to an objective within this framework.
|
|
39
|
-
* @summary Create an objective weight for this framework
|
|
40
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
41
|
-
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
42
|
-
* @param {*} [options] Override http request option.
|
|
43
|
-
* @throws {RequiredError}
|
|
44
|
-
*/
|
|
45
|
-
createObjectiveWeightForFramework: (valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
-
/**
|
|
47
|
-
* Delete a metric cost entry for a specific year within this framework.
|
|
48
|
-
* @summary Delete metric costs for this framework
|
|
49
|
-
* @param {string} metricId UUID of the metric
|
|
50
|
-
* @param {number} year Year (1600-3000)
|
|
51
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
52
|
-
* @param {*} [options] Override http request option.
|
|
53
|
-
* @throws {RequiredError}
|
|
54
|
-
*/
|
|
55
|
-
deleteMetricCostForFramework: (metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
-
/**
|
|
57
|
-
* Remove an objective weight from this framework.
|
|
58
|
-
* @summary Delete an objective weight for this framework
|
|
59
|
-
* @param {string} objectiveId UUID of the objective
|
|
60
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
61
|
-
* @param {*} [options] Override http request option.
|
|
62
|
-
* @throws {RequiredError}
|
|
63
|
-
*/
|
|
64
|
-
deleteObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
22
|
/**
|
|
66
23
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
67
24
|
* @summary Delete a value framework
|
|
@@ -70,66 +27,6 @@ export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Config
|
|
|
70
27
|
* @throws {RequiredError}
|
|
71
28
|
*/
|
|
72
29
|
deleteValueFramework: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
|
-
/**
|
|
74
|
-
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
75
|
-
* @summary List all metric costs for a value framework
|
|
76
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
77
|
-
* @param {number} [offset] Number of records to skip
|
|
78
|
-
* @param {number} [limit] Max number of records to return
|
|
79
|
-
* @param {*} [options] Override http request option.
|
|
80
|
-
* @throws {RequiredError}
|
|
81
|
-
*/
|
|
82
|
-
getCostsForValueFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83
|
-
/**
|
|
84
|
-
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
85
|
-
* @summary List metric costs for a value framework filtered by metric
|
|
86
|
-
* @param {string} metricId UUID of the metric
|
|
87
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
88
|
-
* @param {number} [offset] Number of records to skip
|
|
89
|
-
* @param {number} [limit] Max number of records to return
|
|
90
|
-
* @param {*} [options] Override http request option.
|
|
91
|
-
* @throws {RequiredError}
|
|
92
|
-
*/
|
|
93
|
-
getCostsForValueFrameworkByMetric: (metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
-
/**
|
|
95
|
-
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
96
|
-
* @summary Get a yearly metric cost for this framework
|
|
97
|
-
* @param {string} metricId UUID of the metric
|
|
98
|
-
* @param {number} year Year (1600-3000)
|
|
99
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
100
|
-
* @param {*} [options] Override http request option.
|
|
101
|
-
* @throws {RequiredError}
|
|
102
|
-
*/
|
|
103
|
-
getMetricCostForFramework: (metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
|
-
/**
|
|
105
|
-
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
106
|
-
* @summary List yearly metric costs for this framework
|
|
107
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
108
|
-
* @param {number} [offset] Number of records to skip
|
|
109
|
-
* @param {number} [limit] Max number of records to return
|
|
110
|
-
* @param {*} [options] Override http request option.
|
|
111
|
-
* @throws {RequiredError}
|
|
112
|
-
*/
|
|
113
|
-
getMetricCostsForFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
|
-
/**
|
|
115
|
-
* Retrieve the weight for a specific objective within this framework.
|
|
116
|
-
* @summary Get an objective weight for this framework
|
|
117
|
-
* @param {string} objectiveId UUID of the objective
|
|
118
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
119
|
-
* @param {*} [options] Override http request option.
|
|
120
|
-
* @throws {RequiredError}
|
|
121
|
-
*/
|
|
122
|
-
getObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
123
|
-
/**
|
|
124
|
-
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
125
|
-
* @summary List objective weights for this framework
|
|
126
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
127
|
-
* @param {number} [offset] Number of records to skip
|
|
128
|
-
* @param {number} [limit] Max number of records to return
|
|
129
|
-
* @param {*} [options] Override http request option.
|
|
130
|
-
* @throws {RequiredError}
|
|
131
|
-
*/
|
|
132
|
-
getObjectiveWeightsForFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
133
30
|
/**
|
|
134
31
|
* Retrieve a single value framework by its ID.
|
|
135
32
|
* @summary Get a value framework by ID
|
|
@@ -147,37 +44,6 @@ export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Config
|
|
|
147
44
|
* @throws {RequiredError}
|
|
148
45
|
*/
|
|
149
46
|
getValueFrameworks: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
150
|
-
/**
|
|
151
|
-
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
152
|
-
* @summary List all objective weights for a value framework
|
|
153
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
154
|
-
* @param {number} [offset] Number of records to skip
|
|
155
|
-
* @param {number} [limit] Max number of records to return
|
|
156
|
-
* @param {*} [options] Override http request option.
|
|
157
|
-
* @throws {RequiredError}
|
|
158
|
-
*/
|
|
159
|
-
getWeightsForValueFramework: (valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
160
|
-
/**
|
|
161
|
-
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
162
|
-
* @summary Partially update metric costs for this framework
|
|
163
|
-
* @param {string} metricId UUID of the metric
|
|
164
|
-
* @param {number} year Year (1600-3000)
|
|
165
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
166
|
-
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
167
|
-
* @param {*} [options] Override http request option.
|
|
168
|
-
* @throws {RequiredError}
|
|
169
|
-
*/
|
|
170
|
-
patchMetricCostForFramework: (metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
171
|
-
/**
|
|
172
|
-
* Update the weight of an objective within this value framework.
|
|
173
|
-
* @summary Partially update an objective weight for this framework
|
|
174
|
-
* @param {string} objectiveId UUID of the objective
|
|
175
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
176
|
-
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
177
|
-
* @param {*} [options] Override http request option.
|
|
178
|
-
* @throws {RequiredError}
|
|
179
|
-
*/
|
|
180
|
-
patchObjectiveWeightForFramework: (objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
181
47
|
/**
|
|
182
48
|
* Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
183
49
|
* @summary Partially update a value framework
|
|
@@ -200,43 +66,6 @@ export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Config
|
|
|
200
66
|
* ValueFrameworkApi - functional programming interface
|
|
201
67
|
*/
|
|
202
68
|
export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
203
|
-
/**
|
|
204
|
-
* Create a yearly cost override for a metric within this framework.
|
|
205
|
-
* @summary Create a yearly metric cost for this framework
|
|
206
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
207
|
-
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
208
|
-
* @param {*} [options] Override http request option.
|
|
209
|
-
* @throws {RequiredError}
|
|
210
|
-
*/
|
|
211
|
-
createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>>;
|
|
212
|
-
/**
|
|
213
|
-
* Assign a weight to an objective within this framework.
|
|
214
|
-
* @summary Create an objective weight for this framework
|
|
215
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
216
|
-
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
217
|
-
* @param {*} [options] Override http request option.
|
|
218
|
-
* @throws {RequiredError}
|
|
219
|
-
*/
|
|
220
|
-
createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
|
|
221
|
-
/**
|
|
222
|
-
* Delete a metric cost entry for a specific year within this framework.
|
|
223
|
-
* @summary Delete metric costs for this framework
|
|
224
|
-
* @param {string} metricId UUID of the metric
|
|
225
|
-
* @param {number} year Year (1600-3000)
|
|
226
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
227
|
-
* @param {*} [options] Override http request option.
|
|
228
|
-
* @throws {RequiredError}
|
|
229
|
-
*/
|
|
230
|
-
deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
231
|
-
/**
|
|
232
|
-
* Remove an objective weight from this framework.
|
|
233
|
-
* @summary Delete an objective weight for this framework
|
|
234
|
-
* @param {string} objectiveId UUID of the objective
|
|
235
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
236
|
-
* @param {*} [options] Override http request option.
|
|
237
|
-
* @throws {RequiredError}
|
|
238
|
-
*/
|
|
239
|
-
deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
240
69
|
/**
|
|
241
70
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
242
71
|
* @summary Delete a value framework
|
|
@@ -245,66 +74,6 @@ export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
|
245
74
|
* @throws {RequiredError}
|
|
246
75
|
*/
|
|
247
76
|
deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
248
|
-
/**
|
|
249
|
-
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
250
|
-
* @summary List all metric costs for a value framework
|
|
251
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
252
|
-
* @param {number} [offset] Number of records to skip
|
|
253
|
-
* @param {number} [limit] Max number of records to return
|
|
254
|
-
* @param {*} [options] Override http request option.
|
|
255
|
-
* @throws {RequiredError}
|
|
256
|
-
*/
|
|
257
|
-
getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
|
|
258
|
-
/**
|
|
259
|
-
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
260
|
-
* @summary List metric costs for a value framework filtered by metric
|
|
261
|
-
* @param {string} metricId UUID of the metric
|
|
262
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
263
|
-
* @param {number} [offset] Number of records to skip
|
|
264
|
-
* @param {number} [limit] Max number of records to return
|
|
265
|
-
* @param {*} [options] Override http request option.
|
|
266
|
-
* @throws {RequiredError}
|
|
267
|
-
*/
|
|
268
|
-
getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
|
|
269
|
-
/**
|
|
270
|
-
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
271
|
-
* @summary Get a yearly metric cost for this framework
|
|
272
|
-
* @param {string} metricId UUID of the metric
|
|
273
|
-
* @param {number} year Year (1600-3000)
|
|
274
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
275
|
-
* @param {*} [options] Override http request option.
|
|
276
|
-
* @throws {RequiredError}
|
|
277
|
-
*/
|
|
278
|
-
getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>>;
|
|
279
|
-
/**
|
|
280
|
-
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
281
|
-
* @summary List yearly metric costs for this framework
|
|
282
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
283
|
-
* @param {number} [offset] Number of records to skip
|
|
284
|
-
* @param {number} [limit] Max number of records to return
|
|
285
|
-
* @param {*} [options] Override http request option.
|
|
286
|
-
* @throws {RequiredError}
|
|
287
|
-
*/
|
|
288
|
-
getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
|
|
289
|
-
/**
|
|
290
|
-
* Retrieve the weight for a specific objective within this framework.
|
|
291
|
-
* @summary Get an objective weight for this framework
|
|
292
|
-
* @param {string} objectiveId UUID of the objective
|
|
293
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
294
|
-
* @param {*} [options] Override http request option.
|
|
295
|
-
* @throws {RequiredError}
|
|
296
|
-
*/
|
|
297
|
-
getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
|
|
298
|
-
/**
|
|
299
|
-
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
300
|
-
* @summary List objective weights for this framework
|
|
301
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
302
|
-
* @param {number} [offset] Number of records to skip
|
|
303
|
-
* @param {number} [limit] Max number of records to return
|
|
304
|
-
* @param {*} [options] Override http request option.
|
|
305
|
-
* @throws {RequiredError}
|
|
306
|
-
*/
|
|
307
|
-
getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
|
|
308
77
|
/**
|
|
309
78
|
* Retrieve a single value framework by its ID.
|
|
310
79
|
* @summary Get a value framework by ID
|
|
@@ -322,37 +91,6 @@ export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
|
322
91
|
* @throws {RequiredError}
|
|
323
92
|
*/
|
|
324
93
|
getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ValueFrameworkResponse>>>;
|
|
325
|
-
/**
|
|
326
|
-
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
327
|
-
* @summary List all objective weights for a value framework
|
|
328
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
329
|
-
* @param {number} [offset] Number of records to skip
|
|
330
|
-
* @param {number} [limit] Max number of records to return
|
|
331
|
-
* @param {*} [options] Override http request option.
|
|
332
|
-
* @throws {RequiredError}
|
|
333
|
-
*/
|
|
334
|
-
getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ObjectiveWeightResponse>>>;
|
|
335
|
-
/**
|
|
336
|
-
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
337
|
-
* @summary Partially update metric costs for this framework
|
|
338
|
-
* @param {string} metricId UUID of the metric
|
|
339
|
-
* @param {number} year Year (1600-3000)
|
|
340
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
341
|
-
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
342
|
-
* @param {*} [options] Override http request option.
|
|
343
|
-
* @throws {RequiredError}
|
|
344
|
-
*/
|
|
345
|
-
patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>>;
|
|
346
|
-
/**
|
|
347
|
-
* Update the weight of an objective within this value framework.
|
|
348
|
-
* @summary Partially update an objective weight for this framework
|
|
349
|
-
* @param {string} objectiveId UUID of the objective
|
|
350
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
351
|
-
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
352
|
-
* @param {*} [options] Override http request option.
|
|
353
|
-
* @throws {RequiredError}
|
|
354
|
-
*/
|
|
355
|
-
patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ObjectiveWeightResponse>>;
|
|
356
94
|
/**
|
|
357
95
|
* Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
358
96
|
* @summary Partially update a value framework
|
|
@@ -375,43 +113,6 @@ export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
|
375
113
|
* ValueFrameworkApi - factory interface
|
|
376
114
|
*/
|
|
377
115
|
export declare const ValueFrameworkApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
378
|
-
/**
|
|
379
|
-
* Create a yearly cost override for a metric within this framework.
|
|
380
|
-
* @summary Create a yearly metric cost for this framework
|
|
381
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
382
|
-
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
383
|
-
* @param {*} [options] Override http request option.
|
|
384
|
-
* @throws {RequiredError}
|
|
385
|
-
*/
|
|
386
|
-
createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse>;
|
|
387
|
-
/**
|
|
388
|
-
* Assign a weight to an objective within this framework.
|
|
389
|
-
* @summary Create an objective weight for this framework
|
|
390
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
391
|
-
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
392
|
-
* @param {*} [options] Override http request option.
|
|
393
|
-
* @throws {RequiredError}
|
|
394
|
-
*/
|
|
395
|
-
createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
|
|
396
|
-
/**
|
|
397
|
-
* Delete a metric cost entry for a specific year within this framework.
|
|
398
|
-
* @summary Delete metric costs for this framework
|
|
399
|
-
* @param {string} metricId UUID of the metric
|
|
400
|
-
* @param {number} year Year (1600-3000)
|
|
401
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
402
|
-
* @param {*} [options] Override http request option.
|
|
403
|
-
* @throws {RequiredError}
|
|
404
|
-
*/
|
|
405
|
-
deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
406
|
-
/**
|
|
407
|
-
* Remove an objective weight from this framework.
|
|
408
|
-
* @summary Delete an objective weight for this framework
|
|
409
|
-
* @param {string} objectiveId UUID of the objective
|
|
410
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
411
|
-
* @param {*} [options] Override http request option.
|
|
412
|
-
* @throws {RequiredError}
|
|
413
|
-
*/
|
|
414
|
-
deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
415
116
|
/**
|
|
416
117
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
417
118
|
* @summary Delete a value framework
|
|
@@ -420,66 +121,6 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
420
121
|
* @throws {RequiredError}
|
|
421
122
|
*/
|
|
422
123
|
deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
423
|
-
/**
|
|
424
|
-
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
425
|
-
* @summary List all metric costs for a value framework
|
|
426
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
427
|
-
* @param {number} [offset] Number of records to skip
|
|
428
|
-
* @param {number} [limit] Max number of records to return
|
|
429
|
-
* @param {*} [options] Override http request option.
|
|
430
|
-
* @throws {RequiredError}
|
|
431
|
-
*/
|
|
432
|
-
getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>>;
|
|
433
|
-
/**
|
|
434
|
-
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
435
|
-
* @summary List metric costs for a value framework filtered by metric
|
|
436
|
-
* @param {string} metricId UUID of the metric
|
|
437
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
438
|
-
* @param {number} [offset] Number of records to skip
|
|
439
|
-
* @param {number} [limit] Max number of records to return
|
|
440
|
-
* @param {*} [options] Override http request option.
|
|
441
|
-
* @throws {RequiredError}
|
|
442
|
-
*/
|
|
443
|
-
getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>>;
|
|
444
|
-
/**
|
|
445
|
-
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
446
|
-
* @summary Get a yearly metric cost for this framework
|
|
447
|
-
* @param {string} metricId UUID of the metric
|
|
448
|
-
* @param {number} year Year (1600-3000)
|
|
449
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
450
|
-
* @param {*} [options] Override http request option.
|
|
451
|
-
* @throws {RequiredError}
|
|
452
|
-
*/
|
|
453
|
-
getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse>;
|
|
454
|
-
/**
|
|
455
|
-
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
456
|
-
* @summary List yearly metric costs for this framework
|
|
457
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
458
|
-
* @param {number} [offset] Number of records to skip
|
|
459
|
-
* @param {number} [limit] Max number of records to return
|
|
460
|
-
* @param {*} [options] Override http request option.
|
|
461
|
-
* @throws {RequiredError}
|
|
462
|
-
*/
|
|
463
|
-
getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>>;
|
|
464
|
-
/**
|
|
465
|
-
* Retrieve the weight for a specific objective within this framework.
|
|
466
|
-
* @summary Get an objective weight for this framework
|
|
467
|
-
* @param {string} objectiveId UUID of the objective
|
|
468
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
469
|
-
* @param {*} [options] Override http request option.
|
|
470
|
-
* @throws {RequiredError}
|
|
471
|
-
*/
|
|
472
|
-
getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
|
|
473
|
-
/**
|
|
474
|
-
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
475
|
-
* @summary List objective weights for this framework
|
|
476
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
477
|
-
* @param {number} [offset] Number of records to skip
|
|
478
|
-
* @param {number} [limit] Max number of records to return
|
|
479
|
-
* @param {*} [options] Override http request option.
|
|
480
|
-
* @throws {RequiredError}
|
|
481
|
-
*/
|
|
482
|
-
getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>>;
|
|
483
124
|
/**
|
|
484
125
|
* Retrieve a single value framework by its ID.
|
|
485
126
|
* @summary Get a value framework by ID
|
|
@@ -497,37 +138,6 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
497
138
|
* @throws {RequiredError}
|
|
498
139
|
*/
|
|
499
140
|
getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ValueFrameworkResponse>>;
|
|
500
|
-
/**
|
|
501
|
-
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
502
|
-
* @summary List all objective weights for a value framework
|
|
503
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
504
|
-
* @param {number} [offset] Number of records to skip
|
|
505
|
-
* @param {number} [limit] Max number of records to return
|
|
506
|
-
* @param {*} [options] Override http request option.
|
|
507
|
-
* @throws {RequiredError}
|
|
508
|
-
*/
|
|
509
|
-
getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ObjectiveWeightResponse>>;
|
|
510
|
-
/**
|
|
511
|
-
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
512
|
-
* @summary Partially update metric costs for this framework
|
|
513
|
-
* @param {string} metricId UUID of the metric
|
|
514
|
-
* @param {number} year Year (1600-3000)
|
|
515
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
516
|
-
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
517
|
-
* @param {*} [options] Override http request option.
|
|
518
|
-
* @throws {RequiredError}
|
|
519
|
-
*/
|
|
520
|
-
patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse>;
|
|
521
|
-
/**
|
|
522
|
-
* Update the weight of an objective within this value framework.
|
|
523
|
-
* @summary Partially update an objective weight for this framework
|
|
524
|
-
* @param {string} objectiveId UUID of the objective
|
|
525
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
526
|
-
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
527
|
-
* @param {*} [options] Override http request option.
|
|
528
|
-
* @throws {RequiredError}
|
|
529
|
-
*/
|
|
530
|
-
patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ObjectiveWeightResponse>;
|
|
531
141
|
/**
|
|
532
142
|
* Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
533
143
|
* @summary Partially update a value framework
|
|
@@ -550,43 +160,6 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
550
160
|
* ValueFrameworkApi - object-oriented interface
|
|
551
161
|
*/
|
|
552
162
|
export declare class ValueFrameworkApi extends BaseAPI {
|
|
553
|
-
/**
|
|
554
|
-
* Create a yearly cost override for a metric within this framework.
|
|
555
|
-
* @summary Create a yearly metric cost for this framework
|
|
556
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
557
|
-
* @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
|
|
558
|
-
* @param {*} [options] Override http request option.
|
|
559
|
-
* @throws {RequiredError}
|
|
560
|
-
*/
|
|
561
|
-
createMetricCostForFramework(valueFrameworkId: string, metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse, any, {}>>;
|
|
562
|
-
/**
|
|
563
|
-
* Assign a weight to an objective within this framework.
|
|
564
|
-
* @summary Create an objective weight for this framework
|
|
565
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
566
|
-
* @param {ObjectiveWeightCreate} objectiveWeightCreate
|
|
567
|
-
* @param {*} [options] Override http request option.
|
|
568
|
-
* @throws {RequiredError}
|
|
569
|
-
*/
|
|
570
|
-
createObjectiveWeightForFramework(valueFrameworkId: string, objectiveWeightCreate: ObjectiveWeightCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
|
|
571
|
-
/**
|
|
572
|
-
* Delete a metric cost entry for a specific year within this framework.
|
|
573
|
-
* @summary Delete metric costs for this framework
|
|
574
|
-
* @param {string} metricId UUID of the metric
|
|
575
|
-
* @param {number} year Year (1600-3000)
|
|
576
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
577
|
-
* @param {*} [options] Override http request option.
|
|
578
|
-
* @throws {RequiredError}
|
|
579
|
-
*/
|
|
580
|
-
deleteMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
581
|
-
/**
|
|
582
|
-
* Remove an objective weight from this framework.
|
|
583
|
-
* @summary Delete an objective weight for this framework
|
|
584
|
-
* @param {string} objectiveId UUID of the objective
|
|
585
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
586
|
-
* @param {*} [options] Override http request option.
|
|
587
|
-
* @throws {RequiredError}
|
|
588
|
-
*/
|
|
589
|
-
deleteObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
590
163
|
/**
|
|
591
164
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
592
165
|
* @summary Delete a value framework
|
|
@@ -595,66 +168,6 @@ export declare class ValueFrameworkApi extends BaseAPI {
|
|
|
595
168
|
* @throws {RequiredError}
|
|
596
169
|
*/
|
|
597
170
|
deleteValueFramework(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
598
|
-
/**
|
|
599
|
-
* Retrieve a paginated list of all metric costs for a specific value framework.
|
|
600
|
-
* @summary List all metric costs for a value framework
|
|
601
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
602
|
-
* @param {number} [offset] Number of records to skip
|
|
603
|
-
* @param {number} [limit] Max number of records to return
|
|
604
|
-
* @param {*} [options] Override http request option.
|
|
605
|
-
* @throws {RequiredError}
|
|
606
|
-
*/
|
|
607
|
-
getCostsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], any, {}>>;
|
|
608
|
-
/**
|
|
609
|
-
* Retrieve a paginated list of metric costs for a specific metric within a value framework.
|
|
610
|
-
* @summary List metric costs for a value framework filtered by metric
|
|
611
|
-
* @param {string} metricId UUID of the metric
|
|
612
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
613
|
-
* @param {number} [offset] Number of records to skip
|
|
614
|
-
* @param {number} [limit] Max number of records to return
|
|
615
|
-
* @param {*} [options] Override http request option.
|
|
616
|
-
* @throws {RequiredError}
|
|
617
|
-
*/
|
|
618
|
-
getCostsForValueFrameworkByMetric(metricId: string, valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], any, {}>>;
|
|
619
|
-
/**
|
|
620
|
-
* Retrieve cost data for a specific metric within this framework for a given year.
|
|
621
|
-
* @summary Get a yearly metric cost for this framework
|
|
622
|
-
* @param {string} metricId UUID of the metric
|
|
623
|
-
* @param {number} year Year (1600-3000)
|
|
624
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
625
|
-
* @param {*} [options] Override http request option.
|
|
626
|
-
* @throws {RequiredError}
|
|
627
|
-
*/
|
|
628
|
-
getMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse, any, {}>>;
|
|
629
|
-
/**
|
|
630
|
-
* Retrieve a paginated list of all yearly metric costs for a specific framework.
|
|
631
|
-
* @summary List yearly metric costs for this framework
|
|
632
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
633
|
-
* @param {number} [offset] Number of records to skip
|
|
634
|
-
* @param {number} [limit] Max number of records to return
|
|
635
|
-
* @param {*} [options] Override http request option.
|
|
636
|
-
* @throws {RequiredError}
|
|
637
|
-
*/
|
|
638
|
-
getMetricCostsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], any, {}>>;
|
|
639
|
-
/**
|
|
640
|
-
* Retrieve the weight for a specific objective within this framework.
|
|
641
|
-
* @summary Get an objective weight for this framework
|
|
642
|
-
* @param {string} objectiveId UUID of the objective
|
|
643
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
644
|
-
* @param {*} [options] Override http request option.
|
|
645
|
-
* @throws {RequiredError}
|
|
646
|
-
*/
|
|
647
|
-
getObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
|
|
648
|
-
/**
|
|
649
|
-
* Retrieve a paginated list of all objective weights for a specific framework.
|
|
650
|
-
* @summary List objective weights for this framework
|
|
651
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
652
|
-
* @param {number} [offset] Number of records to skip
|
|
653
|
-
* @param {number} [limit] Max number of records to return
|
|
654
|
-
* @param {*} [options] Override http request option.
|
|
655
|
-
* @throws {RequiredError}
|
|
656
|
-
*/
|
|
657
|
-
getObjectiveWeightsForFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], any, {}>>;
|
|
658
171
|
/**
|
|
659
172
|
* Retrieve a single value framework by its ID.
|
|
660
173
|
* @summary Get a value framework by ID
|
|
@@ -672,37 +185,6 @@ export declare class ValueFrameworkApi extends BaseAPI {
|
|
|
672
185
|
* @throws {RequiredError}
|
|
673
186
|
*/
|
|
674
187
|
getValueFrameworks(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse[], any, {}>>;
|
|
675
|
-
/**
|
|
676
|
-
* Retrieve a paginated list of all objective weights for a specific value framework.
|
|
677
|
-
* @summary List all objective weights for a value framework
|
|
678
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
679
|
-
* @param {number} [offset] Number of records to skip
|
|
680
|
-
* @param {number} [limit] Max number of records to return
|
|
681
|
-
* @param {*} [options] Override http request option.
|
|
682
|
-
* @throws {RequiredError}
|
|
683
|
-
*/
|
|
684
|
-
getWeightsForValueFramework(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse[], any, {}>>;
|
|
685
|
-
/**
|
|
686
|
-
* Update the perceived and/or direct cost of a metric for a specific year within this framework.
|
|
687
|
-
* @summary Partially update metric costs for this framework
|
|
688
|
-
* @param {string} metricId UUID of the metric
|
|
689
|
-
* @param {number} year Year (1600-3000)
|
|
690
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
691
|
-
* @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
|
|
692
|
-
* @param {*} [options] Override http request option.
|
|
693
|
-
* @throws {RequiredError}
|
|
694
|
-
*/
|
|
695
|
-
patchMetricCostForFramework(metricId: string, year: number, valueFrameworkId: string, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse, any, {}>>;
|
|
696
|
-
/**
|
|
697
|
-
* Update the weight of an objective within this value framework.
|
|
698
|
-
* @summary Partially update an objective weight for this framework
|
|
699
|
-
* @param {string} objectiveId UUID of the objective
|
|
700
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
701
|
-
* @param {ObjectiveWeightUpdate} objectiveWeightUpdate
|
|
702
|
-
* @param {*} [options] Override http request option.
|
|
703
|
-
* @throws {RequiredError}
|
|
704
|
-
*/
|
|
705
|
-
patchObjectiveWeightForFramework(objectiveId: string, valueFrameworkId: string, objectiveWeightUpdate: ObjectiveWeightUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ObjectiveWeightResponse, any, {}>>;
|
|
706
188
|
/**
|
|
707
189
|
* Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
708
190
|
* @summary Partially update a value framework
|