@cosmotech/aip-client 0.2.0-dev2 → 0.2.0-dev4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +147 -4
- package/api/default-api.ts +8 -15
- package/api/favored-option-api.ts +210 -0
- package/api/impact-api.ts +507 -0
- package/api/investment-api.ts +1464 -0
- package/api/metric-api.ts +185 -164
- package/api/metric-costs-api.ts +144 -0
- package/api/metric-costs-per-year-api.ts +200 -200
- package/api/objective-api.ts +538 -44
- package/api/objective-weight-api.ts +190 -190
- package/api/objective-weights-api.ts +144 -0
- package/api/option-api.ts +925 -0
- package/api/value-framework-api.ts +1223 -109
- package/api/value-framework-costs-api.ts +239 -0
- package/api/value-framework-weights-api.ts +144 -0
- package/api.ts +9 -1
- package/base.ts +1 -25
- package/common.ts +20 -43
- package/configuration.ts +31 -20
- package/dist/api/default-api.d.ts +3 -10
- package/dist/api/default-api.js +7 -13
- package/dist/api/favored-option-api.d.ts +104 -0
- package/dist/api/favored-option-api.js +209 -0
- package/dist/api/impact-api.d.ts +245 -0
- package/dist/api/impact-api.js +493 -0
- package/dist/api/investment-api.d.ts +677 -0
- package/dist/api/investment-api.js +1394 -0
- package/dist/api/metric-api.d.ts +97 -88
- package/dist/api/metric-api.js +185 -157
- package/dist/api/metric-costs-api.d.ts +75 -0
- package/dist/api/metric-costs-api.js +146 -0
- package/dist/api/metric-costs-per-year-api.d.ts +105 -108
- package/dist/api/metric-costs-per-year-api.js +199 -192
- package/dist/api/objective-api.d.ts +242 -21
- package/dist/api/objective-api.js +508 -37
- package/dist/api/objective-weight-api.d.ts +105 -108
- package/dist/api/objective-weight-api.js +189 -182
- package/dist/api/objective-weights-api.d.ts +75 -0
- package/dist/api/objective-weights-api.js +146 -0
- package/dist/api/option-api.d.ts +436 -0
- package/dist/api/option-api.js +888 -0
- package/dist/api/value-framework-api.d.ts +528 -21
- package/dist/api/value-framework-api.js +1138 -78
- package/dist/api/value-framework-costs-api.d.ts +119 -0
- package/dist/api/value-framework-costs-api.js +236 -0
- package/dist/api/value-framework-weights-api.d.ts +75 -0
- package/dist/api/value-framework-weights-api.js +146 -0
- package/dist/api.d.ts +9 -1
- package/dist/api.js +9 -1
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +6 -37
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +4 -3
- package/dist/esm/api/default-api.d.ts +3 -10
- package/dist/esm/api/default-api.js +7 -13
- package/dist/esm/api/favored-option-api.d.ts +104 -0
- package/dist/esm/api/favored-option-api.js +202 -0
- package/dist/esm/api/impact-api.d.ts +245 -0
- package/dist/esm/api/impact-api.js +486 -0
- package/dist/esm/api/investment-api.d.ts +677 -0
- package/dist/esm/api/investment-api.js +1387 -0
- package/dist/esm/api/metric-api.d.ts +97 -88
- package/dist/esm/api/metric-api.js +185 -157
- package/dist/esm/api/metric-costs-api.d.ts +75 -0
- package/dist/esm/api/metric-costs-api.js +139 -0
- package/dist/esm/api/metric-costs-per-year-api.d.ts +105 -108
- package/dist/esm/api/metric-costs-per-year-api.js +199 -192
- package/dist/esm/api/objective-api.d.ts +242 -21
- package/dist/esm/api/objective-api.js +508 -37
- package/dist/esm/api/objective-weight-api.d.ts +105 -108
- package/dist/esm/api/objective-weight-api.js +189 -182
- package/dist/esm/api/objective-weights-api.d.ts +75 -0
- package/dist/esm/api/objective-weights-api.js +139 -0
- package/dist/esm/api/option-api.d.ts +436 -0
- package/dist/esm/api/option-api.js +881 -0
- package/dist/esm/api/value-framework-api.d.ts +528 -21
- package/dist/esm/api/value-framework-api.js +1137 -77
- package/dist/esm/api/value-framework-costs-api.d.ts +119 -0
- package/dist/esm/api/value-framework-costs-api.js +229 -0
- package/dist/esm/api/value-framework-weights-api.d.ts +75 -0
- package/dist/esm/api/value-framework-weights-api.js +139 -0
- package/dist/esm/api.d.ts +9 -1
- package/dist/esm/api.js +9 -1
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +6 -37
- package/dist/esm/common.js +15 -38
- package/dist/esm/configuration.d.ts +25 -18
- package/dist/esm/configuration.js +4 -3
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/evolution-type.d.ts +16 -0
- package/dist/esm/models/evolution-type.js +17 -0
- package/dist/esm/models/favored-option-request.d.ts +20 -0
- package/dist/esm/models/{validation-error-loc-inner.js → favored-option-request.js} +1 -1
- package/dist/esm/models/favored-option-response.d.ts +20 -0
- package/dist/esm/models/favored-option-response.js +14 -0
- package/dist/esm/models/httpvalidation-error.d.ts +2 -12
- package/dist/esm/models/httpvalidation-error.js +1 -1
- package/dist/esm/models/impact-apiresponse.d.ts +33 -0
- package/dist/esm/models/impact-apiresponse.js +14 -0
- package/dist/esm/models/impact-create.d.ts +37 -0
- package/dist/esm/models/impact-create.js +14 -0
- package/dist/esm/models/impact-update.d.ts +22 -0
- package/dist/esm/models/impact-update.js +14 -0
- package/dist/esm/models/index.d.ts +13 -1
- package/dist/esm/models/index.js +13 -1
- package/dist/esm/models/investment-create.d.ts +21 -0
- package/dist/esm/models/investment-create.js +14 -0
- package/dist/esm/models/investment-response.d.ts +26 -0
- package/dist/esm/models/investment-response.js +14 -0
- package/dist/esm/models/investment-update.d.ts +18 -0
- package/dist/esm/models/investment-update.js +14 -0
- package/dist/esm/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
- package/dist/esm/models/location-inner.js +14 -0
- package/dist/esm/models/measurement-type.d.ts +1 -6
- package/dist/esm/models/measurement-type.js +1 -6
- package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -17
- package/dist/esm/models/metric-costs-per-year-create.js +1 -1
- package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -18
- package/dist/esm/models/metric-costs-per-year-response.js +1 -1
- package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -13
- package/dist/esm/models/metric-costs-per-year-update.js +1 -1
- package/dist/esm/models/metric-create.d.ts +3 -28
- package/dist/esm/models/metric-create.js +1 -1
- package/dist/esm/models/metric-response.d.ts +3 -50
- package/dist/esm/models/metric-response.js +1 -1
- package/dist/esm/models/metric-type.d.ts +1 -6
- package/dist/esm/models/metric-type.js +1 -6
- package/dist/esm/models/metric-update.d.ts +3 -35
- package/dist/esm/models/metric-update.js +1 -1
- package/dist/esm/models/objective-create.d.ts +1 -10
- package/dist/esm/models/objective-create.js +1 -1
- package/dist/esm/models/objective-response.d.ts +1 -30
- package/dist/esm/models/objective-response.js +1 -1
- package/dist/esm/models/objective-update.d.ts +1 -13
- package/dist/esm/models/objective-update.js +1 -1
- package/dist/esm/models/objective-weight-create.d.ts +1 -9
- package/dist/esm/models/objective-weight-create.js +1 -1
- package/dist/esm/models/objective-weight-response.d.ts +1 -14
- package/dist/esm/models/objective-weight-response.js +1 -1
- package/dist/esm/models/objective-weight-update.d.ts +1 -8
- package/dist/esm/models/objective-weight-update.js +1 -1
- package/dist/esm/models/option-create.d.ts +33 -0
- package/dist/esm/models/option-create.js +14 -0
- package/dist/esm/models/option-response.d.ts +32 -0
- package/dist/esm/models/option-response.js +14 -0
- package/dist/esm/models/option-update.d.ts +21 -0
- package/dist/esm/models/option-update.js +14 -0
- package/dist/esm/models/validation-error.d.ts +3 -33
- package/dist/esm/models/validation-error.js +1 -1
- package/dist/esm/models/value-framework-create.d.ts +1 -10
- package/dist/esm/models/value-framework-create.js +1 -1
- package/dist/esm/models/value-framework-response.d.ts +1 -30
- package/dist/esm/models/value-framework-response.js +1 -1
- package/dist/esm/models/value-framework-update.d.ts +1 -13
- 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/evolution-type.d.ts +16 -0
- package/dist/models/evolution-type.js +20 -0
- package/dist/models/favored-option-request.d.ts +20 -0
- package/dist/models/{validation-error-loc-inner.js → favored-option-request.js} +1 -1
- package/dist/models/favored-option-response.d.ts +20 -0
- package/dist/models/favored-option-response.js +15 -0
- package/dist/models/httpvalidation-error.d.ts +2 -12
- package/dist/models/httpvalidation-error.js +1 -1
- package/dist/models/impact-apiresponse.d.ts +33 -0
- package/dist/models/impact-apiresponse.js +15 -0
- package/dist/models/impact-create.d.ts +37 -0
- package/dist/models/impact-create.js +15 -0
- package/dist/models/impact-update.d.ts +22 -0
- package/dist/models/impact-update.js +15 -0
- package/dist/models/index.d.ts +13 -1
- package/dist/models/index.js +13 -1
- package/dist/models/investment-create.d.ts +21 -0
- package/dist/models/investment-create.js +15 -0
- package/dist/models/investment-response.d.ts +26 -0
- package/dist/models/investment-response.js +15 -0
- package/dist/models/investment-update.d.ts +18 -0
- package/dist/models/investment-update.js +15 -0
- package/dist/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
- package/dist/models/location-inner.js +15 -0
- package/dist/models/measurement-type.d.ts +1 -6
- package/dist/models/measurement-type.js +1 -6
- package/dist/models/metric-costs-per-year-create.d.ts +1 -17
- package/dist/models/metric-costs-per-year-create.js +1 -1
- package/dist/models/metric-costs-per-year-response.d.ts +1 -18
- package/dist/models/metric-costs-per-year-response.js +1 -1
- package/dist/models/metric-costs-per-year-update.d.ts +1 -13
- package/dist/models/metric-costs-per-year-update.js +1 -1
- package/dist/models/metric-create.d.ts +3 -28
- package/dist/models/metric-create.js +1 -1
- package/dist/models/metric-response.d.ts +3 -50
- package/dist/models/metric-response.js +1 -1
- package/dist/models/metric-type.d.ts +1 -6
- package/dist/models/metric-type.js +1 -6
- package/dist/models/metric-update.d.ts +3 -35
- package/dist/models/metric-update.js +1 -1
- package/dist/models/objective-create.d.ts +1 -10
- package/dist/models/objective-create.js +1 -1
- package/dist/models/objective-response.d.ts +1 -30
- package/dist/models/objective-response.js +1 -1
- package/dist/models/objective-update.d.ts +1 -13
- package/dist/models/objective-update.js +1 -1
- package/dist/models/objective-weight-create.d.ts +1 -9
- package/dist/models/objective-weight-create.js +1 -1
- package/dist/models/objective-weight-response.d.ts +1 -14
- package/dist/models/objective-weight-response.js +1 -1
- package/dist/models/objective-weight-update.d.ts +1 -8
- package/dist/models/objective-weight-update.js +1 -1
- package/dist/models/option-create.d.ts +33 -0
- package/dist/models/option-create.js +15 -0
- package/dist/models/option-response.d.ts +32 -0
- package/dist/models/option-response.js +15 -0
- package/dist/models/option-update.d.ts +21 -0
- package/dist/models/option-update.js +15 -0
- package/dist/models/validation-error.d.ts +3 -33
- package/dist/models/validation-error.js +1 -1
- package/dist/models/value-framework-create.d.ts +1 -10
- package/dist/models/value-framework-create.js +1 -1
- package/dist/models/value-framework-response.d.ts +1 -30
- package/dist/models/value-framework-response.js +1 -1
- package/dist/models/value-framework-update.d.ts +1 -13
- package/dist/models/value-framework-update.js +1 -1
- package/docs/DefaultApi.md +51 -0
- package/docs/EvolutionType.md +10 -0
- package/docs/FavoredOptionApi.md +119 -0
- package/docs/FavoredOptionRequest.md +21 -0
- package/docs/FavoredOptionResponse.md +21 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/ImpactAPIResponse.md +39 -0
- package/docs/ImpactApi.md +312 -0
- package/docs/ImpactCreate.md +29 -0
- package/docs/ImpactUpdate.md +29 -0
- package/docs/InvestmentApi.md +987 -0
- package/docs/InvestmentCreate.md +23 -0
- package/docs/InvestmentResponse.md +33 -0
- package/docs/InvestmentUpdate.md +23 -0
- package/docs/LocationInner.md +18 -0
- package/docs/MeasurementType.md +10 -0
- package/docs/MetricApi.md +299 -0
- package/docs/MetricCostsApi.md +66 -0
- package/docs/MetricCostsPerYearApi.md +307 -0
- package/docs/MetricCostsPerYearCreate.md +27 -0
- package/docs/MetricCostsPerYearResponse.md +31 -0
- package/docs/MetricCostsPerYearUpdate.md +23 -0
- package/docs/MetricCreate.md +33 -0
- package/docs/MetricResponse.md +43 -0
- package/docs/MetricType.md +12 -0
- package/docs/MetricUpdate.md +31 -0
- package/docs/ObjectiveApi.md +633 -0
- package/docs/ObjectiveCreate.md +23 -0
- package/docs/ObjectiveResponse.md +31 -0
- package/docs/ObjectiveUpdate.md +23 -0
- package/docs/ObjectiveWeightApi.md +298 -0
- package/docs/ObjectiveWeightCreate.md +25 -0
- package/docs/ObjectiveWeightResponse.md +27 -0
- package/docs/ObjectiveWeightUpdate.md +21 -0
- package/docs/ObjectiveWeightsApi.md +66 -0
- package/docs/OptionApi.md +602 -0
- package/docs/OptionCreate.md +29 -0
- package/docs/OptionResponse.md +39 -0
- package/docs/OptionUpdate.md +29 -0
- package/docs/ValidationError.md +28 -0
- package/docs/ValueFrameworkApi.md +1053 -0
- package/docs/ValueFrameworkCostsApi.md +128 -0
- package/docs/ValueFrameworkCreate.md +23 -0
- package/docs/ValueFrameworkResponse.md +31 -0
- package/docs/ValueFrameworkUpdate.md +23 -0
- package/docs/ValueFrameworkWeightsApi.md +66 -0
- package/index.ts +1 -1
- package/models/evolution-type.ts +26 -0
- package/models/favored-option-request.ts +26 -0
- package/models/favored-option-response.ts +26 -0
- package/models/httpvalidation-error.ts +2 -12
- package/models/impact-apiresponse.ts +43 -0
- package/models/impact-create.ts +47 -0
- package/models/impact-update.ts +32 -0
- package/models/index.ts +13 -1
- package/models/investment-create.ts +27 -0
- package/models/investment-response.ts +32 -0
- package/models/investment-update.ts +24 -0
- package/models/{validation-error-loc-inner.ts → location-inner.ts} +2 -7
- package/models/measurement-type.ts +1 -6
- package/models/metric-costs-per-year-create.ts +1 -17
- package/models/metric-costs-per-year-response.ts +1 -18
- package/models/metric-costs-per-year-update.ts +1 -13
- package/models/metric-create.ts +3 -28
- package/models/metric-response.ts +3 -50
- package/models/metric-type.ts +1 -6
- package/models/metric-update.ts +3 -35
- package/models/objective-create.ts +1 -10
- package/models/objective-response.ts +1 -30
- package/models/objective-update.ts +1 -13
- package/models/objective-weight-create.ts +1 -9
- package/models/objective-weight-response.ts +1 -14
- package/models/objective-weight-update.ts +1 -8
- package/models/option-create.ts +39 -0
- package/models/option-response.ts +38 -0
- package/models/option-update.ts +27 -0
- package/models/validation-error.ts +3 -33
- package/models/value-framework-create.ts +1 -10
- package/models/value-framework-response.ts +1 -30
- package/models/value-framework-update.ts +1 -13
- package/package.json +4 -4
|
@@ -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.2.0-
|
|
5
|
+
* The version of the OpenAPI document: 0.2.0-dev3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -11,15 +11,57 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
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
|
+
import type { ValueFrameworkCreate } from '../models';
|
|
22
|
+
import type { ValueFrameworkResponse } from '../models';
|
|
23
|
+
import type { ValueFrameworkUpdate } from '../models';
|
|
18
24
|
/**
|
|
19
25
|
* ValueFrameworkApi - axios parameter creator
|
|
20
|
-
* @export
|
|
21
26
|
*/
|
|
22
27
|
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>;
|
|
23
65
|
/**
|
|
24
66
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
25
67
|
* @summary Delete a value framework
|
|
@@ -28,6 +70,66 @@ export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Config
|
|
|
28
70
|
* @throws {RequiredError}
|
|
29
71
|
*/
|
|
30
72
|
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>;
|
|
31
133
|
/**
|
|
32
134
|
* Retrieve a single value framework by its ID.
|
|
33
135
|
* @summary Get a value framework by ID
|
|
@@ -45,6 +147,37 @@ export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Config
|
|
|
45
147
|
* @throws {RequiredError}
|
|
46
148
|
*/
|
|
47
149
|
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>;
|
|
48
181
|
/**
|
|
49
182
|
* 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.
|
|
50
183
|
* @summary Partially update a value framework
|
|
@@ -65,9 +198,45 @@ export declare const ValueFrameworkApiAxiosParamCreator: (configuration?: Config
|
|
|
65
198
|
};
|
|
66
199
|
/**
|
|
67
200
|
* ValueFrameworkApi - functional programming interface
|
|
68
|
-
* @export
|
|
69
201
|
*/
|
|
70
202
|
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>>;
|
|
71
240
|
/**
|
|
72
241
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
73
242
|
* @summary Delete a value framework
|
|
@@ -76,6 +245,66 @@ export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
|
76
245
|
* @throws {RequiredError}
|
|
77
246
|
*/
|
|
78
247
|
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>>>;
|
|
79
308
|
/**
|
|
80
309
|
* Retrieve a single value framework by its ID.
|
|
81
310
|
* @summary Get a value framework by ID
|
|
@@ -93,6 +322,37 @@ export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
|
93
322
|
* @throws {RequiredError}
|
|
94
323
|
*/
|
|
95
324
|
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>>;
|
|
96
356
|
/**
|
|
97
357
|
* 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.
|
|
98
358
|
* @summary Partially update a value framework
|
|
@@ -113,9 +373,45 @@ export declare const ValueFrameworkApiFp: (configuration?: Configuration) => {
|
|
|
113
373
|
};
|
|
114
374
|
/**
|
|
115
375
|
* ValueFrameworkApi - factory interface
|
|
116
|
-
* @export
|
|
117
376
|
*/
|
|
118
377
|
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>;
|
|
119
415
|
/**
|
|
120
416
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
121
417
|
* @summary Delete a value framework
|
|
@@ -123,7 +419,67 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
123
419
|
* @param {*} [options] Override http request option.
|
|
124
420
|
* @throws {RequiredError}
|
|
125
421
|
*/
|
|
126
|
-
deleteValueFramework(valueFrameworkId: string, options?:
|
|
422
|
+
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>>;
|
|
127
483
|
/**
|
|
128
484
|
* Retrieve a single value framework by its ID.
|
|
129
485
|
* @summary Get a value framework by ID
|
|
@@ -131,7 +487,7 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
131
487
|
* @param {*} [options] Override http request option.
|
|
132
488
|
* @throws {RequiredError}
|
|
133
489
|
*/
|
|
134
|
-
getValueFrameworkById(valueFrameworkId: string, options?:
|
|
490
|
+
getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse>;
|
|
135
491
|
/**
|
|
136
492
|
* Retrieve a paginated list of all value frameworks.
|
|
137
493
|
* @summary List value frameworks
|
|
@@ -140,7 +496,38 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
140
496
|
* @param {*} [options] Override http request option.
|
|
141
497
|
* @throws {RequiredError}
|
|
142
498
|
*/
|
|
143
|
-
getValueFrameworks(offset?: number, limit?: number, options?:
|
|
499
|
+
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>;
|
|
144
531
|
/**
|
|
145
532
|
* 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.
|
|
146
533
|
* @summary Partially update a value framework
|
|
@@ -149,7 +536,7 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
149
536
|
* @param {*} [options] Override http request option.
|
|
150
537
|
* @throws {RequiredError}
|
|
151
538
|
*/
|
|
152
|
-
patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?:
|
|
539
|
+
patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse>;
|
|
153
540
|
/**
|
|
154
541
|
* Create a new value framework. Name must be unique and non-empty.
|
|
155
542
|
* @summary Create a value framework
|
|
@@ -157,31 +544,123 @@ export declare const ValueFrameworkApiFactory: (configuration?: Configuration, b
|
|
|
157
544
|
* @param {*} [options] Override http request option.
|
|
158
545
|
* @throws {RequiredError}
|
|
159
546
|
*/
|
|
160
|
-
postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?:
|
|
547
|
+
postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): AxiosPromise<ValueFrameworkResponse>;
|
|
161
548
|
};
|
|
162
549
|
/**
|
|
163
550
|
* ValueFrameworkApi - object-oriented interface
|
|
164
|
-
* @export
|
|
165
|
-
* @class ValueFrameworkApi
|
|
166
|
-
* @extends {BaseAPI}
|
|
167
551
|
*/
|
|
168
552
|
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, {}>>;
|
|
169
590
|
/**
|
|
170
591
|
* Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
|
|
171
592
|
* @summary Delete a value framework
|
|
172
593
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
173
594
|
* @param {*} [options] Override http request option.
|
|
174
595
|
* @throws {RequiredError}
|
|
175
|
-
* @memberof ValueFrameworkApi
|
|
176
596
|
*/
|
|
177
597
|
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, {}>>;
|
|
178
658
|
/**
|
|
179
659
|
* Retrieve a single value framework by its ID.
|
|
180
660
|
* @summary Get a value framework by ID
|
|
181
661
|
* @param {string} valueFrameworkId UUID of the value framework
|
|
182
662
|
* @param {*} [options] Override http request option.
|
|
183
663
|
* @throws {RequiredError}
|
|
184
|
-
* @memberof ValueFrameworkApi
|
|
185
664
|
*/
|
|
186
665
|
getValueFrameworkById(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
|
|
187
666
|
/**
|
|
@@ -191,9 +670,39 @@ export declare class ValueFrameworkApi extends BaseAPI {
|
|
|
191
670
|
* @param {number} [limit] Max number of records to return
|
|
192
671
|
* @param {*} [options] Override http request option.
|
|
193
672
|
* @throws {RequiredError}
|
|
194
|
-
* @memberof ValueFrameworkApi
|
|
195
673
|
*/
|
|
196
674
|
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, {}>>;
|
|
197
706
|
/**
|
|
198
707
|
* 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.
|
|
199
708
|
* @summary Partially update a value framework
|
|
@@ -201,7 +710,6 @@ export declare class ValueFrameworkApi extends BaseAPI {
|
|
|
201
710
|
* @param {ValueFrameworkUpdate} valueFrameworkUpdate
|
|
202
711
|
* @param {*} [options] Override http request option.
|
|
203
712
|
* @throws {RequiredError}
|
|
204
|
-
* @memberof ValueFrameworkApi
|
|
205
713
|
*/
|
|
206
714
|
patchValueFramework(valueFrameworkId: string, valueFrameworkUpdate: ValueFrameworkUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
|
|
207
715
|
/**
|
|
@@ -210,7 +718,6 @@ export declare class ValueFrameworkApi extends BaseAPI {
|
|
|
210
718
|
* @param {ValueFrameworkCreate} valueFrameworkCreate
|
|
211
719
|
* @param {*} [options] Override http request option.
|
|
212
720
|
* @throws {RequiredError}
|
|
213
|
-
* @memberof ValueFrameworkApi
|
|
214
721
|
*/
|
|
215
722
|
postValueFramework(valueFrameworkCreate: ValueFrameworkCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValueFrameworkResponse, any, {}>>;
|
|
216
723
|
}
|